API Reference google_api_document_ai v0.33.0
Modules
API client metadata for GoogleApi.DocumentAI.V1.
API calls for all endpoints tagged Operations.
API calls for all endpoints tagged Projects.
API calls for all endpoints tagged Uiv1beta3.
Handle Tesla connections for GoogleApi.DocumentAI.V1.
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. -
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.
The common metadata for long running operations.
The long running operation metadata for CreateLabelerPool.
The long running operation metadata for DeleteLabelerPool.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the GCS-based option.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Metadata of the EvaluateProcessorVersion method.
Metadata message associated with the ExportProcessorVersion operation.
Response message associated with the ExportProcessorVersion operation.
Metadata of the import document operation.
The status of each individual document in the import process.
Response of the import document operation.
The revision reference specifies which revision on the document to read.
The long running operation metadata for set default processor version method.
Response message for set default processor version 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 the TrainProcessorVersion method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version method.
The long running operation metadata for updating the human review configuration.
The long running operation metadata for UpdateLabelerPool.
The common config to specify a set of documents used as input.
The long running operation metadata for batch process method.
The status of a each individual document in the batch process.
Request message for batch process document method.
Response message for batch process document method.
A bounding polygon for the detected image annotation.
The common metadata for long running operations.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Request message for the deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Request message for the disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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 long running operation metadata for enable processor method.
Request message for the enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Response message for fetch processor types.
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.
Response message for list processors.
Response message for list processors.
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.
Request message for the process document method.
Response message for the process document 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, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version.
Payload message of raw document content (bytes).
The long running operation metadata for review document method.
Request message for review document method.
Response message for review document method.
The long running operation metadata for set default processor version method.
Request message for the set default processor version method.
Response message for set default processor version method.
The long running operation metadata for the undeploy processor version method.
Request message for the undeploy processor version method.
Response message for the undeploy processor version method.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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.
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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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.
The long running operation metadata for batch process method.
The status of a each individual document in the batch process.
Response message for batch process document method.
The common metadata for long running operations.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
The status of human review on a processed document.
The long running operation metadata for review document method.
Response message for review document method.
The long running operation metadata for set default processor version method.
Response message for set default processor version method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version method.
The response message for Locations.ListLocations.
A resource that represents Google Cloud Platform 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 JSON representation for Empty is empty JSON object {}.
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/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 carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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 value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and 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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. 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 i18n-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.
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. -
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.
The common metadata for long running operations.
The long running operation metadata for CreateLabelerPool.
The long running operation metadata for DeleteLabelerPool.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the GCS-based option.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Metadata of the EvaluateProcessorVersion method.
Metadata message associated with the ExportProcessorVersion operation.
Response message associated with the ExportProcessorVersion operation.
Metadata of the import document operation.
The status of each individual document in the import process.
Response of the import document operation.
The revision reference specifies which revision on the document to read.
The long running operation metadata for set default processor version method.
Response message for set default processor version 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 the TrainProcessorVersion method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version 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 batch process method.
The status of a each individual document in the batch process.
Response message for batch process document method.
The common metadata for long running operations.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
The status of human review on a processed document.
The long running operation metadata for review document method.
Response message for review document method.
The long running operation metadata for set default processor version method.
Response message for set default processor version method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version method.
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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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.
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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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.
The long running operation metadata for batch process method.
The status of a each individual document in the batch process.
Response message for batch process document method.
The common metadata for long running operations.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
The status of human review on a processed document.
The long running operation metadata for review document method.
Response message for review document method.
The long running operation metadata for set default processor version method.
Response message for set default processor version method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version 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 JSON representation for Empty is empty JSON object {}.
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/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 carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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 value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and 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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. 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 i18n-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.
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. -
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.
The common metadata for long running operations.
The long running operation metadata for CreateLabelerPool.
The long running operation metadata for DeleteLabelerPool.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Document Identifier.
Identifies a document uniquely within the scope of a dataset in the GCS-based option.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Metadata of the EvaluateProcessorVersion method.
Metadata of the EvaluateProcessorVersion method.
Metadata message associated with the ExportProcessorVersion operation.
Response message associated with the ExportProcessorVersion operation.
Metadata of the import document operation.
The status of each individual document in the import process.
Response of the import document operation.
The revision reference specifies which revision on the document to read.
The long running operation metadata for set default processor version method.
Response message for set default processor version 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 the TrainProcessorVersion method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version 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 batch process method.
The status of a each individual document in the batch process.
Response message for batch process document method.
The common metadata for long running operations.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
The long running operation metadata for enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
The status of human review on a processed document.
The long running operation metadata for review document method.
Response message for review document method.
The long running operation metadata for set default processor version method.
Response message for set default processor version method.
The long running operation metadata for the undeploy processor version method.
Response message for the undeploy processor version method.
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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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.
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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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.
The common config to specify a set of documents used as input.
The long running operation metadata for batch process method.
The status of a each individual document in the batch process.
Request message for batch process document method.
The message for input config in batch process.
The message for output config in batch process.
Response message for batch process document method.
A bounding polygon for the detected image annotation.
The common metadata for long running operations.
The long running operation metadata for delete processor method.
The long running operation metadata for delete processor version method.
The long running operation metadata for deploy processor version method.
Request message for the deploy processor version method.
Response message for the deploy processor version method.
The long running operation metadata for disable processor method.
Request message for the disable processor method.
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
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.
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.
Detected language for a structural component.
Dimension for the page.
A form field detected on the page.
Rendered image contents for this page.
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 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.
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 long running operation metadata for enable processor method.
Request message for the enable processor method.
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Response message for fetch processor types.
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.
Response message for list processors.
Response message for list processors.
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.
Request message for the process document method.
Response message for the process document 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, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version.
Payload message of raw document content (bytes).
The long running operation metadata for review document method.
Request message for review document method.
Response message for review document method.
The long running operation metadata for set default processor version method.
Request message for the set default processor version method.
Response message for set default processor version method.
The long running operation metadata for the undeploy processor version method.
Request message for the undeploy processor version method.
Response message for the undeploy processor version 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 Google Cloud Platform 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 JSON representation for Empty is empty JSON object {}.
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/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 carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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 value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and 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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. 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 i18n-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.