Skip to content

GetDocumentContentRequest

Source code in docs_src/capo_qbusiness/types/get_document_content_request.py 
15
16
17
18
19
20
21
22
23
24
25
class GetDocumentContentRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier of the index where documents are indexed.</p>"""
    data_source_id: NotRequired["capo_qbusiness.types.data_source_id.DataSourceId"]
    """<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. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>"""
    document_id: "capo_qbusiness.types.document_id.DocumentId"
    """<p>The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.</p>"""
    output_format: NotRequired["capo_qbusiness.types.output_format.OutputFormat"]
    """<p>Document outputFormat. Defaults to RAW if not selected.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.

data_source_id instance-attribute 

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

The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.

index_id instance-attribute 

index_id: IndexId

The identifier of the index where documents are indexed.

output_format instance-attribute 

output_format: NotRequired[OutputFormat]

Document outputFormat. Defaults to RAW if not selected.