/AWS1/CL_QQBSOURCEATTRIBUTION

The documents used to generate an Amazon Q Business web experience response.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_title TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The title of the document which is the source for the Amazon Q Business generated response.

iv_snippet TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The content extract from the document on which the generated response is based.

iv_url TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The URL of the document which is the source for the Amazon Q Business generated response.

iv_citationnumber TYPE /AWS1/QQBINTEGER /AWS1/QQBINTEGER

The number attached to a citation in an Amazon Q Business generated response.

iv_updatedat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The Unix timestamp when the Amazon Q Business application was last updated.

it_textmessagesegments TYPE /AWS1/CL_QQBTEXTSEGMENT=>TT_TEXTSEGMENTLIST TT_TEXTSEGMENTLIST

A text extract from a source document that is used for source attribution.

iv_documentid TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the GetDocumentContent API to retrieve the actual document content for user verification.

iv_indexid TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored.

iv_datasourceid TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".

---

Queryable Attributes

title

The title of the document which is the source for the Amazon Q Business generated response.

Accessible with the following methods

Method	Description
GET_TITLE()	Getter for TITLE, with configurable default
ASK_TITLE()	Getter for TITLE w/ exceptions if field has no value
HAS_TITLE()	Determine if TITLE has a value

snippet

The content extract from the document on which the generated response is based.

Accessible with the following methods

Method	Description
GET_SNIPPET()	Getter for SNIPPET, with configurable default
ASK_SNIPPET()	Getter for SNIPPET w/ exceptions if field has no value
HAS_SNIPPET()	Determine if SNIPPET has a value

url

The URL of the document which is the source for the Amazon Q Business generated response.

Accessible with the following methods

Method	Description
GET_URL()	Getter for URL, with configurable default
ASK_URL()	Getter for URL w/ exceptions if field has no value
HAS_URL()	Determine if URL has a value

citationNumber

The number attached to a citation in an Amazon Q Business generated response.

Accessible with the following methods

Method	Description
GET_CITATIONNUMBER()	Getter for CITATIONNUMBER, with configurable default
ASK_CITATIONNUMBER()	Getter for CITATIONNUMBER w/ exceptions if field has no valu
HAS_CITATIONNUMBER()	Determine if CITATIONNUMBER has a value

updatedAt

The Unix timestamp when the Amazon Q Business application was last updated.

Accessible with the following methods

Method	Description
GET_UPDATEDAT()	Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT()	Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT()	Determine if UPDATEDAT has a value

textMessageSegments

A text extract from a source document that is used for source attribution.

Accessible with the following methods

Method	Description
GET_TEXTMESSAGESEGMENTS()	Getter for TEXTMESSAGESEGMENTS, with configurable default
ASK_TEXTMESSAGESEGMENTS()	Getter for TEXTMESSAGESEGMENTS w/ exceptions if field has no
HAS_TEXTMESSAGESEGMENTS()	Determine if TEXTMESSAGESEGMENTS has a value

documentId

The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the GetDocumentContent API to retrieve the actual document content for user verification.

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

indexId

The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored.

Accessible with the following methods

Method	Description
GET_INDEXID()	Getter for INDEXID, with configurable default
ASK_INDEXID()	Getter for INDEXID w/ exceptions if field has no value
HAS_INDEXID()	Determine if INDEXID has a value

datasourceId

The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".

Accessible with the following methods

Method	Description
GET_DATASOURCEID()	Getter for DATASOURCEID, with configurable default
ASK_DATASOURCEID()	Getter for DATASOURCEID w/ exceptions if field has no value
HAS_DATASOURCEID()	Determine if DATASOURCEID 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_SOURCEATTRIBUTIONS

TYPES TT_SOURCEATTRIBUTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_QQBSOURCEATTRIBUTION WITH DEFAULT KEY
.