Skip to content

SourceAttribution

Source code in docs_src/capo_qbusiness/types/source_attribution.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class SourceAttribution(TypedDict, closed=True):
    title: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The title of the document which is the source for the Amazon Q Business generated response. </p>"""
    snippet: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The content extract from the document on which the generated response is based. </p>"""
    url: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The URL of the document which is the source for the Amazon Q Business generated response. </p>"""
    citation_number: NotRequired["capo_qbusiness.types.integer.Integer"]
    """<p>The number attached to a citation in an Amazon Q Business generated response.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business application was last updated.</p>"""
    text_message_segments: NotRequired[
        "capo_qbusiness.types.text_segment_list.TextSegmentList"
    ]
    """<p>A text extract from a source document that is used for source attribution.</p>"""
    document_id: NotRequired["capo_qbusiness.types.string.String"]
    """<p>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 <code>GetDocumentContent</code> API to retrieve the actual document content for user verification.</p>"""
    index_id: NotRequired["capo_qbusiness.types.string.String"]
    """<p>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.</p>"""
    datasource_id: NotRequired["capo_qbusiness.types.string.String"]
    """<p>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".</p>"""

citation_number instance-attribute 

citation_number: NotRequired[Integer]

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

datasource_id instance-attribute 

datasource_id: NotRequired[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".

document_id instance-attribute 

document_id: NotRequired[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.

index_id instance-attribute 

index_id: NotRequired[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 instance-attribute 

snippet: NotRequired[String]

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

text_message_segments instance-attribute 

text_message_segments: NotRequired[TextSegmentList]

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

title instance-attribute 

title: NotRequired[String]

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

updated_at instance-attribute 

updated_at: NotRequired[Timestamp]

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

url instance-attribute 

url: NotRequired[String]

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