/AWS1/CL_BDZRETRIEVALRSLTCONT¶
Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
This data type is used in the following API operations:
-
Retrieve response – in the
contentfield -
RetrieveAndGenerate response – in the
contentfield -
InvokeAgent response – in the
contentfield
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_type TYPE /AWS1/BDZRETRIEVALRSLTCONTTYPE /AWS1/BDZRETRIEVALRSLTCONTTYPE¶
The type of content in the retrieval result.
iv_text TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING¶
The cited text from the data source.
iv_bytecontent TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING¶
A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format:
data:image/jpeg;base64,${base64-encoded string}.
io_video TYPE REF TO /AWS1/CL_BDZVIDEOSEGMENT /AWS1/CL_BDZVIDEOSEGMENT¶
Video segment information when the retrieval result contains video content.
io_audio TYPE REF TO /AWS1/CL_BDZAUDIOSEGMENT /AWS1/CL_BDZAUDIOSEGMENT¶
Audio segment information when the retrieval result contains audio content.
it_row TYPE /AWS1/CL_BDZRETRIEVALRSCONTC00=>TT_RETRIEVALRESULTCONTENTROW TT_RETRIEVALRESULTCONTENTROW¶
Specifies information about the rows with the cells to return in retrieval.
Queryable Attributes¶
type¶
The type of content in the retrieval result.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
text¶
The cited text from the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEXT() |
Getter for TEXT, with configurable default |
ASK_TEXT() |
Getter for TEXT w/ exceptions if field has no value |
HAS_TEXT() |
Determine if TEXT has a value |
byteContent¶
A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format:
data:image/jpeg;base64,${base64-encoded string}.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BYTECONTENT() |
Getter for BYTECONTENT, with configurable default |
ASK_BYTECONTENT() |
Getter for BYTECONTENT w/ exceptions if field has no value |
HAS_BYTECONTENT() |
Determine if BYTECONTENT has a value |
video¶
Video segment information when the retrieval result contains video content.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VIDEO() |
Getter for VIDEO |
audio¶
Audio segment information when the retrieval result contains audio content.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIO() |
Getter for AUDIO |
row¶
Specifies information about the rows with the cells to return in retrieval.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROW() |
Getter for ROW, with configurable default |
ASK_ROW() |
Getter for ROW w/ exceptions if field has no value |
HAS_ROW() |
Determine if ROW has a value |