SourceAttribution¶
Structure Class¶
dataclass
¶
The documents used to generate an Amazon Q Business web experience response.
Attributes¶
class-attribute
instance-attribute
¶
citation_number: int | None = None
The number attached to a citation in an Amazon Q Business generated response.
class-attribute
instance-attribute
¶
datasource_id: str | None = None
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".
class-attribute
instance-attribute
¶
document_id: str | None = None
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.
class-attribute
instance-attribute
¶
index_id: str | None = None
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.
class-attribute
instance-attribute
¶
snippet: str | None = None
The content extract from the document on which the generated response is based.
class-attribute
instance-attribute
¶
text_message_segments: list[TextSegment] | None = None
A text extract from a source document that is used for source attribution.
class-attribute
instance-attribute
¶
title: str | None = None
The title of the document which is the source for the Amazon Q Business generated response.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The Unix timestamp when the Amazon Q Business application was last updated.
class-attribute
instance-attribute
¶
url: str | None = None
The URL of the document which is the source for the Amazon Q Business generated response.