Qbusiness  >  Unions  >  DocumentContent

DocumentContent

Union Type

DocumentContent module-attribute

DocumentContent = Union[DocumentContentBlob | DocumentContentS3 | DocumentContentUnknown]

The contents of a document.

Note

Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.

Union Member Types

DocumentContentBlob dataclass

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

Attributes

value instance-attribute

value: bytes

DocumentContentS3 dataclass

The path to the document in an Amazon S3 bucket.

Attributes

value instance-attribute

value: S3

DocumentContentUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute

tag: str