Skip to content

GetDocumentContentRequest

Source code in docs_src/capo_bedrock_agent_runtime/types/get_document_content_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class GetDocumentContentRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_bedrock_agent_runtime.types.knowledge_base_identifier.KnowledgeBaseIdentifier"
    """<p>The unique identifier of the knowledge base that contains the document.</p>"""
    data_source_id: "capo_bedrock_agent_runtime.types.data_source_id.DataSourceId"
    """<p>The unique identifier of the data source that contains the document.</p>"""
    document_id: "capo_bedrock_agent_runtime.types.document_id.DocumentId"
    """<p>The unique identifier of the document to retrieve content for.</p>"""
    output_format: NotRequired[
        "capo_bedrock_agent_runtime.types.document_output_format.DocumentOutputFormat"
    ]
    """<p>The output format for the document content. <code>RAW</code> returns the original file. <code>EXTRACTED</code> returns parsed text as JSON. Defaults to <code>RAW</code>.</p>"""
    user_context: NotRequired[
        "capo_bedrock_agent_runtime.types.user_context.UserContext"
    ]
    """<p>Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.</p>"""

data_source_id instance-attribute 

data_source_id: DataSourceId

The unique identifier of the data source that contains the document.

document_id instance-attribute 

document_id: DocumentId

The unique identifier of the document to retrieve content for.

knowledge_base_id instance-attribute 

knowledge_base_id: KnowledgeBaseIdentifier

The unique identifier of the knowledge base that contains the document.

output_format instance-attribute 

output_format: NotRequired[DocumentOutputFormat]

The output format for the document content. RAW returns the original file. EXTRACTED returns parsed text as JSON. Defaults to RAW.

user_context instance-attribute 

user_context: NotRequired[UserContext]

Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.