Document ¶

class Document(TypedDict, closed=True):
    id: "capo_qbusiness.types.document_id.DocumentId"
    """<p>The identifier of the document.</p>"""
    attributes: NotRequired[
        "capo_qbusiness.types.document_attributes.DocumentAttributes"
    ]
    """<p>Custom attributes to apply to the document for refining Amazon Q Business web experience responses.</p>"""
    content: NotRequired["capo_qbusiness.types.document_content.DocumentContent"]
    """<p>The contents of the document.</p>"""
    content_type: NotRequired["capo_qbusiness.types.content_type.ContentType"]
    """<p>The file type of the document in the Blob field.</p> <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the <code>HTML</code> start and closing tags (<code>&lt;HTML&gt;content&lt;/HTML&gt;</code>) around the content.</p>"""
    title: NotRequired["capo_qbusiness.types.title.Title"]
    """<p>The title of the document.</p>"""
    access_configuration: NotRequired[
        "capo_qbusiness.types.access_configuration.AccessConfiguration"
    ]
    """<p>Configuration information for access permission to a document.</p>"""
    document_enrichment_configuration: NotRequired[
        "capo_qbusiness.types.document_enrichment_configuration.DocumentEnrichmentConfiguration"
    ]
    """<p>The configuration information for altering document metadata and content during the document ingestion process.</p>"""
    media_extraction_configuration: NotRequired[
        "capo_qbusiness.types.media_extraction_configuration.MediaExtractionConfiguration"
    ]
    """<p>The configuration for extracting information from media in the document.</p>"""