Skip to content

/AWS1/CL_BDRDOCUMENTBLOCK

A document to include in a message.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/BDRSTRING /AWS1/BDRSTRING

A name for the document. The name can only contain the following characters:

  • Alphanumeric characters

  • Whitespace characters (no more than one in a row)

  • Hyphens

  • Parentheses

  • Square brackets

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

io_source TYPE REF TO /AWS1/CL_BDRDOCUMENTSOURCE /AWS1/CL_BDRDOCUMENTSOURCE

Contains the content of the document.

Optional arguments:

iv_format TYPE /AWS1/BDRDOCUMENTFORMAT /AWS1/BDRDOCUMENTFORMAT

The format of a document, or its extension.

iv_context TYPE /AWS1/BDRSTRING /AWS1/BDRSTRING

Contextual information about how the document should be processed or interpreted by the model when generating citations.

io_citations TYPE REF TO /AWS1/CL_BDRCITATIONSCONFIG /AWS1/CL_BDRCITATIONSCONFIG

Configuration settings that control how citations should be generated for this specific document.

Queryable Attributes

format

The format of a document, or its extension.

Accessible with the following methods

Method Description
GET_FORMAT() Getter for FORMAT, with configurable default
ASK_FORMAT() Getter for FORMAT w/ exceptions if field has no value
HAS_FORMAT() Determine if FORMAT has a value

name

A name for the document. The name can only contain the following characters:

  • Alphanumeric characters

  • Whitespace characters (no more than one in a row)

  • Hyphens

  • Parentheses

  • Square brackets

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

source

Contains the content of the document.

Accessible with the following methods

Method Description
GET_SOURCE() Getter for SOURCE

context

Contextual information about how the document should be processed or interpreted by the model when generating citations.

Accessible with the following methods

Method Description
GET_CONTEXT() Getter for CONTEXT, with configurable default
ASK_CONTEXT() Getter for CONTEXT w/ exceptions if field has no value
HAS_CONTEXT() Determine if CONTEXT has a value

citations

Configuration settings that control how citations should be generated for this specific document.

Accessible with the following methods

Method Description
GET_CITATIONS() Getter for CITATIONS