Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / documentai.v1beta2.json
blob: 997ac84adabaf1959484ff4a6997313eca1a0101 [file] [log] [blame] [edit]
{
"description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.",
"version": "v1beta2",
"documentationLink": "https://cloud.google.com/document-ai/docs/",
"kind": "discovery#restDescription",
"resources": {
"projects": {
"resources": {
"operations": {
"methods": {
"get": {
"flatPath": "v1beta2/projects/{projectsId}/operations/{operationsId}",
"id": "documentai.projects.operations.get",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/{+name}",
"parameters": {
"name": {
"type": "string",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
"pattern": "^projects/[^/]+/operations/[^/]+$"
}
},
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
}
}
},
"locations": {
"resources": {
"operations": {
"methods": {
"get": {
"parameters": {
"name": {
"location": "path",
"description": "The name of the operation resource.",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"path": "v1beta2/{+name}",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"name"
],
"id": "documentai.projects.locations.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
}
}
},
"documents": {
"methods": {
"process": {
"id": "documentai.projects.locations.documents.process",
"path": "v1beta2/{+parent}/documents:process",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/documents:process",
"description": "Processes a single document.",
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest"
},
"parameters": {
"parent": {
"required": true,
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "GoogleCloudDocumentaiV1beta2Document"
}
},
"batchProcess": {
"path": "v1beta2/{+parent}/documents:batchProcess",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"id": "documentai.projects.locations.documents.batchProcess",
"parameters": {
"parent": {
"required": true,
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically."
}
},
"description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.",
"parameterOrder": [
"parent"
],
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/documents:batchProcess",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST"
}
}
}
}
},
"documents": {
"methods": {
"process": {
"parameters": {
"parent": {
"type": "string",
"location": "path",
"required": true,
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.",
"pattern": "^projects/[^/]+$"
}
},
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GoogleCloudDocumentaiV1beta2Document"
},
"path": "v1beta2/{+parent}/documents:process",
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest"
},
"flatPath": "v1beta2/projects/{projectsId}/documents:process",
"httpMethod": "POST",
"id": "documentai.projects.documents.process",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Processes a single document."
},
"batchProcess": {
"id": "documentai.projects.documents.batchProcess",
"description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest"
},
"flatPath": "v1beta2/projects/{projectsId}/documents:batchProcess",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"path": "v1beta2/{+parent}/documents:batchProcess",
"parameters": {
"parent": {
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
}
}
}
}
}
}
},
"canonicalName": "Document",
"basePath": "",
"ownerName": "Google",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"discoveryVersion": "v1",
"version_module": true,
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"schemas": {
"GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue": {
"description": "Parsed and normalized entity value.",
"id": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue",
"properties": {
"text": {
"type": "string",
"description": "Required. Normalized entity value stored as a string. This field is populated for supported document type (e.g. Invoice). For some entity types, one of respective 'structured_value' fields may also be populated. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format."
},
"addressValue": {
"description": "Postal address. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/postal_address.proto",
"$ref": "GoogleTypePostalAddress"
},
"datetimeValue": {
"description": "DateTime value. Includes date, time, and timezone. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/datetime.proto",
"$ref": "GoogleTypeDateTime"
},
"moneyValue": {
"description": "Money value. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/money.proto",
"$ref": "GoogleTypeMoney"
},
"dateValue": {
"$ref": "GoogleTypeDate",
"description": "Date value. Includes year, month, day. See also: https: //github.com/googleapis/googleapis/blob/master/google/type/date.proto"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageImage": {
"description": "Rendered image contents for this page.",
"properties": {
"height": {
"format": "int32",
"description": "Height of the image in pixels.",
"type": "integer"
},
"mimeType": {
"type": "string",
"description": "Encoding mime type for the image."
},
"content": {
"description": "Raw byte content of the image.",
"type": "string",
"format": "byte"
},
"width": {
"type": "integer",
"description": "Width of the image in pixels.",
"format": "int32"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentPageImage",
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus": {
"type": "object",
"description": "The status of a each individual document in the batch process.",
"properties": {
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the processing of the document."
},
"outputGcsDestination": {
"description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"humanReviewOperation": {
"type": "string",
"description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method."
},
"inputGcsSource": {
"description": "The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.",
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus"
},
"GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata": {
"type": "object",
"id": "GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata",
"description": "The metadata that represents a processor version being created.",
"properties": {
"createTime": {
"format": "google-datetime",
"description": "The creation time of the operation.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"type": "string",
"format": "google-datetime"
},
"state": {
"enumDescriptions": [
"The training state is unspecified.",
"The training request has been issued but processing has not yet begun.",
"The service is preparing to execute the training.",
"The training is in progress.",
"The training completed successfully.",
"The training failed. `error` should contain the details of the failure.",
"The training is being cancelled. `error` should describe the reason for the cancellation.",
"The training has been cancelled. `error` should describe the reason for the cancellation."
],
"description": "The state of the current disable processor operation.",
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"QUEUED",
"PREPARING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLING",
"CANCELLED"
]
}
}
},
"GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue": {
"properties": {
"dateValue": {
"$ref": "GoogleTypeDate",
"description": "Date value. Includes year, month, day. See also: https: //github.com/googleapis/googleapis/blob/master/google/type/date.proto"
},
"moneyValue": {
"$ref": "GoogleTypeMoney",
"description": "Money value. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/money.proto"
},
"addressValue": {
"$ref": "GoogleTypePostalAddress",
"description": "Postal address. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/postal_address.proto"
},
"text": {
"description": "Required. Normalized entity value stored as a string. This field is populated for supported document type (e.g. Invoice). For some entity types, one of respective 'structured_value' fields may also be populated. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.",
"type": "string"
},
"datetimeValue": {
"description": "DateTime value. Includes date, time, and timezone. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/datetime.proto",
"$ref": "GoogleTypeDateTime"
}
},
"description": "Parsed and normalized entity value.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue"
},
"GoogleCloudDocumentaiV1beta1DocumentTextChange": {
"description": "This message is used for text changes aka. OCR corrections.",
"properties": {
"provenance": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance"
},
"description": "The history of this annotation."
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index."
},
"changedText": {
"type": "string",
"description": "The text that replaces the text identified in the `text_anchor`."
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentTextChange",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentShardInfo": {
"id": "GoogleCloudDocumentaiV1beta2DocumentShardInfo",
"type": "object",
"description": "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.",
"properties": {
"textOffset": {
"type": "string",
"format": "int64",
"description": "The index of the first character in Document.text in the overall document global text."
},
"shardIndex": {
"format": "int64",
"type": "string",
"description": "The 0-based index of this shard."
},
"shardCount": {
"type": "string",
"description": "Total number of shards.",
"format": "int64"
}
}
},
"GoogleLongrunningOperation": {
"id": "GoogleLongrunningOperation",
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "GoogleRpcStatus"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"metadata": {
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object"
},
"response": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object",
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`."
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentPageLine": {
"description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
"type": "object",
"properties": {
"provenance": {
"description": "The history of this annotation.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance"
},
"detectedLanguages": {
"type": "array",
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
}
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Line."
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageLine"
},
"GoogleCloudDocumentaiV1beta2EntityExtractionParams": {
"description": "Parameters to control entity extraction behavior.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable entity extraction."
},
"modelVersion": {
"description": "Model version of the entity extraction. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model.",
"type": "string"
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2EntityExtractionParams"
},
"GoogleCloudDocumentaiV1beta2OcrParams": {
"id": "GoogleCloudDocumentaiV1beta2OcrParams",
"type": "object",
"description": "Parameters to control Optical Character Recognition (OCR) behavior.",
"properties": {
"languageHints": {
"description": "List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Document processing returns an error if one or more of the specified languages is not one of the supported languages.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow": {
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow",
"type": "object",
"properties": {
"cells": {
"description": "Cells that make up this row.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell"
}
}
},
"description": "A row of table cells."
},
"GoogleCloudDocumentaiV1beta1GcsDestination": {
"type": "object",
"properties": {
"uri": {
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta1GcsDestination",
"description": "The Google Cloud Storage location where the output file will be written to."
},
"GoogleCloudDocumentaiV1beta2DocumentPageTable": {
"properties": {
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Table."
},
"bodyRows": {
"description": "Body rows of the table.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow"
}
},
"detectedLanguages": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"description": "A list of detected languages together with confidence."
},
"headerRows": {
"description": "Header rows of the table.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow"
}
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTable",
"description": "A table representation similar to HTML table structure.",
"type": "object"
},
"GoogleCloudDocumentaiV1beta1ProcessDocumentResponse": {
"description": "Response to a single document processing request.",
"properties": {
"outputConfig": {
"description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects.",
"$ref": "GoogleCloudDocumentaiV1beta1OutputConfig"
},
"inputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta1InputConfig",
"description": "Information about the input file. This is the same as the corresponding input config in the request."
}
},
"id": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse",
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": {
"type": "object",
"properties": {},
"description": "Response message for the enable processor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse"
},
"GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": {
"description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"type": "object",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for VisualElement."
},
"type": {
"type": "string",
"description": "Type of the VisualElement."
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement"
},
"GoogleCloudDocumentaiV1beta2AutoMlParams": {
"properties": {
"model": {
"type": "string",
"description": "Resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`."
}
},
"id": "GoogleCloudDocumentaiV1beta2AutoMlParams",
"type": "object",
"description": "Parameters to control AutoML model prediction behavior."
},
"GoogleCloudDocumentaiV1beta1DocumentPageBlock": {
"id": "GoogleCloudDocumentaiV1beta1DocumentPageBlock",
"description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"type": "object",
"properties": {
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "The history of this annotation."
},
"detectedLanguages": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"description": "A list of detected languages together with confidence."
},
"layout": {
"description": "Layout for Block.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout"
}
}
},
"GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell": {
"properties": {
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
},
"colSpan": {
"type": "integer",
"format": "int32",
"description": "How many columns this cell spans."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for TableCell."
},
"detectedLanguages": {
"type": "array",
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
}
}
},
"description": "A cell representation inside the table.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell"
},
"GoogleTypeTimeZone": {
"type": "object",
"id": "GoogleTypeTimeZone",
"properties": {
"id": {
"type": "string",
"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\"."
},
"version": {
"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".",
"type": "string"
}
},
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones)."
},
"GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak",
"description": "Detected break at the end of a Token.",
"properties": {
"type": {
"description": "Detected break type.",
"type": "string",
"enumDescriptions": [
"Unspecified break type.",
"A single whitespace.",
"A wider whitespace.",
"A hyphen that indicates that a token has been split across lines."
],
"enum": [
"TYPE_UNSPECIFIED",
"SPACE",
"WIDE_SPACE",
"HYPHEN"
]
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentTextChange": {
"description": "This message is used for text changes aka. OCR corrections.",
"id": "GoogleCloudDocumentaiV1beta2DocumentTextChange",
"type": "object",
"properties": {
"changedText": {
"type": "string",
"description": "The text that replaces the text identified in the `text_anchor`."
},
"textAnchor": {
"description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor"
},
"provenance": {
"description": "The history of this annotation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance"
},
"type": "array"
}
}
},
"GoogleCloudDocumentaiV1beta1InputConfig": {
"description": "The desired input location and metadata.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1InputConfig",
"properties": {
"mimeType": {
"description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.",
"type": "string"
},
"gcsSource": {
"description": "The Google Cloud Storage location to read the input from. This must be a single file.",
"$ref": "GoogleCloudDocumentaiV1beta1GcsSource"
}
}
},
"GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse": {
"description": "Response message for the disable processor method. Intentionally empty proto for adding fields in future.",
"type": "object",
"id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse",
"properties": {}
},
"GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": {
"description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id of the parent provenance."
},
"revision": {
"description": "The index of the [Document.revisions] identifying the parent revision.",
"type": "integer",
"format": "int32"
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent"
},
"GoogleCloudDocumentaiV1beta2DocumentEntity": {
"description": "A phrase in the text that is a known entity type, such as a person, an organization, or location.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentEntity",
"properties": {
"id": {
"type": "string",
"description": "Optional. Canonical id. This will be a unique value in the entity list for this document."
},
"properties": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity"
},
"description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document."
},
"mentionText": {
"description": "Text value in the document e.g. `1600 Amphitheatre Pkwy`.",
"type": "string"
},
"redacted": {
"description": "Optional. Whether the entity will be redacted for de-identification purposes.",
"type": "boolean"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"description": "Optional. The history of this annotation."
},
"type": {
"description": "Entity type from a schema e.g. `Address`.",
"type": "string"
},
"pageAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor",
"description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
},
"confidence": {
"description": "Optional. Confidence of detected Schema entity. Range [0, 1].",
"format": "float",
"type": "number"
},
"normalizedValue": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue",
"description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types."
},
"mentionId": {
"description": "Deprecated. Use `id` field instead.",
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
"description": "Provenance of the entity. Text anchor indexing into the Document.text."
}
}
},
"GoogleCloudDocumentaiV1beta2ProcessDocumentRequest": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest",
"properties": {
"formExtractionParams": {
"$ref": "GoogleCloudDocumentaiV1beta2FormExtractionParams",
"description": "Controls form extraction behavior. If not specified, the system will decide reasonable defaults."
},
"documentType": {
"description": "Specifies a known document type for deeper structure detection. Valid values are currently \"general\" and \"invoice\". If not provided, \"general\"\\ is used as default. If any other value is given, the request is rejected.",
"type": "string"
},
"inputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2InputConfig",
"description": "Required. Information about the input file."
},
"entityExtractionParams": {
"description": "Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.",
"$ref": "GoogleCloudDocumentaiV1beta2EntityExtractionParams"
},
"ocrParams": {
"description": "Controls OCR behavior. If not specified, the system will decide reasonable defaults.",
"$ref": "GoogleCloudDocumentaiV1beta2OcrParams"
},
"outputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2OutputConfig",
"description": "The desired output location. This field is only needed in BatchProcessDocumentsRequest."
},
"tableExtractionParams": {
"$ref": "GoogleCloudDocumentaiV1beta2TableExtractionParams",
"description": "Controls table extraction behavior. If not specified, the system will decide reasonable defaults."
},
"automlParams": {
"description": "Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.",
"$ref": "GoogleCloudDocumentaiV1beta2AutoMlParams"
},
"parent": {
"type": "string",
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method."
}
},
"description": "Request to process one document."
},
"GoogleCloudDocumentaiV1beta1DocumentRevision": {
"properties": {
"humanReview": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview",
"description": "Human Review information of this revision."
},
"createTime": {
"format": "google-datetime",
"description": "The time that the revision was created.",
"type": "string"
},
"id": {
"type": "string",
"description": "Id of the revision. Unique within the context of the document."
},
"agent": {
"description": "If the change was made by a person specify the name or id of that person.",
"type": "string"
},
"processor": {
"type": "string",
"description": "If the annotation was made by processor identify the processor by its resource name."
},
"parent": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field."
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentRevision",
"description": "Contains past or forward revisions of this document."
},
"GoogleRpcStatus": {
"id": "GoogleRpcStatus",
"type": "object",
"description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors).",
"properties": {
"message": {
"type": "string",
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."
},
"details": {
"items": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
},
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array"
},
"code": {
"type": "integer",
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code."
}
}
},
"GoogleCloudDocumentaiV1beta1DocumentPage": {
"type": "object",
"properties": {
"blocks": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageBlock"
},
"description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation."
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
}
},
"image": {
"description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImage"
},
"paragraphs": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph"
},
"description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.",
"type": "array"
},
"visualElements": {
"description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement"
},
"type": "array"
},
"transforms": {
"description": "Transformation matrices that were applied to the original document image to produce Page.image.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix"
}
},
"pageNumber": {
"format": "int32",
"type": "integer",
"description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing."
},
"tokens": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageToken"
},
"type": "array",
"description": "A list of visually detected tokens on the page."
},
"lines": {
"description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLine"
},
"type": "array"
},
"formFields": {
"description": "A list of visually detected form fields on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageFormField"
},
"type": "array"
},
"tables": {
"description": "A list of visually detected tables on the page.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTable"
}
},
"dimension": {
"description": "Physical dimension of the page.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDimension"
},
"layout": {
"description": "Layout for the page.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentPage",
"description": "A page in a Document."
},
"GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment": {
"properties": {
"startIndex": {
"type": "string",
"format": "int64",
"description": "TextSegment start UTF-8 char index in the Document.text."
},
"endIndex": {
"description": "TextSegment half open end UTF-8 char index in the Document.text.",
"type": "string",
"format": "int64"
}
},
"description": "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",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak": {
"properties": {
"type": {
"description": "Detected break type.",
"enum": [
"TYPE_UNSPECIFIED",
"SPACE",
"WIDE_SPACE",
"HYPHEN"
],
"type": "string",
"enumDescriptions": [
"Unspecified break type.",
"A single whitespace.",
"A wider whitespace.",
"A hyphen that indicates that a token has been split across lines."
]
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak",
"description": "Detected break at the end of a Token.",
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageMatrix": {
"description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix",
"properties": {
"rows": {
"type": "integer",
"description": "Number of rows in the matrix.",
"format": "int32"
},
"data": {
"description": "The matrix data.",
"type": "string",
"format": "byte"
},
"cols": {
"type": "integer",
"description": "Number of columns in the matrix.",
"format": "int32"
},
"type": {
"type": "integer",
"format": "int32",
"description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentEntityRelation": {
"type": "object",
"description": "Relationship between Entities.",
"properties": {
"objectId": {
"description": "Object entity id.",
"type": "string"
},
"relation": {
"description": "Relationship description.",
"type": "string"
},
"subjectId": {
"description": "Subject entity id.",
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation"
},
"GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest": {
"id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest",
"type": "object",
"description": "Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.",
"properties": {
"requests": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest"
},
"type": "array",
"description": "Required. Individual requests for each document."
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentStyleFontSize": {
"id": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize",
"properties": {
"size": {
"type": "number",
"description": "Font size for the text.",
"format": "float"
},
"unit": {
"description": "Unit for the font size. Follows CSS naming (in, px, pt, etc.).",
"type": "string"
}
},
"type": "object",
"description": "Font size with unit."
},
"GoogleCloudDocumentaiV1beta2DocumentPageFormField": {
"properties": {
"valueDetectedLanguages": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array",
"description": "A list of detected languages for value together with confidence."
},
"nameDetectedLanguages": {
"description": "A list of detected languages for name together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"valueType": {
"description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"",
"type": "string"
},
"fieldValue": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for the FormField value."
},
"fieldName": {
"description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout"
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageFormField",
"description": "A form field detected on the page.",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell",
"description": "A cell representation inside the table.",
"properties": {
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"layout": {
"description": "Layout for TableCell.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout"
},
"rowSpan": {
"type": "integer",
"description": "How many rows this cell spans.",
"format": "int32"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
}
}
},
"GoogleCloudDocumentaiV1beta2GcsDestination": {
"type": "object",
"properties": {
"uri": {
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta2GcsDestination",
"description": "The Google Cloud Storage location where the output file will be written to."
},
"GoogleTypeMoney": {
"properties": {
"units": {
"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"type": "string",
"format": "int64"
},
"nanos": {
"type": "integer",
"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"format": "int32"
},
"currencyCode": {
"type": "string",
"description": "The 3-letter currency code defined in ISO 4217."
}
},
"id": "GoogleTypeMoney",
"type": "object",
"description": "Represents an amount of money with its currency type."
},
"GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata",
"type": "object",
"description": "The long running operation metadata for CreateLabelerPool.",
"properties": {
"updateTime": {
"format": "google-datetime",
"description": "The last update time of the operation.",
"type": "string"
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
},
"state": {
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description": "Used only when Operation.done is false.",
"type": "string"
},
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
}
}
},
"GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata",
"type": "object",
"properties": {
"updateTime": {
"format": "google-datetime",
"type": "string",
"description": "The last update time of the operation."
},
"state": {
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string",
"description": "Used only when Operation.done is false.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
]
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
},
"createTime": {
"format": "google-datetime",
"description": "The creation time of the operation.",
"type": "string"
}
},
"description": "The long running operation metadata for UpdateLabelerPool."
},
"GoogleCloudDocumentaiV1beta1DocumentPageFormField": {
"properties": {
"valueDetectedLanguages": {
"description": "A list of detected languages for value together with confidence.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
}
},
"nameDetectedLanguages": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array",
"description": "A list of detected languages for name together with confidence."
},
"fieldValue": {
"description": "Layout for the FormField value.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout"
},
"fieldName": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc."
},
"valueType": {
"type": "string",
"description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\""
}
},
"type": "object",
"description": "A form field detected on the page.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageFormField"
},
"GoogleCloudDocumentaiV1beta2FormExtractionParams": {
"properties": {
"enabled": {
"description": "Whether to enable form extraction.",
"type": "boolean"
},
"modelVersion": {
"description": "Model version of the form extraction system. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model. For custom form models, specify: “custom/{model_name}\". Model name format is \"bucket_name/path/to/modeldir\" corresponding to \"gs://bucket_name/path/to/modeldir\" where annotated examples are stored.",
"type": "string"
},
"keyValuePairHints": {
"description": "Reserved for future use.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2KeyValuePairHint"
},
"type": "array"
}
},
"description": "Parameters to control form extraction behavior.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2FormExtractionParams"
},
"GoogleCloudDocumentaiV1beta2DocumentPageMatrix": {
"id": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix",
"description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
"properties": {
"rows": {
"format": "int32",
"type": "integer",
"description": "Number of rows in the matrix."
},
"type": {
"description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html",
"type": "integer",
"format": "int32"
},
"data": {
"description": "The matrix data.",
"format": "byte",
"type": "string"
},
"cols": {
"type": "integer",
"format": "int32",
"description": "Number of columns in the matrix."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentTextAnchor": {
"description": "Text reference indexing into the Document.text.",
"properties": {
"content": {
"description": "Contains the content of the text span so that users do not have to look it up in the text_segments.",
"type": "string"
},
"textSegments": {
"description": "The text segments from the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment"
},
"type": "array"
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor"
},
"GoogleCloudDocumentaiV1beta2OperationMetadata": {
"id": "GoogleCloudDocumentaiV1beta2OperationMetadata",
"type": "object",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"type": "string",
"format": "google-datetime"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"state": {
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request is received.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"ACCEPTED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLED",
"FAILED"
],
"type": "string"
}
},
"description": "Contains metadata for the BatchProcessDocuments operation."
},
"GoogleCloudDocumentaiV1beta2OutputConfig": {
"id": "GoogleCloudDocumentaiV1beta2OutputConfig",
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudDocumentaiV1beta2GcsDestination",
"description": "The Google Cloud Storage location to write the output to."
},
"pagesPerShard": {
"description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json",
"type": "integer",
"format": "int32"
}
},
"type": "object",
"description": "The desired output location and metadata."
},
"GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": {
"id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse",
"description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.",
"properties": {
"responses": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse"
},
"type": "array",
"description": "Responses for each individual document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageAnchor": {
"properties": {
"pageRefs": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef"
},
"description": "One or more references to visual page elements"
}
},
"description": "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.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor"
},
"GoogleCloudDocumentaiV1beta2DocumentPageParagraph": {
"type": "object",
"description": "A collection of lines that a human would perceive as a paragraph.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph",
"properties": {
"layout": {
"description": "Layout for Paragraph.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"description": "The history of this annotation."
},
"detectedLanguages": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"description": "A list of detected languages together with confidence.",
"type": "array"
}
}
},
"GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": {
"type": "object",
"description": "The long running operation metadata for review document method.",
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata",
"properties": {
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
},
"updateTime": {
"description": "The last update time of the operation.",
"type": "string",
"format": "google-datetime"
},
"createTime": {
"description": "The creation time of the operation.",
"type": "string",
"format": "google-datetime"
},
"state": {
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"description": "Used only when Operation.done is false.",
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
]
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentPageBlock": {
"id": "GoogleCloudDocumentaiV1beta2DocumentPageBlock",
"type": "object",
"properties": {
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"description": "The history of this annotation."
},
"detectedLanguages": {
"type": "array",
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
}
},
"layout": {
"description": "Layout for Block.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout"
}
},
"description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation."
},
"GoogleCloudDocumentaiV1beta1OutputConfig": {
"description": "The desired output location and metadata.",
"id": "GoogleCloudDocumentaiV1beta1OutputConfig",
"properties": {
"pagesPerShard": {
"format": "int32",
"description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json",
"type": "integer"
},
"gcsDestination": {
"description": "The Google Cloud Storage location to write the output to.",
"$ref": "GoogleCloudDocumentaiV1beta1GcsDestination"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "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 `{}`.",
"properties": {},
"type": "object",
"id": "GoogleProtobufEmpty"
},
"GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef": {
"properties": {
"boundingPoly": {
"description": "Optional. Identifies the bounding polygon of a layout element on the page.",
"$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly"
},
"layoutId": {
"description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
"type": "string"
},
"page": {
"description": "Required. Index into the Document.pages element",
"format": "int64",
"type": "string"
},
"layoutType": {
"enumDescriptions": [
"Layout Unspecified.",
"References a Page.blocks element.",
"References a Page.paragraphs element.",
"References a Page.lines element.",
"References a Page.tokens element.",
"References a Page.visual_elements element.",
"Refrrences a Page.tables element.",
"References a Page.form_fields element."
],
"type": "string",
"description": "Optional. The type of the layout element that is being referenced if any.",
"enum": [
"LAYOUT_TYPE_UNSPECIFIED",
"BLOCK",
"PARAGRAPH",
"LINE",
"TOKEN",
"VISUAL_ELEMENT",
"TABLE",
"FORM_FIELD"
]
}
},
"description": "Represents a weak reference to a page element within a document.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef"
},
"GoogleTypeDateTime": {
"description": "Represents 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 is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
"properties": {
"hours": {
"description": "Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"timeZone": {
"$ref": "GoogleTypeTimeZone",
"description": "Time zone."
},
"day": {
"description": "Required. Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer",
"format": "int32"
},
"seconds": {
"description": "Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
"type": "integer",
"format": "int32"
},
"nanos": {
"description": "Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Required. Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
"type": "integer"
},
"year": {
"type": "integer",
"format": "int32",
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year."
},
"month": {
"format": "int32",
"type": "integer",
"description": "Required. Month of year. Must be from 1 to 12."
},
"utcOffset": {
"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
"type": "string",
"format": "google-duration"
}
},
"type": "object",
"id": "GoogleTypeDateTime"
},
"GoogleCloudDocumentaiV1beta1Vertex": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1Vertex",
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
"properties": {
"x": {
"format": "int32",
"description": "X coordinate.",
"type": "integer"
},
"y": {
"format": "int32",
"description": "Y coordinate.",
"type": "integer"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentProvenance": {
"type": "object",
"properties": {
"type": {
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"ADD",
"REMOVE",
"REPLACE",
"EVAL_REQUESTED",
"EVAL_APPROVED"
],
"type": "string",
"description": "The type of provenance operation.",
"enumDescriptions": [
"Operation type unspecified.",
"Add an element. Implicit if no `parents` are set for the provenance.",
"The element is removed. No `parents` should be set.",
"Explicitly replaces the element(s) identified by `parents`.",
"Element is requested for human review.",
"Element is review and approved at human review, confidence will be set to 1.0"
]
},
"revision": {
"format": "int32",
"description": "The index of the revision that produced this element.",
"type": "integer"
},
"id": {
"type": "integer",
"format": "int32",
"description": "The Id of this operation. Needs to be unique within the scope of the revision."
},
"parents": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent"
},
"description": "References to the original elements that are replaced.",
"type": "array"
}
},
"description": "Structure to identify provenance relationships between annotations in different revisions.",
"id": "GoogleCloudDocumentaiV1beta2DocumentProvenance"
},
"GoogleCloudDocumentaiV1beta2Document": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2Document",
"description": "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.",
"properties": {
"revisions": {
"type": "array",
"description": "Revision history of this document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentRevision"
}
},
"entityRelations": {
"description": "Relationship among Document.entities.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation"
},
"type": "array"
},
"text": {
"description": "UTF-8 encoded text in reading order from the document.",
"type": "string"
},
"uri": {
"description": "Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.",
"type": "string"
},
"content": {
"type": "string",
"description": "Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.",
"format": "byte"
},
"textStyles": {
"type": "array",
"description": "Styles for the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle"
}
},
"shardInfo": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentShardInfo",
"description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified."
},
"pages": {
"description": "Visual page layout for the Document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPage"
},
"type": "array"
},
"translations": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTranslation"
},
"type": "array",
"description": "A list of translations on Document.text. For document shards, translations in this list may cross shard boundaries."
},
"textChanges": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextChange"
},
"description": "A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.",
"type": "array"
},
"entities": {
"description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity"
}
},
"mimeType": {
"description": "An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.",
"type": "string"
},
"labels": {
"description": "Labels for this document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentLabel"
},
"type": "array"
},
"error": {
"description": "Any error that occurred while processing this document.",
"$ref": "GoogleRpcStatus"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentTranslation": {
"id": "GoogleCloudDocumentaiV1beta2DocumentTranslation",
"type": "object",
"properties": {
"textAnchor": {
"description": "Provenance of the translation. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor"
},
"provenance": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance"
},
"description": "The history of this annotation."
},
"translatedText": {
"description": "Text translated into the target language.",
"type": "string"
},
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
}
},
"description": "A translation of the text segment."
},
"GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": {
"type": "object",
"properties": {
"responses": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse"
},
"description": "Responses for each individual document.",
"type": "array"
}
},
"description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.",
"id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse"
},
"GoogleCloudDocumentaiV1beta1DocumentPageToken": {
"id": "GoogleCloudDocumentaiV1beta1DocumentPageToken",
"type": "object",
"properties": {
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Token."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "The history of this annotation."
},
"detectedLanguages": {
"type": "array",
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
}
},
"detectedBreak": {
"description": "Detected break at the end of a Token.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak"
}
},
"description": "A detected token."
},
"GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview": {
"properties": {
"state": {
"description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.",
"type": "string"
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`."
}
},
"description": "Human Review information of the document.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview"
},
"GoogleCloudDocumentaiV1beta1DocumentProvenance": {
"properties": {
"revision": {
"format": "int32",
"type": "integer",
"description": "The index of the revision that produced this element."
},
"type": {
"description": "The type of provenance operation.",
"type": "string",
"enumDescriptions": [
"Operation type unspecified.",
"Add an element. Implicit if no `parents` are set for the provenance.",
"The element is removed. No `parents` should be set.",
"Explicitly replaces the element(s) identified by `parents`.",
"Element is requested for human review.",
"Element is review and approved at human review, confidence will be set to 1.0"
],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"ADD",
"REMOVE",
"REPLACE",
"EVAL_REQUESTED",
"EVAL_APPROVED"
]
},
"id": {
"format": "int32",
"type": "integer",
"description": "The Id of this operation. Needs to be unique within the scope of the revision."
},
"parents": {
"description": "References to the original elements that are replaced.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent"
},
"type": "array"
}
},
"description": "Structure to identify provenance relationships between annotations in different revisions.",
"id": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": {
"id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent",
"properties": {
"revision": {
"format": "int32",
"description": "The index of the [Document.revisions] identifying the parent revision.",
"type": "integer"
},
"id": {
"description": "The id of the parent provenance.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced."
},
"GoogleCloudDocumentaiV1beta2Vertex": {
"properties": {
"y": {
"description": "Y coordinate.",
"format": "int32",
"type": "integer"
},
"x": {
"format": "int32",
"description": "X coordinate.",
"type": "integer"
}
},
"id": "GoogleCloudDocumentaiV1beta2Vertex",
"type": "object",
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image."
},
"GoogleCloudDocumentaiV1beta1DocumentStyleFontSize": {
"description": "Font size with unit.",
"properties": {
"unit": {
"description": "Unit for the font size. Follows CSS naming (in, px, pt, etc.).",
"type": "string"
},
"size": {
"format": "float",
"description": "Font size for the text.",
"type": "number"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2KeyValuePairHint": {
"description": "Reserved for future use.",
"id": "GoogleCloudDocumentaiV1beta2KeyValuePairHint",
"type": "object",
"properties": {
"valueTypes": {
"items": {
"type": "string"
},
"description": "Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.",
"type": "array"
},
"key": {
"description": "The key text for the hint.",
"type": "string"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentPageDimension": {
"description": "Dimension for the page.",
"properties": {
"height": {
"description": "Page height.",
"format": "float",
"type": "number"
},
"width": {
"type": "number",
"format": "float",
"description": "Page width."
},
"unit": {
"description": "Dimension unit.",
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageDimension",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPage": {
"properties": {
"lines": {
"description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLine"
}
},
"detectedLanguages": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array",
"description": "A list of detected languages together with confidence."
},
"tokens": {
"description": "A list of visually detected tokens on the page.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageToken"
}
},
"formFields": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageFormField"
},
"type": "array",
"description": "A list of visually detected form fields on the page."
},
"dimension": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDimension",
"description": "Physical dimension of the page."
},
"image": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImage",
"description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned."
},
"pageNumber": {
"format": "int32",
"description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.",
"type": "integer"
},
"blocks": {
"type": "array",
"description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageBlock"
}
},
"transforms": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix"
},
"description": "Transformation matrices that were applied to the original document image to produce Page.image.",
"type": "array"
},
"layout": {
"description": "Layout for the page.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout"
},
"tables": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTable"
},
"description": "A list of visually detected tables on the page."
},
"visualElements": {
"type": "array",
"description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement"
}
},
"paragraphs": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph"
},
"type": "array",
"description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph."
}
},
"description": "A page in a Document.",
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentPage"
},
"GoogleCloudDocumentaiV1beta1DocumentPageDimension": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageDimension",
"properties": {
"unit": {
"description": "Dimension unit.",
"type": "string"
},
"width": {
"type": "number",
"format": "float",
"description": "Page width."
},
"height": {
"description": "Page height.",
"type": "number",
"format": "float"
}
},
"description": "Dimension for the page."
},
"GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment": {
"id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment",
"type": "object",
"description": "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",
"properties": {
"startIndex": {
"type": "string",
"description": "TextSegment start UTF-8 char index in the Document.text.",
"format": "int64"
},
"endIndex": {
"format": "int64",
"description": "TextSegment half open end UTF-8 char index in the Document.text.",
"type": "string"
}
}
},
"GoogleTypePostalAddress": {
"properties": {
"sortingCode": {
"type": "string",
"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire)."
},
"locality": {
"description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
"type": "string"
},
"addressLines": {
"items": {
"type": "string"
},
"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
"type": "array"
},
"revision": {
"format": "int32",
"description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.",
"type": "integer"
},
"organization": {
"type": "string",
"description": "Optional. The name of the organization at the address."
},
"regionCode": {
"type": "string",
"description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland."
},
"recipients": {
"items": {
"type": "string"
},
"description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.",
"type": "array"
},
"administrativeArea": {
"type": "string",
"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated."
},
"sublocality": {
"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
"type": "string"
},
"languageCode": {
"description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".",
"type": "string"
},
"postalCode": {
"type": "string",
"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.)."
}
},
"id": "GoogleTypePostalAddress",
"description": "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",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2GcsSource": {
"type": "object",
"properties": {
"uri": {
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta2GcsSource",
"description": "The Google Cloud Storage location where the input file will be read from."
},
"GoogleCloudDocumentaiV1beta1Document": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1Document",
"type": "object",
"properties": {
"content": {
"description": "Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.",
"type": "string",
"format": "byte"
},
"entityRelations": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation"
},
"type": "array",
"description": "Relationship among Document.entities."
},
"text": {
"type": "string",
"description": "UTF-8 encoded text in reading order from the document."
},
"revisions": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentRevision"
},
"description": "Revision history of this document."
},
"pages": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPage"
},
"description": "Visual page layout for the Document."
},
"shardInfo": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentShardInfo",
"description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified."
},
"uri": {
"description": "Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.",
"type": "string"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Any error that occurred while processing this document."
},
"textStyles": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle"
},
"type": "array",
"description": "Styles for the Document.text."
},
"translations": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTranslation"
},
"description": "A list of translations on Document.text. For document shards, translations in this list may cross shard boundaries.",
"type": "array"
},
"textChanges": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextChange"
},
"description": "A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other."
},
"mimeType": {
"type": "string",
"description": "An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml."
},
"entities": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity"
},
"type": "array",
"description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries."
}
}
},
"GoogleCloudDocumentaiV1beta2ProcessDocumentResponse": {
"id": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse",
"description": "Response to a single document processing request.",
"properties": {
"inputConfig": {
"description": "Information about the input file. This is the same as the corresponding input config in the request.",
"$ref": "GoogleCloudDocumentaiV1beta2InputConfig"
},
"outputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2OutputConfig",
"description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow": {
"properties": {
"cells": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell"
},
"type": "array",
"description": "Cells that make up this row."
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow",
"description": "A row of table cells."
},
"GoogleCloudDocumentaiV1beta1DocumentPageTable": {
"type": "object",
"properties": {
"bodyRows": {
"type": "array",
"description": "Body rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow"
}
},
"headerRows": {
"type": "array",
"description": "Header rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow"
}
},
"detectedLanguages": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"description": "A list of detected languages together with confidence."
},
"layout": {
"description": "Layout for Table.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTable",
"description": "A table representation similar to HTML table structure."
},
"GoogleCloudDocumentaiV1beta1DocumentShardInfo": {
"properties": {
"textOffset": {
"format": "int64",
"description": "The index of the first character in Document.text in the overall document global text.",
"type": "string"
},
"shardIndex": {
"type": "string",
"description": "The 0-based index of this shard.",
"format": "int64"
},
"shardCount": {
"type": "string",
"description": "Total number of shards.",
"format": "int64"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentShardInfo",
"type": "object",
"description": "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."
},
"GoogleCloudDocumentaiV1beta2NormalizedVertex": {
"description": "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.",
"properties": {
"y": {
"type": "number",
"description": "Y coordinate.",
"format": "float"
},
"x": {
"description": "X coordinate.",
"type": "number",
"format": "float"
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2NormalizedVertex"
},
"GoogleCloudDocumentaiV1beta1NormalizedVertex": {
"description": "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.",
"properties": {
"y": {
"description": "Y coordinate.",
"type": "number",
"format": "float"
},
"x": {
"description": "X coordinate.",
"type": "number",
"format": "float"
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1NormalizedVertex"
},
"GoogleCloudDocumentaiV1beta1OperationMetadata": {
"description": "Contains metadata for the BatchProcessDocuments operation.",
"type": "object",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing."
},
"state": {
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request is received.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"enum": [
"STATE_UNSPECIFIED",
"ACCEPTED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLED",
"FAILED"
],
"description": "The state of the current batch processing.",
"type": "string"
},
"updateTime": {
"format": "google-datetime",
"description": "The last update time of the operation.",
"type": "string"
}
},
"id": "GoogleCloudDocumentaiV1beta1OperationMetadata"
},
"GoogleCloudDocumentaiV1beta3BatchProcessMetadata": {
"properties": {
"createTime": {
"format": "google-datetime",
"description": "The creation time of the operation.",
"type": "string"
},
"state": {
"description": "The state of the current batch processing.",
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was being cancelled.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
]
},
"updateTime": {
"format": "google-datetime",
"type": "string",
"description": "The last update time of the operation."
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
},
"individualProcessStatuses": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus"
},
"description": "The list of response details of each document."
}
},
"id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata",
"type": "object",
"description": "The long running operation metadata for batch process method."
},
"GoogleCloudDocumentaiV1beta1DocumentPageLine": {
"description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
"type": "object",
"properties": {
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Line."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "The history of this annotation."
},
"detectedLanguages": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array",
"description": "A list of detected languages together with confidence."
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentPageLine"
},
"GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": {
"description": "The long running operation metadata for disable processor method.",
"id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata",
"type": "object",
"properties": {
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
},
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"state": {
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The operation is completed successfully.",
"The operation was being cancelled.",
"The operation was cancelled.",
"The operation has failed."
],
"description": "The state of the current disable processor operation.",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
],
"type": "string"
}
}
},
"GoogleCloudDocumentaiV1beta1DocumentTranslation": {
"id": "GoogleCloudDocumentaiV1beta1DocumentTranslation",
"description": "A translation of the text segment.",
"type": "object",
"properties": {
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Provenance of the translation. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index."
},
"translatedText": {
"type": "string",
"description": "Text translated into the target language."
},
"provenance": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance"
},
"description": "The history of this annotation."
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentEntityRelation": {
"properties": {
"relation": {
"type": "string",
"description": "Relationship description."
},
"subjectId": {
"description": "Subject entity id.",
"type": "string"
},
"objectId": {
"description": "Object entity id.",
"type": "string"
}
},
"type": "object",
"description": "Relationship between Entities.",
"id": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation"
},
"GoogleCloudDocumentaiV1beta3BatchProcessResponse": {
"description": "Response message for batch process document method.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse",
"type": "object",
"properties": {}
},
"GoogleCloudDocumentaiV1beta2DocumentStyle": {
"id": "GoogleCloudDocumentaiV1beta2DocumentStyle",
"description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
"type": "object",
"properties": {
"textDecoration": {
"type": "string",
"description": "Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp"
},
"color": {
"$ref": "GoogleTypeColor",
"description": "Text color."
},
"textAnchor": {
"description": "Text anchor indexing into the Document.text.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor"
},
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Text background color."
},
"fontWeight": {
"description": "Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp",
"type": "string"
},
"fontSize": {
"description": "Font size.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize"
},
"textStyle": {
"description": "Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp",
"type": "string"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentPageImage": {
"properties": {
"mimeType": {
"description": "Encoding mime type for the image.",
"type": "string"
},
"width": {
"description": "Width of the image in pixels.",
"format": "int32",
"type": "integer"
},
"height": {
"format": "int32",
"description": "Height of the image in pixels.",
"type": "integer"
},
"content": {
"description": "Raw byte content of the image.",
"type": "string",
"format": "byte"
}
},
"description": "Rendered image contents for this page.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageImage",
"type": "object"
},
"GoogleCloudDocumentaiV1beta1BoundingPoly": {
"type": "object",
"description": "A bounding polygon for the detected image annotation.",
"properties": {
"vertices": {
"description": "The bounding polygon vertices.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1Vertex"
}
},
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1NormalizedVertex"
}
}
},
"id": "GoogleCloudDocumentaiV1beta1BoundingPoly"
},
"GoogleCloudDocumentaiV1beta2TableExtractionParams": {
"description": "Parameters to control table extraction behavior.",
"type": "object",
"properties": {
"tableBoundHints": {
"description": "Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2TableBoundHint"
}
},
"modelVersion": {
"type": "string",
"description": "Model version of the table extraction system. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model."
},
"headerHints": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. Reserved for future use."
},
"enabled": {
"description": "Whether to enable table extraction.",
"type": "boolean"
}
},
"id": "GoogleCloudDocumentaiV1beta2TableExtractionParams"
},
"GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage",
"description": "Detected language for a structural component.",
"properties": {
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
},
"confidence": {
"description": "Confidence of detected language. Range [0, 1].",
"format": "float",
"type": "number"
}
}
},
"GoogleCloudDocumentaiV1beta2BoundingPoly": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "A bounding polygon for the detected image annotation.",
"properties": {
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2Vertex"
},
"type": "array"
},
"normalizedVertices": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2NormalizedVertex"
},
"description": "The bounding polygon normalized vertices.",
"type": "array"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentRevision": {
"id": "GoogleCloudDocumentaiV1beta2DocumentRevision",
"properties": {
"parent": {
"type": "array",
"description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.",
"items": {
"type": "integer",
"format": "int32"
}
},
"agent": {
"description": "If the change was made by a person specify the name or id of that person.",
"type": "string"
},
"processor": {
"type": "string",
"description": "If the annotation was made by processor identify the processor by its resource name."
},
"createTime": {
"description": "The time that the revision was created.",
"format": "google-datetime",
"type": "string"
},
"humanReview": {
"description": "Human Review information of this revision.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview"
},
"id": {
"type": "string",
"description": "Id of the revision. Unique within the context of the document."
}
},
"description": "Contains past or forward revisions of this document.",
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentEntity": {
"description": "A phrase in the text that is a known entity type, such as a person, an organization, or location.",
"type": "object",
"properties": {
"confidence": {
"type": "number",
"description": "Optional. Confidence of detected Schema entity. Range [0, 1].",
"format": "float"
},
"id": {
"description": "Optional. Canonical id. This will be a unique value in the entity list for this document.",
"type": "string"
},
"mentionId": {
"description": "Deprecated. Use `id` field instead.",
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Provenance of the entity. Text anchor indexing into the Document.text."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "Optional. The history of this annotation."
},
"mentionText": {
"description": "Text value in the document e.g. `1600 Amphitheatre Pkwy`.",
"type": "string"
},
"type": {
"description": "Entity type from a schema e.g. `Address`.",
"type": "string"
},
"pageAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor",
"description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
},
"normalizedValue": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue",
"description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types."
},
"properties": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity"
},
"description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.",
"type": "array"
},
"redacted": {
"description": "Optional. Whether the entity will be redacted for de-identification purposes.",
"type": "boolean"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentEntity"
},
"GoogleCloudDocumentaiV1beta3ReviewDocumentResponse": {
"type": "object",
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentResponse",
"properties": {
"gcsDestination": {
"description": "The Cloud Storage uri for the human reviewed document.",
"type": "string"
}
},
"description": "Response message for review document method."
},
"GoogleCloudDocumentaiV1beta2TableBoundHint": {
"type": "object",
"properties": {
"pageNumber": {
"description": "Optional. Page number for multi-paged inputs this hint applies to. If not provided, this hint will apply to all pages by default. This value is 1-based.",
"format": "int32",
"type": "integer"
},
"boundingBox": {
"$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "Bounding box hint for a table on this page. The coordinates must be normalized to [0,1] and the bounding box must be an axis-aligned rectangle."
}
},
"description": "A hint for a table bounding box on the page for table parsing.",
"id": "GoogleCloudDocumentaiV1beta2TableBoundHint"
},
"GoogleCloudDocumentaiV1beta1DocumentStyle": {
"description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
"properties": {
"backgroundColor": {
"description": "Text background color.",
"$ref": "GoogleTypeColor"
},
"fontSize": {
"description": "Font size.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize"
},
"color": {
"$ref": "GoogleTypeColor",
"description": "Text color."
},
"textDecoration": {
"type": "string",
"description": "Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp"
},
"textStyle": {
"description": "Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp",
"type": "string"
},
"fontWeight": {
"description": "Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp",
"type": "string"
},
"textAnchor": {
"description": "Text anchor indexing into the Document.text.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor"
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentStyle"
},
"GoogleCloudDocumentaiV1beta2DocumentLabel": {
"properties": {
"automlModel": {
"type": "string",
"description": "Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`"
},
"name": {
"description": "Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category.",
"type": "string"
},
"confidence": {
"description": "Confidence score between 0 and 1 for label assignment.",
"type": "number",
"format": "float"
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentLabel",
"type": "object",
"description": "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."
},
"GoogleTypeDate": {
"properties": {
"month": {
"description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.",
"type": "integer",
"format": "int32"
},
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.",
"type": "integer",
"format": "int32"
},
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.",
"format": "int32",
"type": "integer"
}
},
"id": "GoogleTypeDate",
"description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageToken": {
"properties": {
"detectedLanguages": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"description": "A list of detected languages together with confidence."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Token."
},
"detectedBreak": {
"description": "Detected break at the end of a Token.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"description": "The history of this annotation."
}
},
"id": "GoogleCloudDocumentaiV1beta2DocumentPageToken",
"description": "A detected token.",
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageLayout": {
"id": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"type": "object",
"description": "Visual element describing a layout unit on a page.",
"properties": {
"confidence": {
"description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].",
"type": "number",
"format": "float"
},
"orientation": {
"description": "Detected orientation for the Layout.",
"enum": [
"ORIENTATION_UNSPECIFIED",
"PAGE_UP",
"PAGE_RIGHT",
"PAGE_DOWN",
"PAGE_LEFT"
],
"type": "string",
"enumDescriptions": [
"Unspecified orientation.",
"Orientation is aligned with page up.",
"Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.",
"Orientation is aligned with page down. Turn the head 180 degrees from upright to read.",
"Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read."
]
},
"textAnchor": {
"description": "Text anchor indexing into the Document.text.",
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor"
},
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "The bounding polygon for the Layout."
}
}
},
"GoogleCloudDocumentaiV1beta2InputConfig": {
"id": "GoogleCloudDocumentaiV1beta2InputConfig",
"description": "The desired input location and metadata.",
"properties": {
"contents": {
"description": "Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method.",
"type": "string",
"format": "byte"
},
"mimeType": {
"description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.",
"type": "string"
},
"gcsSource": {
"$ref": "GoogleCloudDocumentaiV1beta2GcsSource",
"description": "The Google Cloud Storage location to read the input from. This must be a single file."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef": {
"id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef",
"description": "Represents a weak reference to a page element within a document.",
"properties": {
"layoutType": {
"type": "string",
"enum": [
"LAYOUT_TYPE_UNSPECIFIED",
"BLOCK",
"PARAGRAPH",
"LINE",
"TOKEN",
"VISUAL_ELEMENT",
"TABLE",
"FORM_FIELD"
],
"description": "Optional. The type of the layout element that is being referenced if any.",
"enumDescriptions": [
"Layout Unspecified.",
"References a Page.blocks element.",
"References a Page.paragraphs element.",
"References a Page.lines element.",
"References a Page.tokens element.",
"References a Page.visual_elements element.",
"Refrrences a Page.tables element.",
"References a Page.form_fields element."
]
},
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "Optional. Identifies the bounding polygon of a layout element on the page."
},
"layoutId": {
"description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
"type": "string"
},
"page": {
"type": "string",
"format": "int64",
"description": "Required. Index into the Document.pages element"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentTextAnchor": {
"description": "Text reference indexing into the Document.text.",
"properties": {
"textSegments": {
"type": "array",
"description": "The text segments from the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment"
}
},
"content": {
"description": "Contains the content of the text span so that users do not have to look it up in the text_segments.",
"type": "string"
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor"
},
"GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": {
"id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement",
"description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"properties": {
"detectedLanguages": {
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"description": "A list of detected languages together with confidence.",
"type": "array"
},
"layout": {
"description": "Layout for VisualElement.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout"
},
"type": {
"type": "string",
"description": "Type of the VisualElement."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": {
"description": "The long running operation metadata for delete processor method.",
"properties": {
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
},
"updateTime": {
"format": "google-datetime",
"type": "string",
"description": "The last update time of the operation."
},
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"state": {
"type": "string",
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The operation is completed successfully.",
"The operation has failed."
],
"description": "The state of the current delete processor operation.",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"FAILED"
]
}
},
"type": "object",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata"
},
"GoogleCloudDocumentaiV1beta1DocumentPageAnchor": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor",
"properties": {
"pageRefs": {
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef"
},
"description": "One or more references to visual page elements"
}
},
"type": "object"
},
"GoogleTypeColor": {
"id": "GoogleTypeColor",
"description": "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, as well. Note: this proto does not 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. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be 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 \u003c= 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 \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...",
"type": "object",
"properties": {
"green": {
"format": "float",
"description": "The amount of green in the color as a value in the interval [0, 1].",
"type": "number"
},
"red": {
"format": "float",
"description": "The amount of red in the color as a value in the interval [0, 1].",
"type": "number"
},
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"alpha": {
"type": "number",
"format": "float",
"description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0)."
}
}
},
"GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata",
"description": "The long running operation metadata for DeleteLabelerPool.",
"properties": {
"state": {
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description": "Used only when Operation.done is false.",
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
]
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.",
"type": "string"
},
"createTime": {
"type": "string",
"description": "The creation time of the operation.",
"format": "google-datetime"
},
"updateTime": {
"type": "string",
"format": "google-datetime",
"description": "The last update time of the operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": {
"id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage",
"type": "object",
"properties": {
"confidence": {
"description": "Confidence of detected language. Range [0, 1].",
"type": "number",
"format": "float"
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
}
},
"description": "Detected language for a structural component."
},
"GoogleCloudDocumentaiV1beta1DocumentPageLayout": {
"type": "object",
"properties": {
"orientation": {
"type": "string",
"description": "Detected orientation for the Layout.",
"enumDescriptions": [
"Unspecified orientation.",
"Orientation is aligned with page up.",
"Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.",
"Orientation is aligned with page down. Turn the head 180 degrees from upright to read.",
"Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read."
],
"enum": [
"ORIENTATION_UNSPECIFIED",
"PAGE_UP",
"PAGE_RIGHT",
"PAGE_DOWN",
"PAGE_LEFT"
]
},
"confidence": {
"type": "number",
"format": "float",
"description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]."
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
},
"boundingPoly": {
"description": "The bounding polygon for the Layout.",
"$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly"
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Visual element describing a layout unit on a page."
},
"GoogleCloudDocumentaiV1beta1GcsSource": {
"id": "GoogleCloudDocumentaiV1beta1GcsSource",
"type": "object",
"description": "The Google Cloud Storage location where the input file will be read from.",
"properties": {
"uri": {
"type": "string"
}
}
},
"GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview": {
"properties": {
"state": {
"type": "string",
"description": "Human review state. e.g. `requested`, `succeeded`, `rejected`."
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`."
}
},
"type": "object",
"id": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview",
"description": "Human Review information of the document."
},
"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": {
"properties": {
"updateTime": {
"type": "string",
"description": "The last update time of the operation.",
"format": "google-datetime"
},
"createTime": {
"format": "google-datetime",
"description": "The creation time of the operation.",
"type": "string"
},
"state": {
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The operation is completed successfully.",
"The operation was being cancelled.",
"The operation was cancelled.",
"The operation has failed."
],
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
],
"description": "The state of the current enable processor operation.",
"type": "string"
},
"stateMessage": {
"type": "string",
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed."
}
},
"description": "The long running operation metadata for enable processor method.",
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata",
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageParagraph": {
"description": "A collection of lines that a human would perceive as a paragraph.",
"type": "object",
"properties": {
"layout": {
"description": "Layout for Paragraph.",
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "The history of this annotation."
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"type": "array",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
}
}
},
"id": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph"
}
},
"revision": "20200828",
"servicePath": "",
"title": "Cloud Document AI API",
"batchPath": "batch",
"id": "documentai:v1beta2",
"mtlsRootUrl": "https://documentai.mtls.googleapis.com/",
"baseUrl": "https://documentai.googleapis.com/",
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"callback": {
"location": "query",
"type": "string",
"description": "JSONP"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"quotaUser": {
"type": "string",
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"alt": {
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"description": "Data format for response.",
"type": "string",
"location": "query",
"enum": [
"json",
"media",
"proto"
]
},
"$.xgafv": {
"description": "V1 error format.",
"location": "query",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
]
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
}
},
"rootUrl": "https://documentai.googleapis.com/",
"protocol": "rest",
"ownerDomain": "google.com",
"name": "documentai"
}