qbusiness/aws.sdk.kotlin.services.qbusiness.model/SourceAttribution

SourceAttribution

class SourceAttribution

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

Types

Builder

class Builder

Companion

object Companion

Properties

citationNumber

val citationNumber: Int?

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

datasourceId

val datasourceId: String?

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".

documentId

val documentId: String?

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.

indexId

val indexId: String?

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.

snippet

val snippet: String?

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

textMessageSegments

val textMessageSegments: List<TextSegment>?

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

title

val title: String?

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

updatedAt

val updatedAt: Instant?

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