View Source API Reference google_api_document_ai v0.39.0
Modules
API client metadata for GoogleApi.DocumentAI.V1.
API calls for all endpoints tagged Operations.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.DocumentAI.V1.
Metadata of the auto-labeling documents operation.
The status of individual documents in the auto-labeling process.
The response proto of AutoLabelDocuments method.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
errorDocumentCount(type:integer(), default:nil) - Total number of documents that failed to be deleted in storage. -
individualBatchDeleteStatuses(type:list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus.t), default:nil) - The list of response details of each document. -
totalDocumentCount(type:integer(), default:nil) - Total number of documents deleting from dataset.
The status of each individual document in the batch delete process.
Response of the delete documents operation.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
destDatasetType(type:String.t, default:nil) - The destination dataset split type. -
destSplitType(type:String.t, default:nil) - The destination dataset split type. -
individualBatchMoveStatuses(type:list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus.t), default:nil) - The list of response details of each document.
The status of each individual document in the batch move process.
Response of the batch move documents operation.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
individualBatchUpdateStatuses(type:list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus.t), default:nil) - The list of response details of each document.
The status of each individual document in the batch update process.
Response of the batch update documents operation.
The common metadata for long running operations.
The long-running operation metadata for the CreateLabelerPool method.
The long-running operation metadata for DeleteLabelerPool.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
Identifies a document uniquely within the scope of a dataset in unmanaged option.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
Metadata of the batch export documents operation.
The status of each individual document in the export process.
The statistic representing a dataset split type for this export.
The response proto of ExportDocuments method.
Metadata message associated with the ExportProcessorVersion operation.
Response message associated with the ExportProcessorVersion operation.
Metadata of the import document operation.
The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.
The status of each individual document in the import process.
Response of the import document operation.
The long-running operation metadata for the ImportProcessorVersion method.
The response message for the ImportProcessorVersion method.
The metadata proto of ResyncDataset method.
Resync status against inconsistency types on the dataset level.
Resync status for each document per inconsistency type.
The response proto of ResyncDataset method.
The revision reference specifies which revision on the document to read.
Metadata of the sample documents operation.
Response of the sample documents operation.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
The long-running operation metadata for updating the human review configuration.
The long-running operation metadata for UpdateLabelerPool.
Encodes the detailed information of a barcode.
The common config to specify a set of documents used as input.
The long-running operation metadata for BatchProcessDocuments.
The status of a each individual document in the batch process.
Request message for BatchProcessDocuments.
Response message for BatchProcessDocuments.
A bounding polygon for the detected image annotation.
The common metadata for long running operations.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Request message for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Request message for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
Config that controls the output of documents. All documents will be written as a JSON file.
The configuration used when outputting documents.
The sharding config for the output document.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
A detected token.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
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. Multiple types can also compose a dependency tree to represent nested types.
Defines the a list of enum values.
Defines properties that can be part of the entity type.
Metadata for global schema behavior.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The long-running operation metadata for the EnableProcessor method.
Request message for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Evaluates the given ProcessorVersion against the supplied documents.
Response of the EvaluateProcessorVersion method.
An evaluation of a ProcessorVersion's performance.
Evaluations metrics, at a specific confidence level.
Evaluation counters for the documents that were used.
Evaluation metrics, either in aggregate or about a specific entity.
Metrics across multiple confidence levels.
Gives a short summary of an evaluation, and links to the evaluation itself.
Response message for the FetchProcessorTypes method.
Specifies a document stored on Cloud Storage.
Specifies a set of documents on Cloud Storage.
Specifies all documents on Cloud Storage with a common prefix.
The status of human review on a processed document.
The response from ListEvaluations.
Response message for the ListProcessorTypes method.
Response message for the ListProcessorVersions method.
Response message for the ListProcessors method.
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.
Config for Document OCR.
Hints for OCR Engine
Configurations for premium OCR features.
Options for Process API
A list of individual page numbers.
Request message for the ProcessDocument method.
Response message for the ProcessDocument method.
The first-class citizen for Document AI. Each processor defines how to extract structural information from a 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.
A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.
Contains the alias and the aliased resource name of processor version.
Information about the upcoming deprecation of this processor version.
Payload message of raw document content (bytes).
The long-running operation metadata for the ReviewDocument method.
Request message for the ReviewDocument method.
Response message for the ReviewDocument method.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Request message for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
Request message for the TrainProcessorVersion method.
Options to control the training of the Custom Document Extraction (CDE) Processor.
Options to control foundation model tuning of the processor.
The input data used to train a new ProcessorVersion.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Request message for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Encodes the detailed information of a barcode.
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
A bounding polygon for the detected image annotation.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The Google Cloud Storage location where the output file will be written to.
The Google Cloud Storage location where the input file will be read from.
The desired input location and metadata.
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.
Contains metadata for the BatchProcessDocuments operation.
The desired output location and metadata.
Response to a single document processing request.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Encodes the detailed information of a barcode.
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
A bounding polygon for the detected image annotation.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The Google Cloud Storage location where the output file will be written to.
The Google Cloud Storage location where the input file will be read from.
The desired input location and metadata.
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.
Contains metadata for the BatchProcessDocuments operation.
The desired output location and metadata.
Response to a single document processing request.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
errorDocumentCount(type:integer(), default:nil) - Total number of documents that failed to be deleted in storage. -
individualBatchDeleteStatuses(type:list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus.t), default:nil) - The list of response details of each document. -
totalDocumentCount(type:integer(), default:nil) - Total number of documents deleting from dataset.
The status of each individual document in the batch delete process.
Response of the delete documents operation.
The long-running operation metadata for BatchProcessDocuments.
The status of a each individual document in the batch process.
Response message for BatchProcessDocuments.
The common metadata for long running operations.
A singleton resource under a Processor which configures a collection of documents.
Configuration specific to the Document AI Warehouse-based implementation.
Configuration specific to the Cloud Storage-based implementation.
Configuration specific to spanner-based indexing.
Configuration specific to an unmanaged dataset.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
Identifies a document uniquely within the scope of a dataset in unmanaged option.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
Specifies all documents on Cloud Storage with a common prefix.
The status of human review on a processed document.
Metadata of the import document operation.
The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.
The status of each individual document in the import process.
Response of the import document operation.
The long-running operation metadata for the ImportProcessorVersion method.
The response message for the ImportProcessorVersion method.
The long-running operation metadata for the ReviewDocument method.
Response message for the ReviewDocument method.
The revision reference specifies which revision on the document to read.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
The response message for Locations.ListLocations.
A resource that represents a Google Cloud location.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of java.awt.Color in Java; it can also be trivially provided to UIColor's +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba() string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor fromProto(Color protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color toProto(UIColor color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac 255); var green = Math.floor(greenFrac 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp
Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
Represents an amount of money with its currency type.
Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
Represents a time zone from the IANA Time Zone Database.
API client metadata for GoogleApi.DocumentAI.V1beta2.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.DocumentAI.V1beta2.
Metadata of the auto-labeling documents operation.
The status of individual documents in the auto-labeling process.
The response proto of AutoLabelDocuments method.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
errorDocumentCount(type:integer(), default:nil) - Total number of documents that failed to be deleted in storage. -
individualBatchDeleteStatuses(type:list(GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus.t), default:nil) - The list of response details of each document. -
totalDocumentCount(type:integer(), default:nil) - Total number of documents deleting from dataset.
The status of each individual document in the batch delete process.
Response of the delete documents operation.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
destDatasetType(type:String.t, default:nil) - The destination dataset split type. -
destSplitType(type:String.t, default:nil) - The destination dataset split type. -
individualBatchMoveStatuses(type:list(GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus.t), default:nil) - The list of response details of each document.
The status of each individual document in the batch move process.
Response of the batch move documents operation.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
individualBatchUpdateStatuses(type:list(GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus.t), default:nil) - The list of response details of each document.
The status of each individual document in the batch update process.
Response of the batch update documents operation.
The common metadata for long running operations.
The long-running operation metadata for the CreateLabelerPool method.
The long-running operation metadata for DeleteLabelerPool.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
Identifies a document uniquely within the scope of a dataset in unmanaged option.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
Metadata of the batch export documents operation.
The status of each individual document in the export process.
The statistic representing a dataset split type for this export.
The response proto of ExportDocuments method.
Metadata message associated with the ExportProcessorVersion operation.
Response message associated with the ExportProcessorVersion operation.
Metadata of the import document operation.
The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.
The status of each individual document in the import process.
Response of the import document operation.
The long-running operation metadata for the ImportProcessorVersion method.
The response message for the ImportProcessorVersion method.
The metadata proto of ResyncDataset method.
Resync status against inconsistency types on the dataset level.
Resync status for each document per inconsistency type.
The response proto of ResyncDataset method.
The revision reference specifies which revision on the document to read.
Metadata of the sample documents operation.
Response of the sample documents operation.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
The long-running operation metadata for updating the human review configuration.
The long-running operation metadata for UpdateLabelerPool.
The long-running operation metadata for BatchProcessDocuments.
The status of a each individual document in the batch process.
Response message for BatchProcessDocuments.
The common metadata for long running operations.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
The status of human review on a processed document.
The long-running operation metadata for the ReviewDocument method.
Response message for the ReviewDocument method.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
Encodes the detailed information of a barcode.
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
A bounding polygon for the detected image annotation.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The Google Cloud Storage location where the output file will be written to.
The Google Cloud Storage location where the input file will be read from.
The desired input location and metadata.
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.
Contains metadata for the BatchProcessDocuments operation.
The desired output location and metadata.
Response to a single document processing request.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Parameters to control AutoML model prediction behavior.
Encodes the detailed information of a barcode.
Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
A bounding polygon for the detected image annotation.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
Parameters to control entity extraction behavior.
Parameters to control form extraction behavior.
The Google Cloud Storage location where the output file will be written to.
The Google Cloud Storage location where the input file will be read from.
The desired input location and metadata.
Reserved for future use.
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.
Parameters to control Optical Character Recognition (OCR) behavior.
Contains metadata for the BatchProcessDocuments operation.
The desired output location and metadata.
Request to process one document.
Response to a single document processing request.
A hint for a table bounding box on the page for table parsing.
Parameters to control table extraction behavior.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiV1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
errorDocumentCount(type:integer(), default:nil) - Total number of documents that failed to be deleted in storage. -
individualBatchDeleteStatuses(type:list(GoogleApi.DocumentAI.V1beta2.Model.GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus.t), default:nil) - The list of response details of each document. -
totalDocumentCount(type:integer(), default:nil) - Total number of documents deleting from dataset.
The status of each individual document in the batch delete process.
Response of the delete documents operation.
The long-running operation metadata for BatchProcessDocuments.
The status of a each individual document in the batch process.
Response message for BatchProcessDocuments.
The common metadata for long running operations.
A singleton resource under a Processor which configures a collection of documents.
Configuration specific to the Document AI Warehouse-based implementation.
Configuration specific to the Cloud Storage-based implementation.
Configuration specific to spanner-based indexing.
Configuration specific to an unmanaged dataset.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
Identifies a document uniquely within the scope of a dataset in unmanaged option.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
Specifies all documents on Cloud Storage with a common prefix.
The status of human review on a processed document.
Metadata of the import document operation.
The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.
The status of each individual document in the import process.
Response of the import document operation.
The long-running operation metadata for the ImportProcessorVersion method.
The response message for the ImportProcessorVersion method.
The long-running operation metadata for the ReviewDocument method.
Response message for the ReviewDocument method.
The revision reference specifies which revision on the document to read.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
This resource represents a long-running operation that is the result of a network API call.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of java.awt.Color in Java; it can also be trivially provided to UIColor's +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba() string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor fromProto(Color protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color toProto(UIColor color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac 255); var green = Math.floor(greenFrac 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp
Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
Represents an amount of money with its currency type.
Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
Represents a time zone from the IANA Time Zone Database.
API client metadata for GoogleApi.DocumentAI.V1beta3.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.DocumentAI.V1beta3.
Metadata of the auto-labeling documents operation.
The status of individual documents in the auto-labeling process.
The response proto of AutoLabelDocuments method.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
errorDocumentCount(type:integer(), default:nil) - Total number of documents that failed to be deleted in storage. -
individualBatchDeleteStatuses(type:list(GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus.t), default:nil) - The list of response details of each document. -
totalDocumentCount(type:integer(), default:nil) - Total number of documents deleting from dataset.
The status of each individual document in the batch delete process.
Response of the delete documents operation.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
destDatasetType(type:String.t, default:nil) - The destination dataset split type. -
destSplitType(type:String.t, default:nil) - The destination dataset split type. -
individualBatchMoveStatuses(type:list(GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus.t), default:nil) - The list of response details of each document.
The status of each individual document in the batch move process.
Response of the batch move documents operation.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
individualBatchUpdateStatuses(type:list(GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus.t), default:nil) - The list of response details of each document.
The status of each individual document in the batch update process.
Response of the batch update documents operation.
The common metadata for long running operations.
The long-running operation metadata for the CreateLabelerPool method.
The long-running operation metadata for DeleteLabelerPool.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
Identifies a document uniquely within the scope of a dataset in unmanaged option.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
Metadata of the batch export documents operation.
The status of each individual document in the export process.
The statistic representing a dataset split type for this export.
The response proto of ExportDocuments method.
Metadata message associated with the ExportProcessorVersion operation.
Response message associated with the ExportProcessorVersion operation.
Metadata of the import document operation.
The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.
The status of each individual document in the import process.
Response of the import document operation.
The long-running operation metadata for the ImportProcessorVersion method.
The response message for the ImportProcessorVersion method.
The metadata proto of ResyncDataset method.
Resync status against inconsistency types on the dataset level.
Resync status for each document per inconsistency type.
The response proto of ResyncDataset method.
The revision reference specifies which revision on the document to read.
Metadata of the sample documents operation.
Response of the sample documents operation.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
The long-running operation metadata for updating the human review configuration.
The long-running operation metadata for UpdateLabelerPool.
The long-running operation metadata for BatchProcessDocuments.
The status of a each individual document in the batch process.
Response message for BatchProcessDocuments.
The common metadata for long running operations.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
The long-running operation metadata for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Response of the EvaluateProcessorVersion method.
The status of human review on a processed document.
The long-running operation metadata for the ReviewDocument method.
Response message for the ReviewDocument method.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
Encodes the detailed information of a barcode.
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
A bounding polygon for the detected image annotation.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The Google Cloud Storage location where the output file will be written to.
The Google Cloud Storage location where the input file will be read from.
The desired input location and metadata.
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.
Contains metadata for the BatchProcessDocuments operation.
The desired output location and metadata.
Response to a single document processing request.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Encodes the detailed information of a barcode.
Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
A bounding polygon for the detected image annotation.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The Google Cloud Storage location where the output file will be written to.
The Google Cloud Storage location where the input file will be read from.
The desired input location and metadata.
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.
Contains metadata for the BatchProcessDocuments operation.
The desired output location and metadata.
Response to a single document processing request.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Encodes the detailed information of a barcode.
Dataset documents that the batch operation will be applied to.
List of individual DocumentIds.
Attributes
-
commonMetadata(type:GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3CommonOperationMetadata.t, default:nil) - The basic metadata of the long-running operation. -
errorDocumentCount(type:integer(), default:nil) - Total number of documents that failed to be deleted in storage. -
individualBatchDeleteStatuses(type:list(GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus.t), default:nil) - The list of response details of each document. -
totalDocumentCount(type:integer(), default:nil) - Total number of documents deleting from dataset.
The status of each individual document in the batch delete process.
Attributes
-
datasetDocuments(type:GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3BatchDatasetDocuments.t, default:nil) - Required. Dataset documents input. If givenfilter, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided.
Response of the delete documents operation.
The common config to specify a set of documents used as input.
The long-running operation metadata for BatchProcessDocuments.
The status of a each individual document in the batch process.
Request message for BatchProcessDocuments.
The message for input config in batch process.
The output configuration in the BatchProcessDocuments method.
Response message for BatchProcessDocuments.
A bounding polygon for the detected image annotation.
The common metadata for long running operations.
A singleton resource under a Processor which configures a collection of documents.
Configuration specific to the Document AI Warehouse-based implementation.
Configuration specific to the Cloud Storage-based implementation.
Configuration specific to spanner-based indexing.
Configuration specific to an unmanaged dataset.
The long-running operation metadata for the DeleteProcessor method.
The long-running operation metadata for the DeleteProcessorVersion method.
The long-running operation metadata for the DeployProcessorVersion method.
Request message for the DeployProcessorVersion method.
Response message for the DeployProcessorVersion method.
The long-running operation metadata for the DisableProcessor method.
Request message for the DisableProcessor method.
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
Represents the chunks that the document is divided into.
Represents a chunk.
Represents the page footer associated with the chunk.
Represents the page header associated with the chunk.
Represents where the chunk starts and ends in the document.
Represents the parsed layout of a document as a collection of blocks that the document is divided into.
Represents a block. A block could be one of the various types (text, table, list) supported.
Represents a list type block.
Represents an entry in the list.
Represents where the block starts and ends in the document.
Represents a table type block.
Represents a cell in a table row.
Represents a row in a table.
Represents a text type block.
An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
Parsed and normalized entity value.
Relationship between Entities.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
Identifies a document uniquely within the scope of a dataset in unmanaged option.
Metadata about a document.
Config that controls the output of documents. All documents will be written as a JSON file.
The configuration used when outputting documents.
The sharding config for the output document.
A page in a Document.
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Represents a weak reference to a page element within a document.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
A detected barcode.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
Image quality scores for the page image.
Image Quality Defects
Visual element describing a layout unit on a page.
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
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 detected symbol.
A table representation similar to HTML table structure.
A cell representation inside the table.
A row of table cells.
Detected break at the end of a Token.
Font and other text style attributes.
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
Structure to identify provenance relationships between annotations in different revisions.
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Contains past or forward revisions of this document.
Human Review information of the document.
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. Multiple types can also compose a dependency tree to represent nested types.
Defines the a list of enum values.
Defines properties that can be part of the entity type.
Metadata for global schema behavior.
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Font size with unit.
Text reference indexing into the Document.text.
A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
This message is used for text changes aka. OCR corrections.
The long-running operation metadata for the EnableProcessor method.
Request message for the EnableProcessor method.
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
Metadata about an entity type.
Metadata of the EvaluateProcessorVersion method.
Evaluates the given ProcessorVersion against the supplied documents.
Response of the EvaluateProcessorVersion method.
An evaluation of a ProcessorVersion's performance.
Evaluations metrics, at a specific confidence level.
Evaluation counters for the documents that were used.
Evaluation metrics, either in aggregate or about a specific entity.
Metrics across multiple confidence levels.
Gives a short summary of an evaluation, and links to the evaluation itself.
Response message for the FetchProcessorTypes method.
Metadata for how this field value is extracted.
Specifies a document stored on Cloud Storage.
Specifies a set of documents on Cloud Storage.
Specifies all documents on Cloud Storage with a common prefix.
The status of human review on a processed document.
Metadata of the import document operation.
The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.
The status of each individual document in the import process.
Config for importing documents. Each batch can have its own dataset split type.
The config for auto-split.
Response of the import document operation.
The long-running operation metadata for the ImportProcessorVersion method.
The request message for the ImportProcessorVersion method. The Document AI Service Agent of the destination project must have Document AI Editor role on the source project. The destination project is specified as part of the parent field. The source project is specified as part of the source or external_processor_version_source field.
The external source processor version.
The response message for the ImportProcessorVersion method.
Attributes
-
filter(type:String.t, default:nil) - Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are:SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED-LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED-DisplayName=\"file_name.pdf\"-EntityType=abc/def-TagName=\"auto-labeling-running\"|\"sampled\"Note: - OnlyAND,=and!=are supported. e.g.DisplayName=file_name AND EntityType!=abcIS supported. - Wildcard*is supported only inDisplayNamefilter - No duplicate filter keys are allowed, e.g.EntityType=a AND EntityType=bis NOT supported. - String match is case sensitive (for filterDisplayName&EntityType). -
pageSize(type:integer(), default:nil) - The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100. -
pageToken(type:String.t, default:nil) - A page token, received from a previousListDocumentscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListDocumentsmust match the call that provided the page token. -
returnTotalSize(type:boolean(), default:nil) - Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false. -
skip(type:integer(), default:nil) - Optional. Number of results to skip beginning from thepage_tokenif provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty.
Attributes
-
documentMetadata(type:list(GoogleApi.DocumentAI.V1beta3.Model.GoogleCloudDocumentaiV1beta3DocumentMetadata.t), default:nil) - Document metadata corresponding to the listed documents. -
nextPageToken(type:String.t, default:nil) - A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. -
totalSize(type:integer(), default:nil) - Total count of documents queried.
The response from ListEvaluations.
Response message for the ListProcessorTypes method.
Response message for the ListProcessorVersions method.
Response message for the ListProcessors method.
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.
Config for Document OCR.
Hints for OCR Engine
Configurations for premium OCR features.
Options for Process API
A list of individual page numbers.
Serving config for layout parser processor.
Serving config for chunking.
Request message for the ProcessDocument method.
Response message for the ProcessDocument method.
The first-class citizen for Document AI. Each processor defines how to extract structural information from a 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.
A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.
Contains the alias and the aliased resource name of processor version.
Information about the upcoming deprecation of this processor version.
Metadata about a property.
Payload message of raw document content (bytes).
The long-running operation metadata for the ReviewDocument method.
Request message for the ReviewDocument method.
Response message for the ReviewDocument method.
The revision reference specifies which revision on the document to read.
The long-running operation metadata for the SetDefaultProcessorVersion method.
Request message for the SetDefaultProcessorVersion method.
Response message for the SetDefaultProcessorVersion method.
Metadata for document summarization.
The metadata that represents a processor version being created.
The dataset validation information. This includes any and all errors with documents and the dataset.
Request message for the TrainProcessorVersion method.
Options to control the training of the Custom Document Extraction (CDE) Processor.
Options to control foundation model tuning of the processor.
The input data used to train a new ProcessorVersion.
The response for TrainProcessorVersion.
The long-running operation metadata for the UndeployProcessorVersion method.
Request message for the UndeployProcessorVersion method.
Response message for the UndeployProcessorVersion method.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
The response message for Locations.ListLocations.
A resource that represents a Google Cloud location.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of java.awt.Color in Java; it can also be trivially provided to UIColor's +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba() string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor fromProto(Color protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color toProto(UIColor color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac 255); var green = Math.floor(greenFrac 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp
Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
Represents an amount of money with its currency type.
Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
Represents a time zone from the IANA Time Zone Database.