Inheritance diagram for Semantic:

[legend]

Collaboration diagram for Semantic:

[legend]

Static Public Attributes
	IFINDATTRIBUTES = None

Static Public Attributes inherited from Basic
	KEEPCHARS = None

	RANKERCLASS = None

Static Public Attributes inherited from Minimal
	IFINDADVANCEDSQLPREFIX = None

	IFINDMAPPINGS = None

	IFINDSHAREDDATALOCATION = None
	This parameter enables specifying whether words, entities and similar data should be written. More...

	IGNOREPUNCTUATION = None

	INDEXOPTION = None
	Specific indexing options to use when processing records. More...

	LANGUAGE = None
	Language to use when indexing records. More...

	LOWER = None
	Whether or not to convert content to lowercase before indexing. More...

	STEMMINGCONFIG = None

	SUPPORTSSHARDING = None
	This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be. More...

	TRANSFORMATIONSPEC = None

	USERDICTIONARY = None

Static Public Attributes inherited from FunctionalIndex
	SUPPORTSSHARDING = None
	This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be. More...

Additional Inherited Members
Static Public Member Functions inherited from Basic
_.Library.String	Highlight (_.Library.RawString pRecordID, _.Library.String pSearchString, _.Library.String pSearchOption, _.Library.String pTags, _.Library.Integer pLimit, _.Library.Status pSC)

_.Library.Float	Rank (_.Library.RawString pRecordID, _.Library.String pSearchString, _.Library.String pSearchOption)

_.Library.String	StripCharacters (_.Library.String pWord)
	Utility method stripping punctuation characters from the start and end of a word, according to. More...

_.Library.String	StrippedEntityId (_.Library.String pEntity)
	Returns the Entity ID for pEntity, after stripping off any punctuation at the start and end of. More...

_.Library.String	StrippedWordId (_.Library.String pWord)
	Returns the Word ID for pWord, after stripping off any punctuation at the start and end of. More...

Static Public Member Functions inherited from Minimal
	DeleteIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Deletes the iFind index for the row.

_.Library.RegisteredObject	Embedded ()
	Return an instance of the embedded Find class, initialized with the index' parameters.

_.Library.Binary	Find (_.Library.Binary pSearch, _.Library.Integer pOption, _.Library.String pLanguage, _.Library.String pSynonymOption)
	Searches for matches based on the iFind index. More...

	InsertIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Inserts the iFind index for the row. More...

_.Library.String	Normalize (_.Library.String pQuery, _.Library.String pLanguage)
	This method will normalize the query of iFind.Find.Basic based on the dictionary defined iFind.Index.Basic.

	PurgeIndex ()
	Purges the iFind index.

	UpdateIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Updates the iFind index for the row.

Static Public Member Functions inherited from FunctionalIndex
	DeleteIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when an existing instance of a class is deleted.

	InsertIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when a new instance of a class is inserted into the database.

	SegmentFinalize (_.Library.RawString pIndexBuffer, _.Library.RawString pStartID, _.Library.RawString pEndID)
	This method is called when the index builder is finalizing a segment. More...

	SegmentInitialize (_.Library.RawString pIndexBuffer, _.Library.RawString pStartID, _.Library.RawString pEndID)
	This method is called by the parallel index build to initialize an index segment when constructing. More...

	UpdateIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when an existing instance of a class is updated.

Detailed Description

The InterSystems IRIS NLP iKnow technology on which this index type is based is now deprecated. Please see the product documentation for more detail. The <class>iKnow.Index.Basic</class> and <class>iKnow.Index.Minimal</class> index types remain fully supported.

This index class is a more advanced version of <class>iFind.Index.Basic</class>, leveraging the semantic output of the iKnow engine processing the text being indexed. In addition to the search options provided by the Basic index, users can now also query for entities and their attributes:

