Skip to main content


persistent class %iKnow.Objects.VirtualSentence extends %Library.Persistent

SQL Table Name: %iKnow_Objects.VirtualSentence

This is a read-only object representation wrapping the internal iKnow data structures for sentences in a Virtual Source.

This class can be used from Cache 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.

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 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.VirtualSource [ Calculated ];
Property methods: SourceCompute(), SourceGet(), SourceGetObject(), SourceGetObjectId(), SourceSQLCompute()
property SummaryRelevance as %Numeric;
Property methods: SummaryRelevanceDisplayToLogical(), SummaryRelevanceGet(), SummaryRelevanceIsValid(), SummaryRelevanceLogicalToDisplay(), SummaryRelevanceNormalize(), SummaryRelevanceSet()
property VirtualSourceId as %Integer [ Required ];
Property methods: VirtualSourceIdDisplayToLogical(), VirtualSourceIdGet(), VirtualSourceIdIsValid(), VirtualSourceIdLogicalToDisplay(), VirtualSourceIdNormalize(), VirtualSourceIdSet()


index (PKINDEX on DomainId,VirtualSourceId,SentenceId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: CacheSQLStorage

Maps: 1

  • Map number 1 is named MainMap

    thismap.Global: ^ISC.IKV.SentDetails

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