Document¶
Structure Class¶
dataclass
¶
A document in an Amazon Q Business application.
Attributes¶
class-attribute
instance-attribute
¶
access_configuration: AccessConfiguration | None = None
Configuration information for access permission to a document.
class-attribute
instance-attribute
¶
attributes: list[DocumentAttribute] | None = None
Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
class-attribute
instance-attribute
¶
content: DocumentContent | None = None
The contents of the document.
class-attribute
instance-attribute
¶
content_type: ContentType | None = 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.
class-attribute
instance-attribute
¶
document_enrichment_configuration: DocumentEnrichmentConfiguration | None = None
The configuration information for altering document metadata and content during the document ingestion process.
class-attribute
instance-attribute
¶
media_extraction_configuration: MediaExtractionConfiguration | None = None
The configuration for extracting information from media in the document.