Search string	What will be retrieved
logical structure	All records containing both the words "logical" and "structure" (implicit AND)
"logical structure"	All records containing the word "structure" right behind "logical" (positional search)
{logical structure}	Records containing the actual entity "logical structure"
<{logical structure}	Expanded entity search for entities ending with "logical structure" (but something before too)
{logical structure}>	Expanded entity search for entities starting with "logical structure" (but something after too)
<logical structure	Implicit AND of entity search on entities ending with "logical" and simple word search on "structure"
<structure	Records containing entities ending with the word "structure"
<structure*	Records containing entities ending with any word beginning with "structure"
<structure AND NOT "logical structure"	Records containing entities ending with the word "structure", except if they also contain the exact string "logical structure" (positional search)

Note: In the above table, the first two examples are also supported using a Basic index, but are repeated here for comparison with the new entity search options.

If the <parameter>IFINDMAPPINGS</parameter> index is set to 1, the following additional SQL projections will be generated:

[class_name]_[index_name]_Ent: stores which entities occur in which records. See also <class>iFind.Index.AbstractEntity</class>.
[class_name]_[index_name]_EntSpread: stores the total number of records in which each entity occurs. See also <class>iFind.Index.AbstractEntSpread</class>.

For a detailed description of the other configuration and query options, see the class reference for <class>iFind.Index.Basic</class>.

Member Data Documentation

◆ IFINDATTRIBUTES

IFINDATTRIBUTES = None

static

The InterSystems IRIS NLP iKnow technology on which this index type is based is now deprecated. Please see the product documentation for more detail. The <class>iKnow.Index.Basic</class> and <class>iKnow.Index.Minimal</class> index types remain fully supported.

This index class is a more advanced version of <class>iFind.Index.Basic</class>, leveraging the semantic output of the iKnow engine processing the text being indexed. In addition to the search options provided by the Basic index, users can now also query for entities and their attributes:

Search string	What will be retrieved
logical structure	All records containing both the words "logical" and "structure" (implicit AND)
"logical structure"	All records containing the word "structure" right behind "logical" (positional search)
{logical structure}	Records containing the actual entity "logical structure"
<{logical structure}	Expanded entity search for entities ending with "logical structure" (but something before too)
{logical structure}>	Expanded entity search for entities starting with "logical structure" (but something after too)
<logical structure	Implicit AND of entity search on entities ending with "logical" and simple word search on "structure"
<structure	Records containing entities ending with the word "structure"
<structure*	Records containing entities ending with any word beginning with "structure"
<structure AND NOT "logical structure"	Records containing entities ending with the word "structure", except if they also contain the exact string "logical structure" (positional search)

Note: In the above table, the first two examples are also supported using a Basic index, but are repeated here for comparison with the new entity search options.

If the <parameter>IFINDMAPPINGS</parameter> index is set to 1, the following additional SQL projections will be generated:

[class_name]_[index_name]_Ent: stores which entities occur in which records. See also <class>iFind.Index.AbstractEntity</class>.
[class_name]_[index_name]_EntSpread: stores the total number of records in which each entity occurs. See also <class>iFind.Index.AbstractEntSpread</class>.

For a detailed description of the other configuration and query options, see the class reference for <class>iFind.Index.Basic</class>.

Whether or not to store attribute information, such as negation.

If set to 1, the following additional projections will be generated in the "[<i>package_name</i>]_[<i>class_name</i>]" package if your <parameter>IFINDMAPPINGS</parameter> is set to 1, exposing attribute occurrence details:

[class_name]_[index_name]_Attribute stores whether a particular attribute occurs anywhere in a record. See also <class>iFind.Index.AbstractAttribute</class>.
[class_name]_[index_name]_AttributePos stores for a particular attribute, to which word positions in the record it applies. See also <class>iFind.Index.AbstractAttributePos</class>.

The attribute values currently supported out of the box are:

1: explicit negation within the entity
-1: negation implied by another entity within the path

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Data Documentation

◆ IFINDATTRIBUTES