Skip to content

DocumentDict

Dictionary Type

DocumentDict

Bases: TypedDict

Dictionary form of Document.

Attributes

access_configuration instance-attribute
access_configuration: AccessConfiguration | AccessConfigurationDict | None

Configuration information for access permission to a document.

attributes instance-attribute

Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

content instance-attribute

The contents of the document.

content_type instance-attribute
content_type: str | None

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

document_enrichment_configuration instance-attribute
document_enrichment_configuration: DocumentEnrichmentConfiguration | DocumentEnrichmentConfigurationDict | None

The configuration information for altering document metadata and content during the document ingestion process.

id instance-attribute

The identifier of the document.

media_extraction_configuration instance-attribute
media_extraction_configuration: MediaExtractionConfiguration | MediaExtractionConfigurationDict | None

The configuration for extracting information from media in the document.

title instance-attribute
title: str | None

The title of the document.