Inheritance diagram for Configuration:

[legend]

Collaboration diagram for Configuration:

[legend]

Public Member Functions
_.Library.Status	OnNew (_.Library.String pName, _.Library.Integer pDetectLanguage, _.Library.List pLanguages, _.Library.String pUserDictionary, _.Library.Integer pSummarize, _.Library.Integer pMaxConceptLength, _.Library.Boolean pTransient)
	Creates a Configuration object with the specified parameters. More...

_.Library.String	Normalize (_.Library.String pString, _.Library.String pLanguage, _.Library.Status pSC, _.Library.Boolean pCleanPunctuation)

def	__init__ (self)
	This setting is deprecated. More...

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.iKnow.Configuration	Create (_.Library.String name, _.Library.Integer DetectLanguage, _.Library.List languages, _.Library.String userDictionary, _.Library.Integer summarize, _.Library.Integer maxConceptLength, _.Library.Status sc)
	Create a new Configuration object using the specified parameters. More...

_.Library.Status	Delete (_.Library.String configName)
	Deletes a named configuration. More...

_.Library.Status	DeleteId (_.Library.String configId)
	Deletes a configuration specified by ID. More...

_.Library.Boolean	Exists (_.Library.String name)
	Checks whether a Configuration object exists with the given name. More...

_.Library.String	NormalizeWithParams (_.Library.String pString, _.Library.String pLanguage, _.Library.String pUserDictionary, _.Library.Status pSC, _.Library.Boolean pCleanPunctuation)

_.iKnow.Configuration	Open (_.Library.String name, _.Library.Status pSC)
	Opens the Configuration object with the supplied name. More...

_.iKnow.Configuration	OpenId (_.Library.Integer id)
	Opens the Configuration object with the supplied ID. More...

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Public Attributes
	DetectLanguage
	Whether or not to use Automatic Language Identification. More...

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

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

	Summarize

	UserDictionary
	The name to the User Dictionary to use for rewriting and standardizing input as it is. More...

Additional Inherited Members
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

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.

When creating a configuration, you can pass initial values for the following properties to its <method>New</method> method:

<property>Name</property> (required)
<property>DetectLanguage</property>
<property>Languages</property>
<property>UserDictionary</property>
<property>Summarize</property>

Check the respective property descriptions for more details.

Constructor & Destructor Documentation

◆ init()

def __init__ ( self )

This setting is deprecated.

Summaries are now generated at query time.

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew	(	_.Library.String	pName,
		_.Library.Integer	pDetectLanguage,
		_.Library.List	pLanguages,
		_.Library.String	pUserDictionary,
		_.Library.Integer	pSummarize,
		_.Library.Integer	pMaxConceptLength,
		_.Library.Boolean	pTransient
	)

Creates a Configuration object with the specified parameters.

Note: Use of the pMaxConceptLength parameter is deprecated as from 2013.2

.

◆ Create()

_.iKnow.Configuration Create	(	_.Library.String	name,
		_.Library.Integer	DetectLanguage,
		_.Library.List	languages,
		_.Library.String	userDictionary,
		_.Library.Integer	summarize,
		_.Library.Integer	maxConceptLength,
		_.Library.Status	sc
	)

static

Create a new Configuration object using the specified parameters.

Deprecated: Please use <method>New</method> and <method>Save</method>

◆ Delete()

_.Library.Status Delete ( _.Library.String configName )

static

Deletes a named configuration.

Deprecated: Please use <method>NameIndexOpen</method> and <method>DeleteId</method>

◆ DeleteId()

_.Library.Status DeleteId ( _.Library.String configId )

static

Deletes a configuration specified by ID.

Deprecated: Please use <method>DeleteId</method>

◆ Exists()

_.Library.Boolean Exists ( _.Library.String name )

static

Checks whether a Configuration object exists with the given name.

Deprecated: Please use <method>NameIndexExists</method>

◆ Normalize()

_.Library.String Normalize	(	_.Library.String	pString,
		_.Library.String	pLanguage,
		_.Library.Status	pSC,
		_.Library.Boolean	pCleanPunctuation
	)

Takes an input string pString and returns its normalized form as returned by the

iKnow engine. Using this method will ensure a string has the same form as any results (entities) returned by the engine as a result of iKnow indexing with this Configuration object.

More specifically, this normalization takes into account the following properties:

User Dictionary literal input substitutions.
Language model preprocess filters.
Character normalization (lower casing and some punctuation separation)
Whitespace compression.
Entity filters.

Input substitution adheres to the User Dictionary as specified in the <property>UserDictionary</property> property of this Configuration. If not specified through pLanguage (as a two-letter language code), the language will be randomly selected by the engine from the list specified in this Configuration's <property>Languages</property> property, so it's recommended to supply a value for pLanguage if <property>Languages</property> contains more than one entry. If specified, pLanguage should appear in <property>Languages</property>

See also <method>NormalizeWithParams</method> to normalize without a Configuration object.

◆ NormalizeWithParams()

_.Library.String NormalizeWithParams	(	_.Library.String	pString,
		_.Library.String	pLanguage,
		_.Library.String	pUserDictionary,
		_.Library.Status	pSC,
		_.Library.Boolean	pCleanPunctuation
	)

static

Takes an input string pString and returns its normalized form as returned by the

iKnow engine. Using this method will ensure a string has the same form as any results (entities) returned by the engine as a result of indexing operations.

More specifically, this normalization takes into account the following properties:

User Dictionary literal input substitutions.
Language model preprocess filters.
Character normalization (lower casing and some punctuation separation)
Whitespace compression.
Entity filters.

Input substitution adheres to the User Dictionary as specified through pUserDictionary and the preprocess filters for language pLanguage are used.

See also <method>Normalize</method> to normalize using an existing Configuration object.

◆ Open()

_.iKnow.Configuration Open	(	_.Library.String	name,
		_.Library.Status	pSC
	)

static

Opens the Configuration object with the supplied name.

When requesting the default configuration ($$$DEFAULTCONFIG), it will be created if it didn't exist yet for this namespace.

◆ OpenId()

_.iKnow.Configuration OpenId ( _.Library.Integer id )

static

Opens the Configuration object with the supplied ID.

Deprecated: Please use <method>OpenId</method>

Member Data Documentation

◆ DetectLanguage

DetectLanguage

Whether or not to use Automatic Language Identification.

◆ Languages

Languages

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

◆ Name

Name

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

◆ Summarize

Summarize

Deprecated:

◆ UserDictionary

UserDictionary

The name to the User Dictionary to use for rewriting and standardizing input as it is.

read by the engine. See also <class>iKnow.UserDictionary</class>. Alternatively, the path to a file-based User Dictionary can be supplied.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ OnNew()

◆ Create()

◆ Delete()

◆ DeleteId()

◆ Exists()

◆ Normalize()

◆ NormalizeWithParams()

◆ Open()

◆ OpenId()

Member Data Documentation

◆ DetectLanguage

◆ Languages

◆ Name

◆ Summarize

◆ UserDictionary

◆ init()