Skip to main content


deprecated persistent class %iKnow.UserDictionary extends %Library.Persistent

SQL Table Name: %iKnow.UserDictionary

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentationOpens in a new tab for more detail.

This class represents User Dictionaries, used to rewrite fragments of input data specific to a particular use case.

When creating a User Dictionary, you can pass initial values for the following properties to its %New() method:

  1. Name (required)
  2. Description
Check the respective property descriptions for more details.

Property Inventory

Method Inventory


property Description as %String [ Final ];
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Id as %Integer [ Final , Required , ReadOnly ];
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize()
property Name as %String [ Final , ReadOnly ];
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize()


method %ConstructClone(deep As %Boolean = 0, ByRef cloned As %String, location As %String) as %RegisteredObject
Inherited description: Clone the current object to a new object. If deep is 1 then this does a deep copy which will also copy any subobjects and if deep is 0 then it will create another reference to any subobjects and increment the reference count appropriately. It returns the new cloned object.

Note that even if deep=0 when you clone a parent object in a parent child relationship or a one object of a one to many relationship then it will construct clones of all the child/many objects. This is because a child/many object can only point at a single parent and so if we did not create a clone of these then you would have a relationship with zero items in it. If you really just want to clone the object without these child/many objects then pass deep=-1 to this method.

After the clone is constructed it will call %OnConstructClone(object,deep,.cloned) on the clone if it is defined so that you can perform any additional steps e.g. taking out a lock. This works just the same way as %OnNew() does.

The object is the oref of the original object that was cloned. The cloned array is just used internally when doing a deep clone to prevent recursive loops, do not pass anything in at all for this parameter on the initial call. If you write a %OnConstructClone and from here you wish to call %ConstructClone on another object pass in the cloned array, e.g. 'Do oref.%ConstructClone(1,.cloned)' so that it can prevent recursive loops.

The location is used internally to pass the new location for stream objects.

classmethod %DeleteExtent(concurrency As %Library.Integer = -1, ByRef deletecount As %Library.String, ByRef instancecount As %Library.String, pInitializeExtent As %Library.Integer = 1, Output errorLog As %Library.Status) as %Status
Inherited description: Delete all instances of this class from its extent. On exit instancecount contains the original number of instances while deletecount contains the number of instances actually deleted.

Internally, %DeleteExtent() iterates over the set of instances in the collection and invokes the %Delete() method.
Refer to Object Concurrency Options for more details on the optional concurrency argument.
The option pInitializeExtent argument allows the user to override the default behavior of calling %KillExtent() when all instances are successfully deleted. %KillExtent() is called by default when the extent is empty so that empty globals can be killed. If %KillExtent() is not called then some empty globals can remain as well as the ID counter if it exists. The default value for pInitializeExtent is 1. Unless the caller specifies a false value for pInitializeExtent the globals used by the extent will be killed. If the process' GlobalKillDisabled flag is enabled and not the default of false the process' GlobalKillDisabled flag will be changed temporarily to false to allow the operation to complete without a possible error. In some cases, the globals used by the extent are not used exclusively by the extent. In those cases it is possible that some globals will still be defined even when pInitializeExtent is true. By default this call to %KillExtent() will not delete default stream storage global, but if you pass '2' in pInitializeExtent and if the entire extent was deleted we will call %KillExtent passing the 'killstreams' flag to ask it to remove kill the default storage global.

Returns a %Status value indicating success or failure.

method AddCertaintyTerm(pWord As %String, pLevel As %Integer = 9, Output pPosition) as %Status
Use pLevel to specify the level of certainty for this term (1-9). A value of 1 implies a very uncertain statement, a value of 9 a very certain one.
method AddConcept(pWord As %String, Output pPosition) as %Status
method AddEntry(pRewriteFrom As %String, pRewriteTo As %String, ByRef pPosition As %Integer = 0) as %Status

Adds a single entry to this User Dictionary at position. If position <= 0 (default=0), it is added at the bottom of the list, otherwise at the requested position, shifting existing entries down if it was already taken.

These changes are saved automatically. There is no need to call %Save()

method AddNegationTerm(pWord As %String, Output pPosition As %Integer) as %Status
method AddNegativeSentimentTerm(pWord As %String, Output pPosition As %Integer) as %Status
method AddNonRelevant(pWord As %String, Output pPosition) as %Status
method AddNumber(pWord As %String, Output pPosition As %Integer) as %Status
method AddPositiveSentimentTerm(pWord As %String, Output pPosition As %Integer) as %Status
method AddRelation(pWord As %String, Output pPosition) as %Status
method AddSentenceEnd(pToken As %String, Output pPosition) as %Status
method AddSentenceNoEnd(pToken As %String, Output pPosition) as %Status
method AddTime(pWord As %String, Output pPosition As %Integer) as %Status
method AddUnit(pWord As %String, Output pPosition As %Integer) as %Status
method ClearEntries() as %Status
Removes all entries from this user dictionary (only relevant for non-transient ones)
method GetEntries(ByRef pResult) as %Status

Returns the contents of this User Dictionary in the form pResult(position) = $lb(rewriteFrom, rewriteTo [, metadata]).

classmethod OpenByName(pName As %String) as %iKnow.UserDictionary

Returns a User Dictionary object by name. First, this method checks if pName is a name used by any saved User Dictionary object. If none found, it is used as a file path for the legacy file-based User Dictionaries. If there is no file at this path, "" is returned.

Note: file-based User Dictionaries are deprecated. Please use object-based ones by using %New(), %Save() and AddEntry().

method RemoveEntry(pPosition As %Integer) as %Status

Removes the User Dictionary entry registered at position. This method will not impact the order or position of any remaining entries.

These changes are saved automatically. There is no need to call %Save()


index (NameIndex on Name) [Unique];
Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()
index (PKINDEX on Id) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: SQLStorage

Maps: 2

  • Map number 1 is named MainMap

    thismap.Global: ^IRIS.IK.Sys.UserDictD

  • Map number 2 is named NameIndex

    thismap.Global: ^IRIS.IK.Sys.UserDictI

  • ^IRIS.IK.Sys.UserDictD({Id})
    Node Delimiter Piece Name
    1 Name
    2 Description
    Node Delimiter Piece Name
FeedbackOpens in a new tab