API documentation for documentai_v1beta2.types package.
Classes
AutoMlParams
Parameters to control AutoML model prediction behavior. .. attribute:: model
Resource name of the AutoML model.
Format:
projects/{project-id}/locations/{location-id}/models/{model-id}.
:type: str
BatchProcessDocumentsRequest
Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.
BatchProcessDocumentsResponse
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
BoundingPoly
A bounding polygon for the detected image annotation. .. attribute:: vertices
The bounding polygon vertices.
:type: Sequence[google.cloud.documentai_v1beta2.types.Vertex]
Document
Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
EntityExtractionParams
Parameters to control entity extraction behavior. .. attribute:: enabled
Whether to enable entity extraction.
:type: bool
FormExtractionParams
Parameters to control form extraction behavior. .. attribute:: enabled
Whether to enable form extraction.
:type: bool
GcsDestination
The Google Cloud Storage location where the output file will be written to.
GcsSource
The Google Cloud Storage location where the input file will be read from.
InputConfig
The desired input location and metadata. .. attribute:: gcs_source
The Google Cloud Storage location to read the input from. This must be a single file.
KeyValuePairHint
User-provided hint for key value pair. .. attribute:: key
The key text for the hint.
:type: str
NormalizedVertex
A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
OcrParams
Parameters to control Optical Character Recognition (OCR) behavior.
OperationMetadata
Contains metadata for the BatchProcessDocuments operation. .. attribute:: state
The state of the current batch processing.
:type: google.cloud.documentai_v1beta2.types.OperationMetadata.State
OutputConfig
The desired output location and metadata. .. attribute:: gcs_destination
The Google Cloud Storage location to write the output to.
ProcessDocumentRequest
Request to process one document. .. attribute:: parent
Target project and location to make a call.
Format: projects/{project-id}/locations/{location-id}.
If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.
:type: str
ProcessDocumentResponse
Response to a single document processing request. .. attribute:: input_config
Information about the input file. This is the same as the corresponding input config in the request.
TableBoundHint
A hint for a table bounding box on the page for table parsing.
TableExtractionParams
Parameters to control table extraction behavior. .. attribute:: enabled
Whether to enable table extraction.
:type: bool
Vertex
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.