Class %iFind.Index.Semantic

deprecatedindex class %iFind.Index.Semantic extends %iFind.Index.Basic

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 %iKnow.Index.Basic and %iKnow.Index.Minimal index types remain fully supported.

This index class is a more advanced version of %iFind.Index.Basic, 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 IFINDMAPPINGS 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 %iFind.Index.AbstractEntity.
[class_name]_[index_name]_EntSpread: stores the total number of records in which each entity occurs. See also %iFind.Index.AbstractEntSpread.

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

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2

Summary

Methods
DeleteIndex	Embedded	Find	Highlight
InsertIndex	Normalize	PurgeIndex	Rank
SegmentFinalize	SegmentInitialize	SegmentInsert	SortBeginIndex
SortEndIndex	StripCharacters	StrippedEntityId	StrippedWordId
UpdateIndex

Subclasses
%iFind.Index.Analytic

Parameters

• parameter IFINDATTRIBUTES = 0;

Whether or not to store attribute information, such as negation. If set to 1, the following additional projections will be generated in the "[package_name]_[class_name]" package if your IFINDMAPPINGS 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 %iFind.Index.AbstractAttribute.

[class_name]_[index_name]_AttributePos stores for a particular attribute, to which word positions in the record it applies. See also %iFind.Index.AbstractAttributePos.

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search