Skip to content

/AWS1/CL_BDZKNOWLEDGEBASERET02

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

CONSTRUCTOR

IMPORTING

Required arguments:

io_content TYPE REF TO /AWS1/CL_BDZRETRIEVALRSLTCONT /AWS1/CL_BDZRETRIEVALRSLTCONT

Contains information about the content of the chunk.

Optional arguments:

io_location TYPE REF TO /AWS1/CL_BDZRETRIEVALRESULTLOC /AWS1/CL_BDZRETRIEVALRESULTLOC

Contains information about the location of the data source.

iv_score TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The level of relevance of the result to the query.

it_metadata TYPE /AWS1/CL_RT_DOCUMENT=>TT_MAP TT_MAP

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

iv_documentid TYPE /AWS1/BDZDOCUMENTID /AWS1/BDZDOCUMENTID

The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.

Queryable Attributes

content

Contains information about the content of the chunk.

Accessible with the following methods

Method Description
GET_CONTENT() Getter for CONTENT

location

Contains information about the location of the data source.

Accessible with the following methods

Method Description
GET_LOCATION() Getter for LOCATION

score

The level of relevance of the result to the query.

Accessible with the following methods

Method Description
GET_SCORE() Getter for SCORE, with configurable default
ASK_SCORE() Getter for SCORE w/ exceptions if field has no value
STR_SCORE() String format for SCORE, with configurable default
HAS_SCORE() Determine if SCORE has a value

metadata

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Accessible with the following methods

Method Description
GET_METADATA() Getter for METADATA, with configurable default
ASK_METADATA() Getter for METADATA w/ exceptions if field has no value
HAS_METADATA() Determine if METADATA has a value

documentId

The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.

Accessible with the following methods

Method Description
GET_DOCUMENTID() Getter for DOCUMENTID, with configurable default
ASK_DOCUMENTID() Getter for DOCUMENTID w/ exceptions if field has no value
HAS_DOCUMENTID() Determine if DOCUMENTID has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_KNOWLEDGEBASERETRIEVALRSLTS

TYPES TT_KNOWLEDGEBASERETRIEVALRSLTS TYPE STANDARD TABLE OF REF TO /AWS1/CL_BDZKNOWLEDGEBASERET02 WITH DEFAULT KEY
.