Skip to content

Document

Structure Class

Document dataclass

Bases: _SerdeShape

A document in an Amazon Q Business application.

Attributes

access_configuration class-attribute instance-attribute
access_configuration: AccessConfiguration | None = ...

Configuration information for access permission to a document.

attributes class-attribute instance-attribute
attributes: list[DocumentAttribute] | None = ...

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

content class-attribute instance-attribute
content: DocumentContent | None = ...

The contents of the document.

content_type class-attribute 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 class-attribute instance-attribute
document_enrichment_configuration: DocumentEnrichmentConfiguration | None = ...

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

id instance-attribute
id: str

The identifier of the document.

media_extraction_configuration class-attribute instance-attribute
media_extraction_configuration: MediaExtractionConfiguration | None = ...

The configuration for extracting information from media in the document.

title class-attribute instance-attribute
title: str | None = ...

The title of the document.