Home > Class Reference > %SYS namespace > %iKnow.Indexer

%iKnow.Indexer

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Impl as %iKnow.NativeSupport.Indexer [ InitialExpression = ##class(%iKnow.NativeSupport.Indexer).%New() ];
Property methods: ImplGet(), ImplGetSwizzled(), ImplIsValid(), ImplNewObject(), ImplSet()
property KbImpl as %iKnow.NativeSupport.Knowledgebase [ InitialExpression = ##class(%iKnow.NativeSupport.Knowledgebase).%New() ];
This is a hack: we need these around so that the loaded library will always have a live reference. Otherwise in between the creation of a NativeSupport.Knowledgebase for language loading and the use of a NativeSupport.Indexer for indexing, the library could be unloaded.
Property methods: KbImplGet(), KbImplGetSwizzled(), KbImplIsValid(), KbImplNewObject(), KbImplSet()
property LbImpl as %iKnow.NativeSupport.Languagebase [ InitialExpression = ##class(%iKnow.NativeSupport.Languagebase).%New() ];
Property methods: LbImplGet(), LbImplGetSwizzled(), LbImplIsValid(), LbImplNewObject(), LbImplSet()
property UdImpl as %iKnow.NativeSupport.UserDictionary [ InitialExpression = ##class(%iKnow.NativeSupport.UserDictionary).%New() ];
Property methods: UdImplGet(), UdImplGetSwizzled(), UdImplIsValid(), UdImplNewObject(), UdImplSet()
property UserDictionaryName as %String;
Property methods: UserDictionaryNameDisplayToLogical(), UserDictionaryNameGet(), UserDictionaryNameIsValid(), UserDictionaryNameLogicalToDisplay(), UserDictionaryNameLogicalToOdbc(), UserDictionaryNameNormalize(), UserDictionaryNameSet()

Methods (Including Private)

method ALI(inputText As %String, ByRef result As %String) as %Status [ Language = objectscript ]
Perform iKnow ALI on inputText returning a string list of "[language],[confidence];..."
method BufferStream(stream As %Stream.Object) as %Status [ Language = objectscript ]
method BufferString(string As %String) as %Status [ Language = objectscript ]
method ClearBuffer() as %Status [ Language = objectscript ]
Empties the input buffer.
method ClearUserDictionary() as %Status [ Language = objectscript ]
Clears any existing user dictionary
method DisableDelimitedSentences() as %Status [ Language = objectscript ]
Disable delimited sentences mode
method DisableMergeRelations() as %Status [ Language = objectscript ]
Disables relation merging.
method DisableSummarizer() as %Status [ Language = objectscript ]
Disables summarization.
method DisableTracing() as %Status [ Language = objectscript ]
Disables tracing
method EnableDelimitedSentences() as %Status [ Language = objectscript ]
Enables delimited sentences mode
method EnableMergeRelations() as %Status [ Language = objectscript ]
Enables relation merging.
method EnableSummarizer() as %Status [ Language = objectscript ]
Enables summarization.
method EnableTracing() as %Status [ Language = objectscript ]
Enables tracing
method FlushOutputBuffer() as %Status [ Language = objectscript ]
method GetMaxConceptLength(ByRef maxLength As %Integer) as %Status [ Language = objectscript ]
Returns the document fraction for the DocumentFraction mode summarizer in documentFraction.
method IndexBuffer(addDataObj As %RegisteredObject, language As %String = "", format As %Integer = 2) as %Status [ Language = objectscript ]
Index a buffer, passing output chunks in format to the AddData method of addDataObj
method InitializeOutput() as %Status [ Language = objectscript ]
method IsDelimitedSentenceModeEnabled(ByRef delimitedSentencesEnabled As %Boolean) as %Status [ Language = objectscript ]
Returns whether delimited sentence mode is enabled
private classmethod IsDevBuild() as %Boolean [ Language = objectscript ]
method IsMergeRelationsEnabled(ByRef mergeRelationsEnabled As %Boolean) as %Status [ Language = objectscript ]
Returns whether relation merging is enabled in mergeRelationsEnabled.
method IsSummarizerEnabled(ByRef summarizerEnabled As %Boolean) as %Status [ Language = objectscript ]
Returns whether summarization is enabled in summarizerEnabled.
method IsTracingEnabled(ByRef tracingEnabled As %Boolean) as %Status [ Language = objectscript ]
Checks if tracing is enabled.
classmethod LoadKnowledgebase(language As %String, knowledgeBase As %iKnow.KB.Knowledgebase) as %Status [ Language = objectscript ]
Loads a knowledgebase object into the engine, and associates it with the given language name. Note that knowledgebases and languagebases are loaded in the global engine context, so this method will affect all indexers in this process.
classmethod LoadLanguagebase(language As %String, languageBase As %iKnow.LB.Languagebase) as %Status [ Language = objectscript ]
Loads a languagebase object into the engine, and associates it with the given language name. Note that knowledgebases and languagebases are loaded in the global engine context, so this method will affect all indexers in this process.
classmethod LoadUserDictionary(name As %String, userDictionary As %iKnow.UserDictionary) as %Status [ Language = objectscript ]
Loads a user dictionary object into the engine, and associates it with the given name. Note that user dictionaries are loaded in the global engine context, so this method will affect all indexers in this process.
method Normalize(inputText As %String, ByRef outputText As %String, language As %String = "", toLower As %Integer = 1, cleanPunctuation As %Integer = 1) as %Status [ Language = objectscript ]
Perform iKnow normalization on inputText using the given language and userDictionary
method QuickIndex(input As %String, flush As %Boolean = 0, language As %String = "", outputFormat As %String) as %Status [ Language = objectscript ]
method SetInputObj(obj As %RegisteredObject) as %Status [ Language = objectscript ]
method SetMaxConceptLength(maxLength As %Integer) as %Status [ Language = objectscript ]
Sets the document fraction for the "DocumentFraction" mode summarizer.
method SetOutputFormat(format As %Integer) [ Language = objectscript ]
method SetStemmer(stemmer As %iKnow.Stemmer) as %Status [ Language = objectscript ]
Sets the current stemmer.
method SetSummaryWeightData(data As %String) as %Status [ Language = objectscript ]
Sets the summary weight data
method SetUserDictionary(name As %String) as %Status [ Language = objectscript ]
Sets the name of the current user dictionary.
classmethod UnloadAllKnowledgebases() as %Status [ Language = objectscript ]
Unloads all knowledgebases. Note that knowledgebases and languagebases are loaded in the global engine context, so this method will affect all indexers in this process.
classmethod UnloadAllLanguagebases() as %Status [ Language = objectscript ]
Unloads all languagebases Note that knowledgebases and languagebases are loaded in the global engine context, so this method will affect all indexers in this process.
classmethod UnloadKnowledgebase(language As %String) as %Status [ Language = objectscript ]
Unloads the knowledgebase associated with the given language name from the engine. Note that knowledgebases and languagebases are loaded in the global engine context, so this method will affect all indexers in this process.
classmethod UnloadLanguagebase(language As %String) as %Status [ Language = objectscript ]
Unloads the languagebase associated with the given language name from the engine. Note that knowledgebases and languagebases are loaded in the global engine context, so this method will affect all indexers in this process.
classmethod UnloadUserDictionary(name As %String) as %Status [ Language = objectscript ]
Unloads the user dictionary associated with the given name from the engine. Note that user dictionaries are loaded in the global engine context, so this method will affect all indexers in this process.
method exALI(inputText As %String, ByRef result As %String) [ Language = objectscript ]
method exBufferStream(stream As %Stream.Object) [ Language = objectscript ]
method exBufferString(string As %String) [ Language = objectscript ]
method exClearBuffer() [ Language = objectscript ]
method exClearUserDictionary() [ Language = objectscript ]
method exDisableDelimitedSentences() [ Language = objectscript ]
method exDisableMergeRelations() [ Language = objectscript ]
method exDisableSummarizer() as %Status [ Language = objectscript ]
method exDisableTracing() [ Language = objectscript ]
method exEnableDelimitedSentences() [ Language = objectscript ]
method exEnableMergeRelations() [ Language = objectscript ]
method exEnableSummarizer() [ Language = objectscript ]
method exEnableTracing() [ Language = objectscript ]
method exFlushOutputBuffer() [ Language = objectscript ]
method exGetMaxConceptLength(ByRef maxLength As %Integer) [ Language = objectscript ]
method exIndexBuffer(addDataObj As %RegisteredObject, language As %String = "", format As %Integer = 2) [ Language = objectscript ]
Same as above but throws exceptions rather than returning a status
method exInitializeOutput() [ Language = objectscript ]
method exIsDelimitedSentenceModeEnabled(ByRef delimitedSentencesEnabled As %Boolean) [ Language = objectscript ]
method exIsMergeRelationsEnabled(ByRef mergeRelationsEnabled As %Boolean) [ Language = objectscript ]
method exIsSummarizerEnabled(ByRef summarizerEnabled As %Boolean) [ Language = objectscript ]
method exIsTracingEnabled(ByRef tracingEnabled As %Boolean) [ Language = objectscript ]
classmethod exLoadKnowledgebase(language As %String, knowledgeBase As %iKnow.KB.Knowledgebase) [ Language = objectscript ]
classmethod exLoadLanguagebase(language As %String, languageBase As %iKnow.LB.Languagebase) [ Language = objectscript ]
classmethod exLoadUserDictionary(name As %String, userDictionary As %iKnow.UserDictionary) [ Language = objectscript ]
method exNormalize(inputText As %String, ByRef outputText As %String, language As %String = "", toLower As %Integer = 1, cleanPunctuation As %Integer = 1) [ Language = objectscript ]
method exQuickIndex(input As %String, flush As %Boolean = 0, language As %String = "", outputFormat As %Integer = $$$IKFORMATDOEXTRAENTITY) [ Language = objectscript ]
Clear, buffer string and index, for low overhead index of short strings
method exSetInputObj(obj As %RegisteredObject) [ Language = objectscript ]
Set the add data object for "quick" indexing
method exSetMaxConceptLength(maxLength As %Integer) [ Language = objectscript ]
method exSetOutputFormat(format As %Integer) [ Language = objectscript ]
Sets the output format
method exSetStemmer(stemmer As %iKnow.Stemmer) [ Language = objectscript ]
method exSetSummaryWeightData(data As %String) [ Language = objectscript ]
method exSetUserDictionary(name As %String) [ Language = objectscript ]
classmethod exUnloadAllKnowledgebases() [ Language = objectscript ]
classmethod exUnloadAllLanguagebases() [ Language = objectscript ]
classmethod exUnloadKnowledgebase(language As %String) [ Language = objectscript ]
classmethod exUnloadLanguagebase(language As %String) [ Language = objectscript ]
classmethod exUnloadUserDictionary(name As %String) [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window