Class %iKnow.Configuration

class %iKnow.Configuration extends %RegisteredObject

This class groups the configuration parameters to drive the iKnow Smart Indexing algorithm as executed by the iKnow engine (external libraries). Configurations are referred to by name and can be used across domains within the same namespace.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	7	12	1

Summary

Properties
DetectLanguage	Languages	MaxConceptLength	Name
Summarize	UserDictionary

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	Create	Delete	DeleteId
Exists	GetAllConfigurationsClose	GetAllConfigurationsExecute	GetAllConfigurationsFetch
Open	OpenId

Properties

• property DetectLanguage as %Boolean [ ReadOnly ];

Whether or not to use Automatic Language Identification

• property Languages as %List [ ReadOnly ];

The list of languages the engine should take into account when processing the text.

• property MaxConceptLength as %Integer [ ReadOnly ];

Max cluster length

• property Name as %String [ ReadOnly ];

The name of this configuration, which should be unique within the namespace (case-insensitive)

• property Summarize as %Integer [ ReadOnly ];

Whether or not to generate summary information to be able to generate summaries afterwards.

• property UserDictionary as %String [ ReadOnly ];

The path to the User Dictionary to use for rewriting and standardizing input as it is read by the engine.

Methods

• classmethod Create(name As %String, DetectLanguage As %Integer = 0, languages As %List = $lb("en"), userDictionary As %String = "", summarize As %Integer = 1, maxConceptLength As %Integer = 0, Output sc As %Status = $$$OK) as %iKnow.Configuration

Create a new Configuration object using the specified parameters

• classmethod Delete(configName As %String) as %Status

Deletes a named configuration

• classmethod DeleteId(configId As %String) as %Status

Deletes a configuration specified by ID

• classmethod Exists(name As %String) as %Boolean

Checks whether a Configuration object exists with the given name

• classmethod Open(name As %String) as %iKnow.Configuration

Opens the Configuration object with the supplied name

• classmethod OpenId(id As %Integer) as %iKnow.Configuration

Opens the Configuration object with the supplied ID

Queries

• query GetAllConfigurations()

Selects configId As %Integer, configName As %String, detectLanguage As %Integer, languages As %String, userDictionary As %String, summarize As %Integer, maxConceptLength As %Integer

Simple class query to retrieve all the configurations for this Namespace.


[BASEXML] > [%iKnow] > [Configuration]		Private Storage