Skip to content

GetDocumentTextDetectionResponse

Source code in docs_src/capo_textract/types/get_document_text_detection_response.py
class GetDocumentTextDetectionResponse(TypedDict, closed=True):
    document_metadata: NotRequired[
        "capo_textract.types.document_metadata.DocumentMetadata"
    ]
    """<p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is returned in every page of paginated responses from an Amazon Textract video operation.</p>"""
    job_status: NotRequired["capo_textract.types.job_status.JobStatus"]
    """<p>The current status of the text detection job.</p>"""
    next_token: NotRequired["capo_textract.types.pagination_token.PaginationToken"]
    """<p>If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.</p>"""
    blocks: NotRequired["capo_textract.types.block_list.BlockList"]
    """<p>The results of the text-detection operation.</p>"""
    warnings: NotRequired["capo_textract.types.warnings.Warnings"]
    """<p>A list of warnings that occurred during the text-detection operation for the document.</p>"""
    status_message: NotRequired["capo_textract.types.status_message.StatusMessage"]
    """<p>Returns if the detection job could not be completed. Contains explanation for what error occured. </p>"""
    detect_document_text_model_version: NotRequired["capo_textract.types.string.String"]
    """<p></p>"""

blocks instance-attribute

blocks: NotRequired[BlockList]

The results of the text-detection operation.

detect_document_text_model_version instance-attribute

detect_document_text_model_version: NotRequired[String]

document_metadata instance-attribute

document_metadata: NotRequired[DocumentMetadata]

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

job_status instance-attribute

job_status: NotRequired[JobStatus]

The current status of the text detection job.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

Returns if the detection job could not be completed. Contains explanation for what error occured.

warnings instance-attribute

warnings: NotRequired[Warnings]

A list of warnings that occurred during the text-detection operation for the document.