Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Indexer]
Private  Storage   

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 75


Summary

Properties
Impl KbImpl LbImpl UdImpl
UserDictionaryName

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified
%OriginalNamespace %PackageName %RemoveFromSaveSet
%SerializeObject %SetModified %ValidateObject
ALI BufferStream BufferString
ClearBuffer ClearUserDictionary DisableDelimitedSentences
DisableMergeRelations DisableSummarizer DisableTracing
EnableDelimitedSentences EnableMergeRelations EnableSummarizer
EnableTracing FlushOutputBuffer GetMaxConceptLength
IndexBuffer InitializeOutput IsDelimitedSentenceModeEnabled
IsMergeRelationsEnabled IsSummarizerEnabled IsTracingEnabled
LoadKnowledgebase LoadLanguagebase LoadUserDictionary
Normalize QuickIndex SetInputObj
SetMaxConceptLength SetOutputFormat SetStemmer
SetSummaryWeightData SetUserDictionary UnloadAllKnowledgebases
UnloadAllLanguagebases UnloadKnowledgebase UnloadLanguagebase
UnloadUserDictionary exALI exBufferStream
exBufferString exClearBuffer exClearUserDictionary
exDisableDelimitedSentences exDisableMergeRelations exDisableSummarizer
exDisableTracing exEnableDelimitedSentences exEnableMergeRelations
exEnableSummarizer exEnableTracing exFlushOutputBuffer
exGetMaxConceptLength exIndexBuffer exInitializeOutput
exIsDelimitedSentenceModeEnabled exIsMergeRelationsEnabled exIsSummarizerEnabled
exIsTracingEnabled exLoadKnowledgebase exLoadLanguagebase
exLoadUserDictionary exNormalize exQuickIndex
exSetInputObj exSetMaxConceptLength exSetOutputFormat
exSetStemmer exSetSummaryWeightData exSetUserDictionary
exUnloadAllKnowledgebases exUnloadAllLanguagebases exUnloadKnowledgebase
exUnloadLanguagebase exUnloadUserDictionary


Properties

• property Impl as %iKnow.NativeSupport.Indexer [ InitialExpression = ##class(%iKnow.NativeSupport.Indexer).%New() ];
• 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 LbImpl as %iKnow.NativeSupport.Languagebase [ InitialExpression = ##class(%iKnow.NativeSupport.Languagebase).%New() ];
• property UdImpl as %iKnow.NativeSupport.UserDictionary [ InitialExpression = ##class(%iKnow.NativeSupport.UserDictionary).%New() ];
• property UserDictionaryName as %String;

Methods

• method ALI(inputText As %String, ByRef result As %String) as %Status
Perform iKnow ALI on inputText returning a string list of "[language],[confidence];..."
• method BufferStream(stream As %Stream.Object) as %Status
• method BufferString(string As %String) as %Status
• method ClearBuffer() as %Status
Empties the input buffer.
• method ClearUserDictionary() as %Status
Clears any existing user dictionary
• method DisableDelimitedSentences() as %Status
Disable delimited sentences mode
• method DisableMergeRelations() as %Status
Disables relation merging.
• method DisableSummarizer() as %Status
Disables summarization.
• method DisableTracing() as %Status
Disables tracing
• method EnableDelimitedSentences() as %Status
Enables delimited sentences mode
• method EnableMergeRelations() as %Status
Enables relation merging.
• method EnableSummarizer() as %Status
Enables summarization.
• method EnableTracing() as %Status
Enables tracing
• method FlushOutputBuffer() as %Status
• method GetMaxConceptLength(ByRef maxLength As %Integer) as %Status
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
Index a buffer, passing output chunks in format to the AddData method of addDataObj
• method InitializeOutput() as %Status
• method IsDelimitedSentenceModeEnabled(ByRef delimitedSentencesEnabled As %Boolean) as %Status
Returns whether delimited sentence mode is enabled
• method IsMergeRelationsEnabled(ByRef mergeRelationsEnabled As %Boolean) as %Status
Returns whether relation merging is enabled in mergeRelationsEnabled.
• method IsSummarizerEnabled(ByRef summarizerEnabled As %Boolean) as %Status
Returns whether summarization is enabled in summarizerEnabled.
• method IsTracingEnabled(ByRef tracingEnabled As %Boolean) as %Status
Checks if tracing is enabled.
• classmethod LoadKnowledgebase(language As %String, knowledgeBase As %iKnow.KB.Knowledgebase) as %Status
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
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
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
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
• method SetInputObj(obj As %RegisteredObject) as %Status
• method SetMaxConceptLength(maxLength As %Integer) as %Status
Sets the document fraction for the "DocumentFraction" mode summarizer.
• method SetOutputFormat(format As %Integer)
• method SetStemmer(stemmer As %iKnow.Stemmer) as %Status
Sets the current stemmer.
• method SetSummaryWeightData(data As %String) as %Status
Sets the summary weight data
• method SetUserDictionary(name As %String) as %Status
Sets the name of the current user dictionary.
• classmethod UnloadAllKnowledgebases() as %Status
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
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
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
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
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)
• method exBufferStream(stream As %Stream.Object)
• method exBufferString(string As %String)
• method exClearBuffer()
• method exClearUserDictionary()
• method exDisableDelimitedSentences()
• method exDisableMergeRelations()
• method exDisableSummarizer() as %Status
• method exDisableTracing()
• method exEnableDelimitedSentences()
• method exEnableMergeRelations()
• method exEnableSummarizer()
• method exEnableTracing()
• method exFlushOutputBuffer()
• method exGetMaxConceptLength(ByRef maxLength As %Integer)
• method exIndexBuffer(addDataObj As %RegisteredObject, language As %String = "", format As %Integer = 2)
Same as above but throws exceptions rather than returning a status
• method exInitializeOutput()
• method exIsDelimitedSentenceModeEnabled(ByRef delimitedSentencesEnabled As %Boolean)
• method exIsMergeRelationsEnabled(ByRef mergeRelationsEnabled As %Boolean)
• method exIsSummarizerEnabled(ByRef summarizerEnabled As %Boolean)
• method exIsTracingEnabled(ByRef tracingEnabled As %Boolean)
• classmethod exLoadKnowledgebase(language As %String, knowledgeBase As %iKnow.KB.Knowledgebase)
• classmethod exLoadLanguagebase(language As %String, languageBase As %iKnow.LB.Languagebase)
• classmethod exLoadUserDictionary(name As %String, userDictionary As %iKnow.UserDictionary)
• method exNormalize(inputText As %String, ByRef outputText As %String, language As %String = "", toLower As %Integer = 1, cleanPunctuation As %Integer = 1)
• method exQuickIndex(input As %String, flush As %Boolean = 0, language As %String = "", outputFormat As %Integer = $$$IKFORMATDOEXTRAENTITY)
Clear, buffer string and index, for low overhead index of short strings
• method exSetInputObj(obj As %RegisteredObject)
Set the add data object for "quick" indexing
• method exSetMaxConceptLength(maxLength As %Integer)
• method exSetOutputFormat(format As %Integer)
Sets the output format
• method exSetStemmer(stemmer As %iKnow.Stemmer)
• method exSetSummaryWeightData(data As %String)
• method exSetUserDictionary(name As %String)
• classmethod exUnloadAllKnowledgebases()
• classmethod exUnloadAllLanguagebases()
• classmethod exUnloadKnowledgebase(language As %String)
• classmethod exUnloadLanguagebase(language As %String)
• classmethod exUnloadUserDictionary(name As %String)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.