All Classes and Interfaces
Class
Description
Encodes the detailed information of a barcode.
Encodes the detailed information of a barcode.
The common config to specify a set of documents used as input.
The common config to specify a set of documents used as input.
The long-running operation metadata for
[BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
The long-running operation metadata for
[BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
The status of a each individual document in the batch process.
The status of a each individual document in the batch process.
Possible states of the batch processing operation.
Request message for
[BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
Request message for
[BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
Response message for
[BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
Response message for
[BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
A bounding polygon for the detected image annotation.
A bounding polygon for the detected image annotation.
The common metadata for long running operations.
The common metadata for long running operations.
State of the longrunning operation.
Request message for the
[CreateProcessor][google.cloud.documentai.v1.DocumentProcessorService.CreateProcessor]
method.
Request message for the
[CreateProcessor][google.cloud.documentai.v1.DocumentProcessorService.CreateProcessor]
method.
The long-running operation metadata for the
[DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor]
method.
The long-running operation metadata for the
[DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor]
method.
Request message for the
[DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor]
method.
Request message for the
[DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor]
method.
The long-running operation metadata for the
[DeleteProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersion]
method.
The long-running operation metadata for the
[DeleteProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersion]
method.
Request message for the
[DeleteProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersion]
method.
Request message for the
[DeleteProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersion]
method.
The long-running operation metadata for the
[DeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersion]
method.
The long-running operation metadata for the
[DeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersion]
method.
Request message for the
[DeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersion]
method.
Request message for the
[DeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersion]
method.
Response message for the
[DeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersion]
method.
Response message for the
[DeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersion]
method.
The long-running operation metadata for the
[DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor]
method.
The long-running operation metadata for the
[DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor]
method.
Request message for the
[DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor]
method.
Request message for the
[DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor]
method.
Response message for the
[DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor]
method.
Response message for the
[DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor]
method.
Document represents the canonical document resource in Document AI.
Represents the annotation of a block or a chunk.
Represents the annotation of a block or a chunk.
Represents a blob asset.
Represents a blob asset.
Document represents the canonical document resource in Document AI.
Represents the chunks that the document is divided into.
Represents the chunks that the document is divided into.
Represents a chunk.
Represents a chunk.
The chunk field in the chunk.
The chunk field in the chunk.
Represents the page footer associated with the chunk.
Represents the page footer associated with the chunk.
Represents the page header associated with the chunk.
Represents the page header associated with the chunk.
Represents where the chunk starts and ends in the document.
Represents where the chunk starts and ends in the document.
The image chunk field in the chunk.
The image chunk field in the chunk.
The table chunk field in the chunk.
The table chunk field in the chunk.
Represents the parsed layout of a document as a collection of blocks that
the document is divided into.
Represents the parsed layout of a document as a collection of blocks that
the document is divided into.
Represents a block.
Represents a block.
Represents an image type block.
Represents an image type block.
Represents a list type block.
Represents a list type block.
Represents an entry in the list.
Represents an entry in the list.
Represents where the block starts and ends in the document.
Represents where the block starts and ends in the document.
Represents a table type block.
Represents a table type block.
Represents a cell in a table row.
Represents a cell in a table row.
Represents a row in a table.
Represents a row in a table.
Represents a text type block.
Represents a text type block.
Entity revision.
Entity revision.
An entity that could be a phrase in the text or a property that belongs to
the document.
An entity that could be a phrase in the text or a property that belongs to
the document.
Specifies how the entity's value is obtained.
Parsed and normalized entity value.
Parsed and normalized entity value.
Relationship between
[Entities][google.cloud.documentai.v1.Document.Entity].
Relationship between
[Entities][google.cloud.documentai.v1.Document.Entity].
The output of the validation given the document and the validation rules.
The output of the validation given the document and the validation rules.
Validation result for a single validation rule.
Validation result for a single validation rule.
The result of the validation rule.
A page in a [Document][google.cloud.documentai.v1.Document].
A block has a set of lines (collected into paragraphs) that have a
common line-spacing and orientation.
A block has a set of lines (collected into paragraphs) that have a
common line-spacing and orientation.
A page in a [Document][google.cloud.documentai.v1.Document].
A detected barcode.
A detected barcode.
Detected language for a structural component.
Detected language for a structural component.
Dimension for the page.
Dimension for the page.
A form field detected on the page.
A form field detected on the page.
Rendered image contents for this page.
Rendered image contents for this page.
Image quality scores for the page image.
Image quality scores for the page image.
Image Quality Defects
Image Quality Defects
Visual element describing a layout unit on a page.
Visual element describing a layout unit on a page.
Detected human reading orientation.
A collection of tokens that a human would perceive as a line.
A collection of tokens that a human would perceive as a line.
Representation for transformation matrix, intended to be compatible and
used with OpenCV format for image manipulation.
Representation for transformation matrix, intended to be compatible and
used with OpenCV format for image manipulation.
A collection of lines that a human would perceive as a paragraph.
A collection of lines that a human would perceive as a paragraph.
A detected symbol.
A detected symbol.
A table representation similar to HTML table structure.
A table representation similar to HTML table structure.
A cell representation inside the table.
A cell representation inside the table.
A row of table cells.
A row of table cells.
A detected token.
A detected token.
Detected break at the end of a
[Token][google.cloud.documentai.v1.Document.Page.Token].
Detected break at the end of a
[Token][google.cloud.documentai.v1.Document.Page.Token].
Enum to denote the type of break found.
Font and other text style attributes.
Font and other text style attributes.
Detected non-text visual elements, for example, checkbox, signature etc.
Detected non-text visual elements, for example, checkbox, signature etc.
Referencing the visual context of the entity in the
[Document.pages][google.cloud.documentai.v1.Document.pages].
Referencing the visual context of the entity in the
[Document.pages][google.cloud.documentai.v1.Document.pages].
Represents a weak reference to a page element within a document.
Represents a weak reference to a page element within a document.
The type of layout that is being referenced.
Structure to identify provenance relationships between annotations in
different revisions.
Structure to identify provenance relationships between annotations in
different revisions.
If a processor or agent does an explicit operation on existing elements.
The parent element the current element is based on.
The parent element the current element is based on.
Contains past or forward revisions of this document.
Contains past or forward revisions of this document.
Human Review information of the document.
Human Review information of the document.
For a large document, sharding may be performed to produce several
document shards.
For a large document, sharding may be performed to produce several
document shards.
Annotation for common text style attributes.
Annotation for common text style attributes.
Font size with unit.
Font size with unit.
Text reference indexing into the
[Document.text][google.cloud.documentai.v1.Document.text].
Text reference indexing into the
[Document.text][google.cloud.documentai.v1.Document.text].
A text segment in the
[Document.text][google.cloud.documentai.v1.Document.text].
A text segment in the
[Document.text][google.cloud.documentai.v1.Document.text].
This message is used for text changes aka.
This message is used for text changes aka.
Config that controls the output of documents.
Config that controls the output of documents.
The configuration used when outputting documents.
The configuration used when outputting documents.
The sharding config for the output document.
The sharding config for the output document.
The schema defines the output of the processed document by a processor.
The schema defines the output of the processed document by a processor.
EntityType is the wrapper of a label of the corresponding model with
detailed attributes and limitations for entity-based processors.
EntityType is the wrapper of a label of the corresponding model with
detailed attributes and limitations for entity-based processors.
Defines the a list of enum values.
Defines the a list of enum values.
Defines properties that can be part of the entity type.
Defines properties that can be part of the entity type.
Specifies how the entity's value is obtained from the document.
Types of occurrences of the entity type in the document.
Metadata for global schema behavior.
Metadata for global schema behavior.
The long-running operation metadata for the
[EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor]
method.
The long-running operation metadata for the
[EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor]
method.
Request message for the
[EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor]
method.
Request message for the
[EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor]
method.
Response message for the
[EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor]
method.
Response message for the
[EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor]
method.
Metadata of the
[EvaluateProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersion]
method.
Metadata of the
[EvaluateProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersion]
method.
Evaluates the given
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] against the
supplied documents.
Evaluates the given
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] against the
supplied documents.
Response of the
[EvaluateProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersion]
method.
Response of the
[EvaluateProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersion]
method.
An evaluation of a ProcessorVersion's performance.
An evaluation of a ProcessorVersion's performance.
Evaluations metrics, at a specific confidence level.
Evaluations metrics, at a specific confidence level.
Evaluation counters for the documents that were used.
Evaluation counters for the documents that were used.
Evaluation metrics, either in aggregate or about a specific entity.
Evaluation metrics, either in aggregate or about a specific entity.
Metrics across multiple confidence levels.
Metrics across multiple confidence levels.
A type that determines how metrics should be interpreted.
Builder for
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}.
Gives a short summary of an evaluation, and links to the evaluation itself.
Gives a short summary of an evaluation, and links to the evaluation itself.
Request message for the
[FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes]
method.
Request message for the
[FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes]
method.
Response message for the
[FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes]
method.
Response message for the
[FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes]
method.
Specifies a document stored on Cloud Storage.
Specifies a document stored on Cloud Storage.
Specifies a set of documents on Cloud Storage.
Specifies a set of documents on Cloud Storage.
Specifies all documents on Cloud Storage with a common prefix.
Specifies all documents on Cloud Storage with a common prefix.
Retrieves a specific Evaluation.
Retrieves a specific Evaluation.
Request message for the
[GetProcessor][google.cloud.documentai.v1.DocumentProcessorService.GetProcessor]
method.
Request message for the
[GetProcessor][google.cloud.documentai.v1.DocumentProcessorService.GetProcessor]
method.
Request message for the
[GetProcessorType][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorType]
method.
Request message for the
[GetProcessorType][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorType]
method.
Request message for the
[GetProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersion]
method.
Request message for the
[GetProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersion]
method.
Builder for projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.
The status of human review on a processed document.
The status of human review on a processed document.
The final state of human review on a processed document.
Retrieves a list of evaluations for a given
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion].
Retrieves a list of evaluations for a given
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion].
The response from `ListEvaluations`.
The response from `ListEvaluations`.
Request message for list all processors belongs to a project.
Request message for list all processors belongs to a project.
Response message for the
[ListProcessors][google.cloud.documentai.v1.DocumentProcessorService.ListProcessors]
method.
Response message for the
[ListProcessors][google.cloud.documentai.v1.DocumentProcessorService.ListProcessors]
method.
Request message for the
[ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
method.
Request message for the
[ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
method.
Response message for the
[ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
method.
Response message for the
[ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
method.
Request message for list all processor versions belongs to a processor.
Request message for list all processor versions belongs to a processor.
Response message for the
[ListProcessorVersions][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorVersions]
method.
Response message for the
[ListProcessorVersions][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorVersions]
method.
Builder for projects/{project}/locations/{location}.
A vertex represents a 2D point in the image.
A vertex represents a 2D point in the image.
Config for Document OCR.
Config for Document OCR.
Hints for OCR Engine
Hints for OCR Engine
Configurations for premium OCR features.
Configurations for premium OCR features.
Options for Process API
Options for Process API
A list of individual page numbers.
A list of individual page numbers.
Serving config for layout parser processor.
Serving config for layout parser processor.
Serving config for chunking.
Serving config for chunking.
The first-class citizen for Document AI.
The first-class citizen for Document AI.
The possible states of the processor.
Builder for projects/{project}/locations/{location}/processors/{processor}.
A processor type is responsible for performing a certain document
understanding task on a certain type of document.
A processor type is responsible for performing a certain document
understanding task on a certain type of document.
The location information about where the processor is available.
The location information about where the processor is available.
Builder for projects/{project}/locations/{location}/processorTypes/{processor_type}.
A processor version is an implementation of a processor.
A processor version is an implementation of a processor.
Information about the upcoming deprecation of this processor version.
Information about the upcoming deprecation of this processor version.
Information about Generative AI model-based processor versions.
Information about Generative AI model-based processor versions.
Information for a custom Generative AI model created by the user.
Information for a custom Generative AI model created by the user.
The type of custom model created by the user.
Information for a pretrained Google-managed foundation model.
Information for a pretrained Google-managed foundation model.
The possible model types of the processor version.
The possible states of the processor version.
Contains the alias and the aliased resource name of processor version.
Contains the alias and the aliased resource name of processor version.
Builder for
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}.
Request message for the
[ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
method.
Request message for the
[ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
method.
Response message for the
[ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
method.
Response message for the
[ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
method.
Payload message of raw document content (bytes).
Payload message of raw document content (bytes).
The long-running operation metadata for the
[ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
method.
The long-running operation metadata for the
[ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
method.
Request message for the
[ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
method.
Request message for the
[ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
method.
The priority level of the human review task.
Response message for the
[ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
method.
Response message for the
[ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
method.
Possible states of the review operation.
The long-running operation metadata for the
[SetDefaultProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersion]
method.
The long-running operation metadata for the
[SetDefaultProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersion]
method.
Request message for the
[SetDefaultProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersion]
method.
Request message for the
[SetDefaultProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersion]
method.
Response message for the
[SetDefaultProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersion]
method.
Response message for the
[SetDefaultProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersion]
method.
The metadata that represents a processor version being created.
The metadata that represents a processor version being created.
The dataset validation information.
The dataset validation information.
Request message for the
[TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion]
method.
Request message for the
[TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion]
method.
Options to control the training of the Custom Document Extraction (CDE)
Processor.
Options to control the training of the Custom Document Extraction (CDE)
Processor.
Training Method for CDE.
Options to control foundation model tuning of the processor.
Options to control foundation model tuning of the processor.
The input data used to train a new
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion].
The input data used to train a new
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion].
The response for
[TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion].
The response for
[TrainProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion].
The long-running operation metadata for the
[UndeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion]
method.
The long-running operation metadata for the
[UndeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion]
method.
Request message for the
[UndeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion]
method.
Request message for the
[UndeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion]
method.
Response message for the
[UndeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion]
method.
Response message for the
[UndeployProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion]
method.
A vertex represents a 2D point in the image.
A vertex represents a 2D point in the image.