Skip to main content

%iKnow.Native.NativeIndexer

Method Inventory

Parameters

parameter %MODULENAME = iknownativeindexer;

Methods

method ALI(text As %String) as %String [ Language = cpp ]
Returns an ALI result of the form "[language],[confidence];..." for the given string against the loaded language models
method BeginIndexing(language As %Binary, userDictionary As %Binary) [ Language = cpp ]
Start indexing, calling OutputBlock() for each chunk of output data. language specifies the language to use, if empty string, use ALI if more than one language is loaded. This is the only method intended to be implemented in C++. The rest should be implemented in COS to provide the state of the indexer.
method FlushOutputBuffer() [ Language = cpp ]
Flush buffered output
method GetInputBlock(key As %Integer) as %String [ Language = cpp ]
Retrieve an input block, given a key (COS)
method GetMaxConceptLength() as %Integer [ Language = cpp ]
Returns the maximum number of concepts that will be joined into a single concept (COS)
method GetOutputFormat() as %Integer [ Language = cpp ]
Returns the code for the current selected output format (COS)
method GetSummarizerDocumentFraction() as %Binary [ Language = cpp ]
Returns the document fraction parameter of the Document Fraction summarizer mode (as a string, no double support in C++ superclassses yet) (COS)
method GetSummarizerMode() as %Integer [ Language = cpp ]
Returns the summarizer mode as an integer: 0 for Sentence Count, 1 for Document Fraction. (COS)
method GetSummarizerSentenceCount() as %Integer [ Language = cpp ]
Returns the sentence count parameter of the Sentence Count summarizer mode (COS)
method GetSummaryWeight() as %String [ Language = cpp ]
method HasStemmer() as %Integer [ Language = cpp ]
method HasSumWeightChanged() as %Integer [ Language = cpp ]
method InitializeOutput() [ Language = cpp ]
Use this indexer for output
method IsBinaryModeEnabled() as %Integer [ Language = cpp ]
Returns non-0 if binary mode is enabled. Binary mode allows for longer "sentences" and potentially other modifications to the engine's behavior for processing non-textual data. (COS)
method IsDelimitedSentenceModeEnabled() as %Integer [ Language = cpp ]
Returns non-0 if delimited sentence mode is enabled. Delimited sentence mode disables all sentence splitting except for double line breaks, and is used for indexing (or re-indexing) documents where the sentence structure can be determined outside the engine (COS)
method IsExtraInfoEnabled() as %Integer [ Language = cpp ]
Returns non-0 if extended info mode is enabled. This turns on entity dominance, among other output. (COS)
method IsMergeRelationsEnabled() as %Integer [ Language = cpp ]
Returns non-0 if merging of relations is enabled (COS)
method IsSummarizerEnabled() as %Integer [ Language = cpp ]
Returns non-0 if the summarizer is enabled (COS)
method IsTracingEnabled() as %Integer [ Language = cpp ]
Returns non-0 if tracing is enabled (COS)
method IsTranslationRequired() as %Integer [ Language = cpp ]
Returns non-0 if translation to/from a non-Latin1 8-bit character set is required (This affects how the output block $LIST passed to OutputBlock() is constructed: with binary values that will not be translated vs. string values that will) (COS)
method NextInputBlock(key As %Integer) as %Integer [ Language = cpp ]
Retrieve the next input block key, given the current input block key (COS)
method NormalizeText(text As %String, language As %Binary, userDictionary As %Binary, bLowerCase As %Integer, bStripPunct As %Integer) as %String [ Language = cpp ]
Normalizes a segment of text using the current indexer settings and the given language and user dictionary (C++)
method OutputBlock(block As %CPP.StrList) [ Language = cpp ]
Callback for processing output blocks. (COS)
method QuickIndex(input As %String, flush As %Integer, language As %Binary, outputFormat As %Integer, userDictionary As %Binary) [ Language = cpp ]
Index a single string
method SetErrorCondition(errorId As %Binary, arg1 As %Binary = "", arg2 As %Binary = "", arg3 As %Binary = "", arg4 As %Binary = "") [ Language = cpp ]
A utility method for producing COS errors from inside C++
method Stem(token As %String, language As %String, lexType As %Integer) as %String [ Language = cpp ]

Inherited Members

Inherited Methods

FeedbackOpens in a new tab