Skip to content

DocumentDetails

Source code in docs_src/capo_qbusiness/types/document_details.py
class DocumentDetails(TypedDict, closed=True):
    document_id: NotRequired["capo_qbusiness.types.document_id.DocumentId"]
    """<p>The identifier of the document.</p>"""
    status: NotRequired["capo_qbusiness.types.document_status.DocumentStatus"]
    """<p>The current status of the document.</p>"""
    error: NotRequired["capo_qbusiness.types.error_detail.ErrorDetail"]
    """<p>An error message associated with the document.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The timestamp for when the document was created.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The timestamp for when the document was last updated.</p>"""

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp for when the document was created.

document_id instance-attribute

document_id: NotRequired[DocumentId]

The identifier of the document.

error instance-attribute

error: NotRequired[ErrorDetail]

An error message associated with the document.

status instance-attribute

status: NotRequired[DocumentStatus]

The current status of the document.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp for when the document was last updated.