Skip to main content


deprecated persistent class %iKnow.Objects.Sentence extends %Library.Persistent

SQL Table Name: %iKnow_Objects.Sentence

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for Sentences.

This class can be used from ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Queries.SentenceAPI and other query classes to consult sentence data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

NOTE: This object assumes all underlying data structures are present. Use domain-specific copies of these objects for domains where not all indices are built. See also the GenerateAllObjectsForDomain() method in %iKnow.Objects.Utils.

Property Inventory


parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.


property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property LanguageConfidence as %Numeric;
Property methods: LanguageConfidenceDisplayToLogical(), LanguageConfidenceGet(), LanguageConfidenceIsValid(), LanguageConfidenceLogicalToDisplay(), LanguageConfidenceNormalize(), LanguageConfidenceSet()
property LanguageId as %Integer;
Property methods: LanguageIdDisplayToLogical(), LanguageIdGet(), LanguageIdIsValid(), LanguageIdLogicalToDisplay(), LanguageIdNormalize(), LanguageIdSet()
property Position as %Integer [ Calculated ];
Property methods: PositionCompute(), PositionDisplayToLogical(), PositionGet(), PositionIsValid(), PositionLogicalToDisplay(), PositionNormalize(), PositionSQLCompute()
property SentenceId as %Integer [ Required ];
Property methods: SentenceIdDisplayToLogical(), SentenceIdGet(), SentenceIdIsValid(), SentenceIdLogicalToDisplay(), SentenceIdNormalize(), SentenceIdSet()
property SentenceValue as %String (MAXLEN = 32000) [ Calculated ];
Property methods: SentenceValueCompute(), SentenceValueDisplayToLogical(), SentenceValueGet(), SentenceValueIsValid(), SentenceValueLogicalToDisplay(), SentenceValueLogicalToOdbc(), SentenceValueNormalize(), SentenceValueSQLCompute()
property Source as %iKnow.Objects.Source [ Calculated ];
Property methods: SourceCompute(), SourceGet(), SourceGetObject(), SourceGetObjectId(), SourceSQLCompute()
property SourceId as %Integer [ Calculated ];
Property methods: SourceIdCompute(), SourceIdDisplayToLogical(), SourceIdGet(), SourceIdIsValid(), SourceIdLogicalToDisplay(), SourceIdNormalize(), SourceIdSQLCompute()
property SummaryRelevance as %Numeric;
Property methods: SummaryRelevanceDisplayToLogical(), SummaryRelevanceGet(), SummaryRelevanceIsValid(), SummaryRelevanceLogicalToDisplay(), SummaryRelevanceNormalize(), SummaryRelevanceSet()


index (PKINDEX on DomainId,SentenceId) [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.SentDetails

  • Map number 2 is named SourceIdx

    thismap.Global: ^IRIS.IK.SrcDetails

  • ^IRIS.IK.SentDetails({DomainId},{SentenceId})
    Node Delimiter Piece Name
    1 LanguageId
    2 LanguageConfidence
    3 SummaryRelevance
FeedbackOpens in a new tab