{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://documentai.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Document",
"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.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/document-ai/docs/",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.us.rep.googleapis.com/",
"location": "us"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.eu.rep.googleapis.com/",
"location": "eu"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.asia-south1.rep.googleapis.com/",
"location": "asia-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.asia-southeast1.rep.googleapis.com/",
"location": "asia-southeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.northamerica-northeast1.rep.googleapis.com/",
"location": "northamerica-northeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.australia-southeast1.rep.googleapis.com/",
"location": "australia-southeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.europe-west2.rep.googleapis.com/",
"location": "europe-west2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://documentai.europe-west3.rep.googleapis.com/",
"location": "europe-west3"
}
],
"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"
},
"id": "documentai:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://documentai.mtls.googleapis.com/",
"name": "documentai",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"operations": {
"methods": {
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "documentai.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"projects": {
"resources": {
"locations": {
"methods": {
"fetchProcessorTypes": {
"description": "Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes",
"httpMethod": "GET",
"id": "documentai.projects.locations.fetchProcessorTypes",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:fetchProcessorTypes",
"response": {
"$ref": "GoogleCloudDocumentaiV1FetchProcessorTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudLocationLocation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "documentai.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
"location": "query",
"repeated": true,
"type": "string"
},
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "GoogleCloudLocationListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "documentai.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "documentai.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"processorTypes": {
"methods": {
"get": {
"description": "Gets a processor type detail.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.processorTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor type resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processorTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDocumentaiV1ProcessorType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the processor types that exist.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processorTypes",
"httpMethod": "GET",
"id": "documentai.projects.locations.processorTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Used to retrieve the next page of results, empty if at the end of the list.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/processorTypes",
"response": {
"$ref": "GoogleCloudDocumentaiV1ListProcessorTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"processors": {
"methods": {
"batchProcess": {
"description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.batchProcess",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:batchProcess",
"request": {
"$ref": "GoogleCloudDocumentaiV1BatchProcessRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/processors",
"request": {
"$ref": "GoogleCloudDocumentaiV1Processor"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1Processor"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}",
"httpMethod": "DELETE",
"id": "documentai.projects.locations.processors.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor resource name to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"disable": {
"description": "Disables a processor",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.disable",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor resource name to be disabled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:disable",
"request": {
"$ref": "GoogleCloudDocumentaiV1DisableProcessorRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"enable": {
"description": "Enables a processor",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.enable",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor resource name to be enabled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:enable",
"request": {
"$ref": "GoogleCloudDocumentaiV1EnableProcessorRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a processor detail.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.processors.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDocumentaiV1Processor"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all processors which belong to this project.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors",
"httpMethod": "GET",
"id": "documentai.projects.locations.processors.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "We will return the processors sorted by creation time. The page token will point to the next processor.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/processors",
"response": {
"$ref": "GoogleCloudDocumentaiV1ListProcessorsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"process": {
"description": "Processes a single document.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.process",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:process",
"request": {
"$ref": "GoogleCloudDocumentaiV1ProcessRequest"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1ProcessResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setDefaultProcessorVersion": {
"description": "Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.setDefaultProcessorVersion",
"parameterOrder": [
"processor"
],
"parameters": {
"processor": {
"description": "Required. The resource name of the Processor to change default version.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+processor}:setDefaultProcessorVersion",
"request": {
"$ref": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"humanReviewConfig": {
"deprecated": true,
"methods": {
"reviewDocument": {
"deprecated": true,
"description": "Send a document for Human Review. The input document should be processed by the specified processor.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.humanReviewConfig.reviewDocument",
"parameterOrder": [
"humanReviewConfig"
],
"parameters": {
"humanReviewConfig": {
"description": "Required. The resource name of the HumanReviewConfig that the document will be reviewed with.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/humanReviewConfig$",
"required": true,
"type": "string"
}
},
"path": "v1/{+humanReviewConfig}:reviewDocument",
"request": {
"$ref": "GoogleCloudDocumentaiV1ReviewDocumentRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"processorVersions": {
"methods": {
"batchProcess": {
"description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.processorVersions.batchProcess",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:batchProcess",
"request": {
"$ref": "GoogleCloudDocumentaiV1BatchProcessRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the processor version, all artifacts under the processor version will be deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}",
"httpMethod": "DELETE",
"id": "documentai.projects.locations.processors.processorVersions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor version resource name to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"deploy": {
"description": "Deploys the processor version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.processorVersions.deploy",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor version resource name to be deployed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:deploy",
"request": {
"$ref": "GoogleCloudDocumentaiV1DeployProcessorVersionRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"evaluateProcessorVersion": {
"description": "Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion",
"parameterOrder": [
"processorVersion"
],
"parameters": {
"processorVersion": {
"description": "Required. The resource name of the ProcessorVersion to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+processorVersion}:evaluateProcessorVersion",
"request": {
"$ref": "GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a processor version detail.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.processors.processorVersions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all versions of a processor.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions",
"httpMethod": "GET",
"id": "documentai.projects.locations.processors.processorVersions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "We will return the processor versions sorted by creation time. The page token will point to the next processor version.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/processorVersions",
"response": {
"$ref": "GoogleCloudDocumentaiV1ListProcessorVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"process": {
"description": "Processes a single document.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.processorVersions.process",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:process",
"request": {
"$ref": "GoogleCloudDocumentaiV1ProcessRequest"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1ProcessResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"train": {
"description": "Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.processorVersions.train",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/processorVersions:train",
"request": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"undeploy": {
"description": "Undeploys the processor version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy",
"httpMethod": "POST",
"id": "documentai.projects.locations.processors.processorVersions.undeploy",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The processor version resource name to be undeployed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:undeploy",
"request": {
"$ref": "GoogleCloudDocumentaiV1UndeployProcessorVersionRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"evaluations": {
"methods": {
"get": {
"description": "Retrieves a specific evaluation.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.processors.processorVersions.evaluations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Evaluation to get. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDocumentaiV1Evaluation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Retrieves a set of evaluations for a given processor version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations",
"httpMethod": "GET",
"id": "documentai.projects.locations.processors.processorVersions.evaluations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/evaluations",
"response": {
"$ref": "GoogleCloudDocumentaiV1ListEvaluationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"schemas": {
"methods": {
"create": {
"description": "Creates a schema.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas",
"httpMethod": "POST",
"id": "documentai.projects.locations.schemas.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/schemas",
"request": {
"$ref": "GoogleCloudDocumentaiV1NextSchema"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1NextSchema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a schema.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
"httpMethod": "DELETE",
"id": "documentai.projects.locations.schemas.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a schema.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.schemas.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDocumentaiV1NextSchema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Schemas.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas",
"httpMethod": "GET",
"id": "documentai.projects.locations.schemas.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Returns the schema groups sorted by creation time. The page token will point to the next Schema.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/schemas",
"response": {
"$ref": "GoogleCloudDocumentaiV1ListSchemasResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a schema. Editable fields are: - `display_name` - `labels`",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
"httpMethod": "PATCH",
"id": "documentai.projects.locations.schemas.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDocumentaiV1NextSchema"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1NextSchema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"schemaVersions": {
"methods": {
"create": {
"description": "Creates a schema version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions",
"httpMethod": "POST",
"id": "documentai.projects.locations.schemas.schemaVersions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/schemaVersions",
"request": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a schema version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
"httpMethod": "DELETE",
"id": "documentai.projects.locations.schemas.schemaVersions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generate": {
"description": "Generates a schema version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate",
"httpMethod": "POST",
"id": "documentai.projects.locations.schemas.schemaVersions.generate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/schemaVersions:generate",
"request": {
"$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a schema version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.schemas.schemaVersions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists SchemaVersions.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions",
"httpMethod": "GET",
"id": "documentai.projects.locations.schemas.schemaVersions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Returns the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/schemaVersions",
"response": {
"$ref": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a schema version. Editable fields are: - `display_name` - `labels`",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
"httpMethod": "PATCH",
"id": "documentai.projects.locations.schemas.schemaVersions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"operations": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "documentai.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20260503",
"rootUrl": "https://documentai.googleapis.com/",
"schemas": {
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
"description": "Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document. Next ID: 3",
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput",
"properties": {
"validationRules": {
"items": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule"
},
"type": "array"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule": {
"description": "Next ID: 9",
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule",
"properties": {
"childAlignmentRule": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule"
},
"description": {
"description": "Description of the validation rule. This has no use but for documentation.",
"type": "string"
},
"entityAlignmentRule": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule"
},
"fieldOccurrences": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences"
},
"fieldRegex": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex"
},
"formValidation": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation"
},
"name": {
"description": "Name of the validation rule.",
"type": "string"
},
"ruleId": {
"description": "Unique identifier of the rule. Optional.",
"type": "string"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule": {
"description": "A rule for checking field alignment. Horizontal alignment checks if fields are on the same row by comparing y-coordinates of bounding box centers, while vertical alignment checks if fields are on the same column by comparing x-coordinates of bounding box centers.",
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
"properties": {
"alignmentType": {
"enum": [
"ALIGNMENT_TYPE_UNSPECIFIED",
"ALIGNMENT_TYPE_HORIZONTAL",
"ALIGNMENT_TYPE_VERTICAL"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"tolerance": {
"description": "The tolerance to use when comparing coordinates.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule": {
"description": "A rule that aligns specified child fields with a parent field.",
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule",
"properties": {
"alignmentRule": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
"description": "The alignment rule to apply to the child fields."
},
"childFields": {
"description": "The child fields to be aligned within the parent field.",
"items": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
},
"type": "array"
},
"parentField": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField",
"description": "The full path of the parent field."
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant": {
"description": "The constant value used in the validation rules.",
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant",
"properties": {
"floatValue": {
"format": "float",
"type": "number"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule": {
"description": "A rule that aligns specified fields with each other.",
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule",
"properties": {
"alignmentRule": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
"description": "The alignment rule to apply to the fields."
},
"fields": {
"description": "The fields to be aligned.",
"items": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
},
"type": "array"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField": {
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField",
"properties": {
"defaultValue": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant",
"description": "Default value to use if the field is not present. If the field is missing and the default value is not set, the validation run as if the field is not present in the validation logic."
},
"fieldName": {
"description": "The field name to validate. This can be a simple field name or a nested field one using the ':' (meant as an aggregator) or '*' (meant as foreach) operators.",
"type": "string"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences": {
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences",
"properties": {
"field": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
},
"maxOccurrences": {
"format": "uint32",
"type": "integer"
},
"minOccurrences": {
"description": "Min and max occurrences of the field. If not set, there is limit set. The defined interval is a closed-closed interval, i.e. [min, max].",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex": {
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex",
"properties": {
"field": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
},
"pattern": {
"description": "Python regex to validate the field values.",
"type": "string"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation": {
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation",
"properties": {
"leftOperand": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation"
},
"rightOperand": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation"
},
"validationOperator": {
"description": "The relational operator to be applied to the operands.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"OPERATION_TYPE_EQ",
"OPERATION_TYPE_NE",
"OPERATION_TYPE_LT",
"OPERATION_TYPE_LE",
"OPERATION_TYPE_GT",
"OPERATION_TYPE_GE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation": {
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation",
"properties": {
"constants": {
"description": "A list of constants to be used as operands.",
"items": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant"
},
"type": "array"
},
"fields": {
"description": "A list of fields to be used as operands.",
"items": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
},
"type": "array"
},
"operationType": {
"description": "The operation type to be applied to all the operands.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"OPERATION_TYPE_SUM",
"OPERATION_TYPE_SUB",
"OPERATION_TYPE_MUL",
"OPERATION_TYPE_DIV",
"OPERATION_TYPE_MAX",
"OPERATION_TYPE_MIN",
"OPERATION_TYPE_ABS",
"OPERATION_TYPE_UNIQUE",
"OPERATION_TYPE_COUNT"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"operations": {
"description": "A list of recursive operations to be used as operands.",
"items": {
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
"description": "Metadata of the auto-labeling documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"individualAutoLabelStatuses": {
"description": "The list of individual auto-labeling statuses of the dataset documents.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of the auto-labeling documents.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus": {
"description": "The status of individual documents in the auto-labeling process.",
"id": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the auto-labeled document. This will replace the gcs_uri."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the document auto-labeling."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse": {
"description": "The response proto of AutoLabelDocuments method.",
"id": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"errorDocumentCount": {
"description": "Total number of documents that failed to be deleted in storage.",
"format": "int32",
"type": "integer"
},
"individualBatchDeleteStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of documents deleting from dataset.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": {
"description": "The status of each individual document in the batch delete process.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of deleting the document in storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse": {
"description": "Response of the delete documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"destDatasetType": {
"deprecated": true,
"description": "The destination dataset split type.",
"enum": [
"DATASET_SPLIT_TYPE_UNSPECIFIED",
"DATASET_SPLIT_TRAIN",
"DATASET_SPLIT_TEST",
"DATASET_SPLIT_UNASSIGNED"
],
"enumDescriptions": [
"Default value if the enum is not set.",
"Identifies the train documents.",
"Identifies the test documents.",
"Identifies the unassigned documents."
],
"type": "string"
},
"destSplitType": {
"description": "The destination dataset split type.",
"enum": [
"DATASET_SPLIT_TYPE_UNSPECIFIED",
"DATASET_SPLIT_TRAIN",
"DATASET_SPLIT_TEST",
"DATASET_SPLIT_UNASSIGNED"
],
"enumDescriptions": [
"Default value if the enum is not set.",
"Identifies the train documents.",
"Identifies the test documents.",
"Identifies the unassigned documents."
],
"type": "string"
},
"individualBatchMoveStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus": {
"description": "The status of each individual document in the batch move process.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of moving the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse": {
"description": "Response of the batch move documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"individualBatchUpdateStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus": {
"description": "The status of each individual document in the batch update process.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of updating the document in storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse": {
"description": "Response of the batch update documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": {
"description": "The common metadata for long running operations.",
"id": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"resource": {
"description": "A related resource to this operation.",
"type": "string"
},
"state": {
"description": "The state of the operation.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": {
"description": "The long-running operation metadata for the CreateLabelerPool method.",
"id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": {
"description": "The long-running operation metadata for DeleteLabelerPool.",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": {
"description": "The long-running operation metadata for the DeleteProcessor method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeleteProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse": {
"description": "Response message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": {
"description": "The long-running operation metadata for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse": {
"description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentId": {
"description": "Document Identifier.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"properties": {
"gcsManagedDocId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId",
"description": "A document id within user-managed Cloud Storage."
},
"revisionRef": {
"$ref": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
"description": "Points to a specific revision of the document if set."
},
"unmanagedDocId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
"description": "A document id within unmanaged dataset."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId",
"properties": {
"cwDocId": {
"deprecated": true,
"description": "Id of the document (indexed) managed by Content Warehouse.",
"type": "string"
},
"gcsUri": {
"description": "Required. The Cloud Storage URI where the actual document is stored.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
"properties": {
"docId": {
"description": "Required. The id of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentSchema": {
"description": "The schema defines the output of the processed document by a processor.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema",
"properties": {
"description": {
"description": "Description of the schema.",
"type": "string"
},
"displayName": {
"description": "Display name to show users.",
"type": "string"
},
"documentPrompt": {
"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
"type": "string"
},
"entityTypes": {
"description": "Entity types of the schema.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType"
},
"type": "array"
},
"metadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata",
"description": "Metadata of the schema."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": {
"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType",
"properties": {
"baseTypes": {
"description": "The entity type that this type is derived from. For now, one and only one should be set.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.",
"type": "string"
},
"displayName": {
"description": "User defined name for the type.",
"type": "string"
},
"entityTypeMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata",
"description": "Metadata for the entity type."
},
"enumValues": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
},
"name": {
"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
"type": "string"
},
"properties": {
"description": "Description the nested structure, or composition of an entity.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": {
"description": "Defines the a list of enum values.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
"properties": {
"values": {
"description": "The individual values that this enum values type can include.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": {
"description": "Defines properties that can be part of the entity type.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty",
"properties": {
"description": {
"description": "The description of the property. Could be used to provide more information about the property for model calls.",
"type": "string"
},
"displayName": {
"description": "User defined name for the property.",
"type": "string"
},
"method": {
"description": "Specifies how the entity's value is obtained.",
"enum": [
"METHOD_UNSPECIFIED",
"EXTRACT",
"DERIVE",
"RELAXED_EXTRACT"
],
"enumDescriptions": [
"Unspecified method. It defaults to `EXTRACT`.",
"The entity's value is directly extracted as-is from the document text.",
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document.",
"Attempts to extract the position and value as-is from the document text. If the value cannot be grounded in the text, it falls back to derivation through inference, for both position and value. Note: The inference fallback is currently only supported for boolean entities."
],
"type": "string"
},
"name": {
"description": "The name of the property. Follows the same guidelines as the EntityType name.",
"type": "string"
},
"occurrenceType": {
"description": "Occurrence type limits the number of instances an entity type appears in the document.",
"enum": [
"OCCURRENCE_TYPE_UNSPECIFIED",
"OPTIONAL_ONCE",
"OPTIONAL_MULTIPLE",
"REQUIRED_ONCE",
"REQUIRED_MULTIPLE"
],
"enumDescriptions": [
"Unspecified occurrence type.",
"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.",
"The entity type will appear zero or multiple times.",
"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.",
"The entity type will appear once or more times."
],
"type": "string"
},
"propertyMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata",
"description": "Any additional metadata about the property can be added here."
},
"valueType": {
"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": {
"description": "Metadata for global schema behavior.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata",
"properties": {
"documentAllowMultipleLabels": {
"description": "If true, on a given page, there can be multiple `document` annotations covering it.",
"type": "boolean"
},
"documentSplitter": {
"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).",
"type": "boolean"
},
"prefixedNamingOnProperties": {
"description": "If set, all the nested entities must be prefixed with the parents.",
"type": "boolean"
},
"skipNamingValidation": {
"description": "If set, this will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": {
"description": "The long-running operation metadata for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": {
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": {
"description": "Metadata about an entity type.",
"id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata",
"properties": {
"fieldTierMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
"description": "Field tier metadata on the property"
},
"humanReviewLabelingMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
"description": "Human review labeling config on the entity."
},
"humanReviewMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
"description": "Human review config on the entity."
},
"inactive": {
"description": "Whether the entity type should be considered inactive.",
"type": "boolean"
},
"schemaEditabilityMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
"description": "Schema editability metadata on the entity."
},
"schemaInferenceMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
"description": "Schema inference metadata on the entity."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": {
"description": "Metadata of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": {
"description": "Response of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse",
"properties": {
"evaluation": {
"description": "The resource name of the created evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": {
"description": "Evaluation metrics, either in aggregate or about a specific entity.",
"id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
"properties": {
"f1Score": {
"description": "The calculated F1 score.",
"format": "float",
"type": "number"
},
"falseNegativesCount": {
"description": "The amount of false negatives.",
"format": "int32",
"type": "integer"
},
"falsePositivesCount": {
"description": "The amount of false positives.",
"format": "int32",
"type": "integer"
},
"groundTruthDocumentCount": {
"description": "The amount of documents with a ground truth occurrence.",
"format": "int32",
"type": "integer"
},
"groundTruthOccurrencesCount": {
"description": "The amount of occurrences in ground truth documents.",
"format": "int32",
"type": "integer"
},
"precision": {
"description": "The calculated precision.",
"format": "float",
"type": "number"
},
"predictedDocumentCount": {
"description": "The amount of documents with a predicted occurrence.",
"format": "int32",
"type": "integer"
},
"predictedOccurrencesCount": {
"description": "The amount of occurrences in predicted documents.",
"format": "int32",
"type": "integer"
},
"recall": {
"description": "The calculated recall.",
"format": "float",
"type": "number"
},
"totalDocumentsCount": {
"description": "The amount of documents that had an occurrence of this label.",
"format": "int32",
"type": "integer"
},
"truePositivesCount": {
"description": "The amount of true positives.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EvaluationReference": {
"description": "Gives a short summary of an evaluation, and links to the evaluation itself.",
"id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference",
"properties": {
"aggregateMetrics": {
"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
"description": "An aggregate of the statistics for the evaluation with fuzzy matching on."
},
"aggregateMetricsExact": {
"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
"description": "An aggregate of the statistics for the evaluation with fuzzy matching off."
},
"evaluation": {
"description": "The resource name of the evaluation.",
"type": "string"
},
"operation": {
"description": "The resource name of the Long Running Operation for the evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": {
"description": "Metadata of the batch export documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"individualExportStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus"
},
"type": "array"
},
"splitExportStats": {
"description": "The list of statistics for each dataset split type.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus": {
"description": "The status of each individual document in the export process.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The path to source docproto of the document."
},
"outputGcsDestination": {
"description": "The output_gcs_destination of the exported document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the exporting of the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat": {
"description": "The statistic representing a dataset split type for this export.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat",
"properties": {
"splitType": {
"description": "The dataset split type.",
"enum": [
"DATASET_SPLIT_TYPE_UNSPECIFIED",
"DATASET_SPLIT_TRAIN",
"DATASET_SPLIT_TEST",
"DATASET_SPLIT_UNASSIGNED"
],
"enumDescriptions": [
"Default value if the enum is not set.",
"Identifies the train documents.",
"Identifies the test documents.",
"Identifies the unassigned documents."
],
"type": "string"
},
"totalDocumentCount": {
"description": "Total number of documents with the given dataset split type to be exported.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse": {
"description": "The response proto of ExportDocuments method.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata": {
"description": "Metadata message associated with the ExportProcessorVersion operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The common metadata about the operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": {
"description": "Response message associated with the ExportProcessorVersion operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse",
"properties": {
"gcsUri": {
"description": "The Cloud Storage URI containing the output artifacts.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": {
"description": "Metadata for how this field value is extracted.",
"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata",
"properties": {
"entityQuery": {
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery",
"description": "Entity query config."
},
"summaryOptions": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions",
"description": "Summary options config."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": {
"description": "Message for entity query.",
"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery",
"properties": {
"userEntityQuery": {
"description": "The original entity query inputed by the user.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": {
"description": "Metadata for the field tier of a property.",
"id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
"properties": {
"tierLevel": {
"description": "Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": {
"description": "Metadata for human review labeling config.",
"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
"properties": {
"enableNormalizationEditing": {
"description": "Whether to enable normalization editing.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": {
"description": "Metadata for Human Review config.",
"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
"properties": {
"confidenceThreshold": {
"description": "The confidence threshold if human review validation is enabled.",
"format": "float",
"type": "number"
},
"enableValidation": {
"description": "Whether to enable human review validation.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": {
"description": "Metadata of the import document operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"importConfigValidationResults": {
"description": "Validation statuses of the batch documents import config.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult"
},
"type": "array"
},
"individualImportStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of the documents that are qualified for importing.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": {
"description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI specified in the import config.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The validation status of import config."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": {
"description": "The status of each individual document in the import process.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI of the document.",
"type": "string"
},
"outputDocumentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of imported document if it was successful, otherwise empty."
},
"outputGcsDestination": {
"description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the importing of the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": {
"description": "Response of the import document operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": {
"description": "The long-running operation metadata for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata for the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": {
"description": "The response message for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The destination processor version name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3Processor": {
"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
"id": "GoogleCloudDocumentaiUiv1beta3Processor",
"properties": {
"activeSchemaVersion": {
"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
"type": "string"
},
"createTime": {
"description": "Output only. The time the processor was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"defaultProcessorVersion": {
"description": "The default processor version.",
"type": "string"
},
"displayName": {
"description": "The display name of the processor.",
"type": "string"
},
"kmsKeyName": {
"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.",
"type": "string"
},
"name": {
"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`",
"readOnly": true,
"type": "string"
},
"processEndpoint": {
"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.",
"readOnly": true,
"type": "string"
},
"processorVersionAliases": {
"description": "Output only. The processor version aliases.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias"
},
"readOnly": true,
"type": "array"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Output only. The state of the processor.",
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"DISABLED",
"ENABLING",
"DISABLING",
"CREATING",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"The processor is in an unspecified state.",
"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.",
"The processor is disabled.",
"The processor is being enabled, will become `ENABLED` if successful.",
"The processor is being disabled, will become `DISABLED` if successful.",
"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.",
"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.",
"The processor is being deleted, will be removed if successful."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ProcessorVersion": {
"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.",
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion",
"properties": {
"createTime": {
"description": "Output only. The time the processor version was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deploymentAllowed": {
"description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.",
"readOnly": true,
"type": "boolean"
},
"deprecationInfo": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo",
"description": "Output only. If set, information about the eventual deprecation of this version.",
"readOnly": true
},
"displayName": {
"description": "The display name of the processor version.",
"type": "string"
},
"documentSchema": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema",
"description": "Output only. The schema of the processor version. Describes the output.",
"readOnly": true
},
"genAiModelInfo": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo",
"description": "Output only. Information about Generative AI model-based processor versions.",
"readOnly": true
},
"googleManaged": {
"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
"readOnly": true,
"type": "boolean"
},
"kmsKeyName": {
"description": "Output only. The KMS key name used for encryption.",
"readOnly": true,
"type": "string"
},
"kmsKeyVersionName": {
"description": "Output only. The KMS key version with which data is encrypted.",
"readOnly": true,
"type": "string"
},
"latestEvaluation": {
"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference",
"description": "Output only. The most recently invoked evaluation for the processor version.",
"readOnly": true
},
"modelType": {
"description": "Output only. The model type of this processor version.",
"enum": [
"MODEL_TYPE_UNSPECIFIED",
"MODEL_TYPE_GENERATIVE",
"MODEL_TYPE_CUSTOM"
],
"enumDescriptions": [
"The processor version has unspecified model type.",
"The processor version has generative model type.",
"The processor version has custom model type."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`",
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"$ref": "GoogleCloudDocumentaiUiv1beta3Schema",
"description": "The schema of the processor version. Describes the output."
},
"state": {
"description": "Output only. The state of the processor version.",
"enum": [
"STATE_UNSPECIFIED",
"DEPLOYED",
"DEPLOYING",
"UNDEPLOYED",
"UNDEPLOYING",
"CREATING",
"DELETING",
"FAILED",
"IMPORTING"
],
"enumDescriptions": [
"The processor version is in an unspecified state.",
"The processor version is deployed and can be used for processing.",
"The processor version is being deployed.",
"The processor version is not deployed and cannot be used for processing.",
"The processor version is being undeployed.",
"The processor version is being created.",
"The processor version is being deleted.",
"The processor version failed and is in an indeterminate state.",
"The processor version is being imported."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": {
"description": "Contains the alias and the aliased resource name of processor version.",
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias",
"properties": {
"alias": {
"description": "The alias in the form of `processor_version` resource name.",
"type": "string"
},
"processorVersion": {
"description": "The resource name of aliased processor version.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": {
"description": "Information about the upcoming deprecation of this processor version.",
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo",
"properties": {
"deprecationTime": {
"description": "The time at which this processor version will be deprecated.",
"format": "google-datetime",
"type": "string"
},
"replacementProcessorVersion": {
"description": "If set, the processor version that will be used as a replacement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": {
"description": "Information about Generative AI model-based processor versions.",
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo",
"properties": {
"customGenAiModelInfo": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
"description": "Information for a custom Generative AI model created by the user."
},
"foundationGenAiModelInfo": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
"description": "Information for a pretrained Google-managed foundation model."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.",
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
"properties": {
"baseProcessorVersionId": {
"description": "The base processor version ID for the custom model.",
"type": "string"
},
"customModelType": {
"description": "The type of custom model created by the user.",
"enum": [
"CUSTOM_MODEL_TYPE_UNSPECIFIED",
"VERSIONED_FOUNDATION",
"FINE_TUNED"
],
"enumDescriptions": [
"The model type is unspecified.",
"The model is a versioned foundation model.",
"The model is a finetuned foundation model."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
"description": "Information for a pretrained Google-managed foundation model.",
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
"properties": {
"finetuningAllowed": {
"description": "Whether fine tuning is allowed for this base processor version.",
"type": "boolean"
},
"minTrainLabeledDocuments": {
"description": "The minimum number of labeled documents in the training dataset required for fine tuning.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3PropertyMetadata": {
"description": "Metadata about a property.",
"id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata",
"properties": {
"fieldExtractionMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata",
"description": "Field extraction metadata on the property."
},
"fieldTierMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
"description": "Field tier metadata on the property"
},
"humanReviewLabelingMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
"description": "Human review labeling config on the property."
},
"humanReviewMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
"description": "Human review validation config on the property."
},
"inactive": {
"description": "Whether the property should be considered as \"inactive\".",
"type": "boolean"
},
"schemaEditabilityMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
"description": "Schema editability metadata on the property."
},
"schemaInferenceMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
"description": "Schema inference metadata on the property."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
"description": "The metadata proto of `ResyncDataset` method.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"datasetResyncStatuses": {
"description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
},
"type": "array"
},
"individualDocumentResyncStatuses": {
"description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": {
"description": "Resync status against inconsistency types on the dataset level.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus",
"properties": {
"datasetInconsistencyType": {
"description": "The type of the inconsistency of the dataset.",
"enum": [
"DATASET_INCONSISTENCY_TYPE_UNSPECIFIED",
"DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER"
],
"enumDescriptions": [
"Default value.",
"The marker file under the dataset folder is not found."
],
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": {
"description": "Resync status for each document per inconsistency type.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document identifier."
},
"documentInconsistencyType": {
"description": "The type of document inconsistency.",
"enum": [
"DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED",
"DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO",
"DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA",
"DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE"
],
"enumDescriptions": [
"Default value.",
"The document proto is invalid.",
"Indexed docproto metadata is mismatched.",
"The page image or thumbnails are missing."
],
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": {
"description": "The response proto of ResyncDataset method.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3RevisionRef": {
"description": "The revision reference specifies which revision on the document to read.",
"id": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
"properties": {
"latestProcessorVersion": {
"description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"type": "string"
},
"revisionCase": {
"description": "Reads the revision by the predefined case.",
"enum": [
"REVISION_CASE_UNSPECIFIED",
"LATEST_HUMAN_REVIEW",
"LATEST_TIMESTAMP",
"BASE_OCR_REVISION"
],
"enumDescriptions": [
"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
"The latest revision made by a human.",
"The latest revision based on timestamp.",
"The first (OCR) revision."
],
"type": "string"
},
"revisionId": {
"description": "Reads the revision given by the id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": {
"description": "Metadata of the sample documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": {
"description": "Response of the sample documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse",
"properties": {
"sampleTestStatus": {
"$ref": "GoogleRpcStatus",
"description": "The status of sampling documents in test split."
},
"sampleTrainingStatus": {
"$ref": "GoogleRpcStatus",
"description": "The status of sampling documents in training split."
},
"selectedDocuments": {
"description": "The result of the sampling process.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": {
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument",
"properties": {
"documentId": {
"description": "An internal identifier for document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3Schema": {
"description": "The schema defines the output of the processed document by a processor.",
"id": "GoogleCloudDocumentaiUiv1beta3Schema",
"properties": {
"description": {
"description": "Description of the schema.",
"type": "string"
},
"displayName": {
"description": "Display name to show users.",
"type": "string"
},
"entityTypes": {
"description": "Entity types of the schema.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": {
"description": "Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.",
"id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
"properties": {
"editable": {
"description": "Explicit flag that controls whether the label is editable.",
"type": "boolean"
},
"processorVersions": {
"description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SchemaEntityType": {
"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.",
"id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType",
"properties": {
"baseType": {
"type": "string"
},
"description": {
"description": "Description of the entity type.",
"type": "string"
},
"enumValues": {
"description": "If specified, lists all the possible values for this entity.",
"items": {
"type": "string"
},
"type": "array"
},
"hide": {
"description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.",
"type": "boolean"
},
"method": {
"description": "Specifies how the entity's value is obtained.",
"enum": [
"METHOD_UNSPECIFIED",
"EXTRACT",
"DERIVE",
"RELAXED_EXTRACT"
],
"enumDescriptions": [
"Unspecified method. It defaults to `EXTRACT`.",
"The entity's value is directly extracted as-is from the document text.",
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document.",
"Attempts to extract the position and value as-is from the document text. If the value cannot be grounded in the text, it falls back to derivation through inference, for both position and value. Note: The inference fallback is currently only supported for boolean entities."
],
"type": "string"
},
"occurrenceType": {
"description": "Occurrence type limits the number of times an entity type appears in the document.",
"enum": [
"OCCURRENCE_TYPE_UNSPECIFIED",
"OPTIONAL_ONCE",
"OPTIONAL_MULTIPLE",
"REQUIRED_ONCE",
"REQUIRED_MULTIPLE"
],
"enumDescriptions": [
"Unspecified occurrence type.",
"The entity type will appear zero times or once.",
"The entity type will appear zero or multiple times.",
"The entity type will only appear exactly once.",
"The entity type will appear once or more times."
],
"type": "string"
},
"properties": {
"description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType"
},
"type": "array"
},
"source": {
"description": "Source of this entity type.",
"enum": [
"SOURCE_UNSPECIFIED",
"PREDEFINED",
"USER_INPUT"
],
"enumDescriptions": [
"Unspecified source.",
"The entity type is in the predefined schema of a pretrained version of a processor.",
"The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor."
],
"type": "string"
},
"type": {
"description": "Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: \"google\", \"DocumentAI\" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., \"line_item/amount\") in which case each part (e.g., \"line_item\", \"amount\") must comply with the rules defined above. We recommend using the snake case (\"snake_case\") in entity type names.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": {
"description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.",
"id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
"properties": {
"inferred": {
"description": "True if is inferred by schema inference.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": {
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": {
"description": "Response message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SummaryOptions": {
"description": "Metadata for document summarization.",
"id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions",
"properties": {
"format": {
"description": "The format the summary should be in.",
"enum": [
"FORMAT_UNSPECIFIED",
"PARAGRAPH",
"BULLETS"
],
"enumDescriptions": [
"Default.",
"Format the output in paragraphs.",
"Format the output in bullets."
],
"type": "string"
},
"length": {
"description": "How long the summary should be.",
"enum": [
"LENGTH_UNSPECIFIED",
"BRIEF",
"MODERATE",
"COMPREHENSIVE"
],
"enumDescriptions": [
"Default.",
"A brief summary of one or two sentences.",
"A paragraph-length summary.",
"The longest option available."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": {
"description": "The metadata that represents a processor version being created.",
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"testDatasetValidation": {
"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The test dataset validation information."
},
"trainingDatasetValidation": {
"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The training dataset validation information."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": {
"description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
"properties": {
"datasetErrorCount": {
"description": "The total number of dataset errors.",
"format": "int32",
"type": "integer"
},
"datasetErrors": {
"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"documentErrorCount": {
"description": "The total number of document errors.",
"format": "int32",
"type": "integer"
},
"documentErrors": {
"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": {
"description": "The response for TrainProcessorVersion.",
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The resource name of the processor version produced by training.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": {
"description": "Response message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": {
"description": "The long-running operation metadata for updating the human review configuration.",
"id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": {
"description": "The long-running operation metadata for UpdateLabelerPool.",
"id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UpdateProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata for the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1Barcode": {
"description": "Encodes the detailed information of a barcode.",
"id": "GoogleCloudDocumentaiV1Barcode",
"properties": {
"format": {
"description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.",
"type": "string"
},
"rawValue": {
"description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
"type": "string"
},
"valueFormat": {
"description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchDocumentsInputConfig": {
"description": "The common config to specify a set of documents used as input.",
"id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
"properties": {
"gcsDocuments": {
"$ref": "GoogleCloudDocumentaiV1GcsDocuments",
"description": "The set of documents individually specified on Cloud Storage."
},
"gcsPrefix": {
"$ref": "GoogleCloudDocumentaiV1GcsPrefix",
"description": "The set of documents that match the specified Cloud Storage `gcs_prefix`."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessMetadata": {
"description": "The long-running operation metadata for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1BatchProcessMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"individualProcessStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus"
},
"type": "array"
},
"state": {
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
],
"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"
},
"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"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": {
"description": "The status of a each individual document in the batch process.",
"id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus",
"properties": {
"humanReviewStatus": {
"$ref": "GoogleCloudDocumentaiV1HumanReviewStatus",
"description": "The status of human review on the processed document."
},
"inputGcsSource": {
"description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.",
"type": "string"
},
"outputGcsDestination": {
"description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status processing the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessRequest": {
"description": "Request message for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1BatchProcessRequest",
"properties": {
"documentOutputConfig": {
"$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig",
"description": "The output configuration for the BatchProcessDocuments method."
},
"inputDocuments": {
"$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
"description": "The input documents for the BatchProcessDocuments method."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
"type": "object"
},
"processOptions": {
"$ref": "GoogleCloudDocumentaiV1ProcessOptions",
"description": "Inference-time options for the process API"
},
"skipHumanReview": {
"deprecated": true,
"description": "Whether human review should be skipped for this request. Default to `false`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessResponse": {
"description": "Response message for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1BatchProcessResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "GoogleCloudDocumentaiV1BoundingPoly",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1NormalizedVertex"
},
"type": "array"
},
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1Vertex"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1CommonOperationMetadata": {
"description": "The common metadata for long running operations.",
"id": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"resource": {
"description": "A related resource to this operation.",
"type": "string"
},
"state": {
"description": "The state of the operation.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeleteProcessorMetadata": {
"description": "The long-running operation metadata for the DeleteProcessor method.",
"id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeleteProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeployProcessorVersionRequest": {
"description": "Request message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeployProcessorVersionRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1DeployProcessorVersionResponse": {
"description": "Response message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1DisableProcessorMetadata": {
"description": "The long-running operation metadata for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiV1DisableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DisableProcessorRequest": {
"description": "Request message for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiV1DisableProcessorRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1DisableProcessorResponse": {
"description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1DisableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1Document": {
"description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.",
"id": "GoogleCloudDocumentaiV1Document",
"properties": {
"blobAssets": {
"description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentBlobAsset"
},
"type": "array"
},
"chunkedDocument": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocument",
"description": "Document chunked based on chunking config."
},
"content": {
"description": "Optional. 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",
"type": "string"
},
"docid": {
"description": "Optional. An internal identifier for document. Should be loggable (no PII).",
"type": "string"
},
"documentLayout": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayout",
"description": "Parsed layout of the document."
},
"entities": {
"description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntity"
},
"type": "array"
},
"entitiesRevisionId": {
"description": "The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.",
"type": "string"
},
"entitiesRevisions": {
"description": "A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntitiesRevision"
},
"type": "array"
},
"entityRelations": {
"description": "Placeholder. Relationship among Document.entities.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntityRelation"
},
"type": "array"
},
"entityValidationOutput": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput",
"description": "The entity validation output for the document. This is the validation output for `document.entities` field."
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Any error that occurred while processing this document."
},
"mimeType": {
"description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).",
"type": "string"
},
"pages": {
"description": "Visual page layout for the Document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPage"
},
"type": "array"
},
"revisions": {
"description": "Placeholder. Revision history of this document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentRevision"
},
"type": "array"
},
"shardInfo": {
"$ref": "GoogleCloudDocumentaiV1DocumentShardInfo",
"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."
},
"text": {
"description": "Optional. UTF-8 encoded text in reading order from the document.",
"type": "string"
},
"textChanges": {
"description": "Placeholder. 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.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentTextChange"
},
"type": "array"
},
"textStyles": {
"deprecated": true,
"description": "Styles for the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentStyle"
},
"type": "array"
},
"uri": {
"description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentAnnotations": {
"description": "Represents the annotation of a block or a chunk.",
"id": "GoogleCloudDocumentaiV1DocumentAnnotations",
"properties": {
"description": {
"description": "The description of the content with this annotation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentBlobAsset": {
"description": "Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID.",
"id": "GoogleCloudDocumentaiV1DocumentBlobAsset",
"properties": {
"assetId": {
"description": "Optional. The id of the blob asset.",
"type": "string"
},
"content": {
"description": "Optional. The content of the blob asset, for example, image bytes.",
"format": "byte",
"type": "string"
},
"mimeType": {
"description": "The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocument": {
"description": "Represents the chunks that the document is divided into.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocument",
"properties": {
"chunks": {
"description": "List of chunks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk": {
"description": "Represents a chunk.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk",
"properties": {
"chunkFields": {
"description": "Chunk fields inside this chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField"
},
"type": "array"
},
"chunkId": {
"description": "ID of the chunk.",
"type": "string"
},
"content": {
"description": "Text content of the chunk.",
"type": "string"
},
"pageFooters": {
"description": "Page footers associated with the chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter"
},
"type": "array"
},
"pageHeaders": {
"description": "Page headers associated with the chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader"
},
"type": "array"
},
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the chunk."
},
"sourceBlockIds": {
"description": "Unused.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField": {
"description": "The chunk field in the chunk. A chunk field could be one of the various types (for example, image, table) supported.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField",
"properties": {
"imageChunkField": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField",
"description": "The image chunk field in the chunk."
},
"tableChunkField": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField",
"description": "The table chunk field in the chunk."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter": {
"description": "Represents the page footer associated with the chunk.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the footer."
},
"text": {
"description": "Footer in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader": {
"description": "Represents the page header associated with the chunk.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the header."
},
"text": {
"description": "Header in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan": {
"description": "Represents where the chunk starts and ends in the document.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan",
"properties": {
"pageEnd": {
"description": "Page where chunk ends in the document.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "Page where chunk starts in the document.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField": {
"description": "The image chunk field in the chunk.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField",
"properties": {
"annotations": {
"$ref": "GoogleCloudDocumentaiV1DocumentAnnotations",
"description": "Annotation of the image chunk field."
},
"blobAssetId": {
"description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.",
"type": "string"
},
"dataUri": {
"description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
"type": "string"
},
"gcsUri": {
"description": "Optional. Google Cloud Storage uri of the image.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField": {
"description": "The table chunk field in the chunk.",
"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField",
"properties": {
"annotations": {
"$ref": "GoogleCloudDocumentaiV1DocumentAnnotations",
"description": "Annotation of the table chunk field."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayout": {
"description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayout",
"properties": {
"blocks": {
"description": "List of blocks in the document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock": {
"description": "Represents a block. A block could be one of the various types (text, table, list) supported.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock",
"properties": {
"blockId": {
"description": "ID of the block.",
"type": "string"
},
"boundingBox": {
"$ref": "GoogleCloudDocumentaiV1BoundingPoly",
"description": "Identifies the bounding box for the block."
},
"imageBlock": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock",
"description": "Block consisting of image content."
},
"listBlock": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
"description": "Block consisting of list content/structure."
},
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
"description": "Page span of the block."
},
"tableBlock": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
"description": "Block consisting of table content/structure."
},
"textBlock": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
"description": "Block consisting of text content."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock": {
"description": "Represents an image type block.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock",
"properties": {
"annotations": {
"$ref": "GoogleCloudDocumentaiV1DocumentAnnotations",
"description": "Annotation of the image block."
},
"blobAssetId": {
"description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.",
"type": "string"
},
"dataUri": {
"description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
"type": "string"
},
"gcsUri": {
"description": "Optional. Google Cloud Storage uri of the image.",
"type": "string"
},
"imageText": {
"description": "Text extracted from the image using OCR or alt text describing the image.",
"type": "string"
},
"mimeType": {
"description": "Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": {
"description": "Represents a list type block.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
"properties": {
"listEntries": {
"description": "List entries that constitute a list block.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry"
},
"type": "array"
},
"type": {
"description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": {
"description": "Represents an entry in the list.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry",
"properties": {
"blocks": {
"description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": {
"description": "Represents where the block starts and ends in the document.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
"properties": {
"pageEnd": {
"description": "Page where block ends in the document.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "Page where block starts in the document.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": {
"description": "Represents a table type block.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
"properties": {
"annotations": {
"$ref": "GoogleCloudDocumentaiV1DocumentAnnotations",
"description": "Annotation of the table block."
},
"bodyRows": {
"description": "Body rows containing main table content.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
},
"type": "array"
},
"caption": {
"description": "Table caption/title.",
"type": "string"
},
"headerRows": {
"description": "Header rows at the top of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": {
"description": "Represents a cell in a table row.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell",
"properties": {
"blocks": {
"description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
},
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": {
"description": "Represents a row in a table.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow",
"properties": {
"cells": {
"description": "A table row is a list of table cells.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": {
"description": "Represents a text type block.",
"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
"properties": {
"annotations": {
"$ref": "GoogleCloudDocumentaiV1DocumentAnnotations",
"description": "Annotation of the text block."
},
"blocks": {
"description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
},
"text": {
"description": "Text content stored in the block.",
"type": "string"
},
"type": {
"description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentEntitiesRevision": {
"description": "Entity revision.",
"id": "GoogleCloudDocumentaiV1DocumentEntitiesRevision",
"properties": {
"entities": {
"description": "The entities in this revision.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntity"
},
"type": "array"
},
"entityValidationOutput": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput",
"description": "The entity validation output for this revision."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"description": "Optional. The history of this revision."
},
"revisionId": {
"description": "The revision id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentEntity": {
"description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.",
"id": "GoogleCloudDocumentaiV1DocumentEntity",
"properties": {
"confidence": {
"description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"id": {
"description": "Optional. Canonical id. This will be a unique value in the entity list for this document.",
"type": "string"
},
"mentionId": {
"description": "Optional. Deprecated. Use `id` field instead.",
"type": "string"
},
"mentionText": {
"description": "Optional. Text value of the entity, for example, `1600 Amphitheatre Pkwy`.",
"type": "string"
},
"method": {
"description": "Optional. Specifies how the entity's value is obtained.",
"enum": [
"METHOD_UNSPECIFIED",
"EXTRACT",
"DERIVE"
],
"enumDescriptions": [
"When the method is not specified, it should be treated as `EXTRACT`.",
"The entity's value is directly extracted as-is from the document text.",
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document."
],
"type": "string"
},
"normalizedValue": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue",
"description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (for example, address) is not supported for certain parsers. This field is also only populated for certain supported document types."
},
"pageAnchor": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageAnchor",
"description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
},
"properties": {
"description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntity"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"description": "Optional. The history of this annotation."
},
"redacted": {
"description": "Optional. Whether the entity will be redacted for de-identification purposes.",
"type": "boolean"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor",
"description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text."
},
"type": {
"description": "Required. Entity type from a schema, for example, `Address`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentEntityNormalizedValue": {
"description": "Parsed and normalized entity value.",
"id": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue",
"properties": {
"addressValue": {
"$ref": "GoogleTypePostalAddress",
"description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto"
},
"booleanValue": {
"description": "Boolean value. Can be used for entities with binary values, or for checkboxes.",
"type": "boolean"
},
"dateValue": {
"$ref": "GoogleTypeDate",
"description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto"
},
"datetimeValue": {
"$ref": "GoogleTypeDateTime",
"description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto"
},
"floatValue": {
"description": "Float value.",
"format": "float",
"type": "number"
},
"integerValue": {
"description": "Integer value.",
"format": "int32",
"type": "integer"
},
"moneyValue": {
"$ref": "GoogleTypeMoney",
"description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
},
"signatureValue": {
"description": "A signature - a graphical representation of a person's name, often used to sign a document.",
"type": "boolean"
},
"text": {
"description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - 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"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentEntityRelation": {
"description": "Relationship between Entities.",
"id": "GoogleCloudDocumentaiV1DocumentEntityRelation",
"properties": {
"objectId": {
"description": "Object entity id.",
"type": "string"
},
"relation": {
"description": "Relationship description.",
"type": "string"
},
"subjectId": {
"description": "Subject entity id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentEntityValidationOutput": {
"description": "The output of the validation given the document and the validation rules.",
"id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput",
"properties": {
"passAllRules": {
"description": "The overall result of the validation, true if all applicable rules are valid.",
"type": "boolean"
},
"validationResults": {
"description": "The result of each validation rule.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult": {
"description": "Validation result for a single validation rule.",
"id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult",
"properties": {
"rule": {
"description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`",
"type": "string"
},
"ruleDescription": {
"description": "The description of the validation rule.",
"type": "string"
},
"ruleName": {
"description": "The display name of the validation rule.",
"type": "string"
},
"validationDetails": {
"description": "The detailed information of the running the validation process using the entity from the document based on the validation rule.",
"type": "string"
},
"validationResultType": {
"description": "The result of the validation rule.",
"enum": [
"VALIDATION_RESULT_TYPE_UNSPECIFIED",
"VALIDATION_RESULT_TYPE_VALID",
"VALIDATION_RESULT_TYPE_INVALID",
"VALIDATION_RESULT_TYPE_SKIPPED",
"VALIDATION_RESULT_TYPE_NOT_APPLICABLE"
],
"enumDescriptions": [
"The validation result type is unspecified.",
"The validation is valid.",
"The validation is invalid.",
"The validation is skipped.",
"The validation is not applicable."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentOutputConfig": {
"description": "Config that controls the output of documents. All documents will be written as a JSON file.",
"id": "GoogleCloudDocumentaiV1DocumentOutputConfig",
"properties": {
"gcsOutputConfig": {
"$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig",
"description": "Output config to write the results to Cloud Storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig": {
"description": "The configuration used when outputting documents.",
"id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig",
"properties": {
"fieldMask": {
"description": "Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.",
"format": "google-fieldmask",
"type": "string"
},
"gcsUri": {
"description": "The Cloud Storage uri (a directory) of the output.",
"type": "string"
},
"shardingConfig": {
"$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig",
"description": "Specifies the sharding config for the output document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig": {
"description": "The sharding config for the output document.",
"id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig",
"properties": {
"pagesOverlap": {
"description": "The number of overlapping pages between consecutive shards.",
"format": "int32",
"type": "integer"
},
"pagesPerShard": {
"description": "The number of pages per shard.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPage": {
"description": "A page in a Document.",
"id": "GoogleCloudDocumentaiV1DocumentPage",
"properties": {
"blocks": {
"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": "GoogleCloudDocumentaiV1DocumentPageBlock"
},
"type": "array"
},
"detectedBarcodes": {
"description": "A list of detected barcodes.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode"
},
"type": "array"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"dimension": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDimension",
"description": "Physical dimension of the page."
},
"formFields": {
"description": "A list of visually detected form fields on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageFormField"
},
"type": "array"
},
"image": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageImage",
"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."
},
"imageQualityScores": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageImageQualityScores",
"description": "Image quality scores."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for 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": "GoogleCloudDocumentaiV1DocumentPageLine"
},
"type": "array"
},
"pageNumber": {
"description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.",
"format": "int32",
"type": "integer"
},
"paragraphs": {
"description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageParagraph"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"deprecated": true,
"description": "The history of this page."
},
"symbols": {
"description": "A list of visually detected symbols on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageSymbol"
},
"type": "array"
},
"tables": {
"description": "A list of visually detected tables on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageTable"
},
"type": "array"
},
"tokens": {
"description": "A list of visually detected tokens on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageToken"
},
"type": "array"
},
"transforms": {
"description": "Transformation matrices that were applied to the original document image to produce Page.image.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageMatrix"
},
"type": "array"
},
"visualElements": {
"description": "A list of detected non-text visual elements, for example, checkbox, signature etc. on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageVisualElement"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageAnchor": {
"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": "GoogleCloudDocumentaiV1DocumentPageAnchor",
"properties": {
"pageRefs": {
"description": "One or more references to visual page elements",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageAnchorPageRef": {
"description": "Represents a weak reference to a page element within a document.",
"id": "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1BoundingPoly",
"description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to."
},
"confidence": {
"description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"layoutId": {
"deprecated": true,
"description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
"type": "string"
},
"layoutType": {
"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"
],
"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"
},
"page": {
"description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageBlock": {
"description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"id": "GoogleCloudDocumentaiV1DocumentPageBlock",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for Block."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageDetectedBarcode": {
"description": "A detected barcode.",
"id": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode",
"properties": {
"barcode": {
"$ref": "GoogleCloudDocumentaiV1Barcode",
"description": "Detailed barcode information of the DetectedBarcode."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for DetectedBarcode."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageDetectedLanguage": {
"description": "Detected language for a structural component.",
"id": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage",
"properties": {
"confidence": {
"description": "Confidence of detected language. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"languageCode": {
"description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageDimension": {
"description": "Dimension for the page.",
"id": "GoogleCloudDocumentaiV1DocumentPageDimension",
"properties": {
"height": {
"description": "Page height.",
"format": "float",
"type": "number"
},
"unit": {
"description": "Dimension unit.",
"type": "string"
},
"width": {
"description": "Page width.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageFormField": {
"description": "A form field detected on the page.",
"id": "GoogleCloudDocumentaiV1DocumentPageFormField",
"properties": {
"correctedKeyText": {
"description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.",
"type": "string"
},
"correctedValueText": {
"description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.",
"type": "string"
},
"fieldName": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for the FormField name. For example, `Address`, `Email`, `Grand total`, `Phone number`, etc."
},
"fieldValue": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for the FormField value."
},
"nameDetectedLanguages": {
"description": "A list of detected languages for name together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"description": "The history of this annotation."
},
"valueDetectedLanguages": {
"description": "A list of detected languages for value together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"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"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageImage": {
"description": "Rendered image contents for this page.",
"id": "GoogleCloudDocumentaiV1DocumentPageImage",
"properties": {
"content": {
"description": "Raw byte content of the image.",
"format": "byte",
"type": "string"
},
"height": {
"description": "Height of the image in pixels.",
"format": "int32",
"type": "integer"
},
"mimeType": {
"description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.",
"type": "string"
},
"width": {
"description": "Width of the image in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageImageQualityScores": {
"description": "Image quality scores for the page image.",
"id": "GoogleCloudDocumentaiV1DocumentPageImageQualityScores",
"properties": {
"detectedDefects": {
"description": "A list of detected defects.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect"
},
"type": "array"
},
"qualityScore": {
"description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect": {
"description": "Image Quality Defects",
"id": "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect",
"properties": {
"confidence": {
"description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.",
"format": "float",
"type": "number"
},
"type": {
"description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageLayout": {
"description": "Visual element describing a layout unit on a page.",
"id": "GoogleCloudDocumentaiV1DocumentPageLayout",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1BoundingPoly",
"description": "The bounding polygon for the Layout."
},
"confidence": {
"description": "Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"orientation": {
"description": "Detected orientation for the Layout.",
"enum": [
"ORIENTATION_UNSPECIFIED",
"PAGE_UP",
"PAGE_RIGHT",
"PAGE_DOWN",
"PAGE_LEFT"
],
"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."
],
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageLine": {
"description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
"id": "GoogleCloudDocumentaiV1DocumentPageLine",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for Line."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageMatrix": {
"description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
"id": "GoogleCloudDocumentaiV1DocumentPageMatrix",
"properties": {
"cols": {
"description": "Number of columns in the matrix.",
"format": "int32",
"type": "integer"
},
"data": {
"description": "The matrix data.",
"format": "byte",
"type": "string"
},
"rows": {
"description": "Number of rows in the matrix.",
"format": "int32",
"type": "integer"
},
"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",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageParagraph": {
"description": "A collection of lines that a human would perceive as a paragraph.",
"id": "GoogleCloudDocumentaiV1DocumentPageParagraph",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for Paragraph."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageSymbol": {
"description": "A detected symbol.",
"id": "GoogleCloudDocumentaiV1DocumentPageSymbol",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for Symbol."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageTable": {
"description": "A table representation similar to HTML table structure.",
"id": "GoogleCloudDocumentaiV1DocumentPageTable",
"properties": {
"bodyRows": {
"description": "Body rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableRow"
},
"type": "array"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"headerRows": {
"description": "Header rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableRow"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for Table."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"deprecated": true,
"description": "The history of this table."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageTableTableCell": {
"description": "A cell representation inside the table.",
"id": "GoogleCloudDocumentaiV1DocumentPageTableTableCell",
"properties": {
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for TableCell."
},
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageTableTableRow": {
"description": "A row of table cells.",
"id": "GoogleCloudDocumentaiV1DocumentPageTableTableRow",
"properties": {
"cells": {
"description": "Cells that make up this row.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableCell"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageToken": {
"description": "A detected token.",
"id": "GoogleCloudDocumentaiV1DocumentPageToken",
"properties": {
"detectedBreak": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak",
"description": "Detected break at the end of a Token."
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for Token."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
},
"styleInfo": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo",
"description": "Text style attributes."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak": {
"description": "Detected break at the end of a Token.",
"id": "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak",
"properties": {
"type": {
"description": "Detected break type.",
"enum": [
"TYPE_UNSPECIFIED",
"SPACE",
"WIDE_SPACE",
"HYPHEN"
],
"enumDescriptions": [
"Unspecified break type.",
"A single whitespace.",
"A wider whitespace.",
"A hyphen that indicates that a token has been split across lines."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo": {
"description": "Font and other text style attributes.",
"id": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Color of the background."
},
"bold": {
"description": "Whether the text is bold (equivalent to font_weight is at least `700`).",
"type": "boolean"
},
"fontSize": {
"description": "Font size in points (`1` point is `\u00b9\u2044\u2087\u2082` inches).",
"format": "int32",
"type": "integer"
},
"fontType": {
"description": "Name or style of the font.",
"type": "string"
},
"fontWeight": {
"description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.",
"format": "int32",
"type": "integer"
},
"handwritten": {
"description": "Whether the text is handwritten.",
"type": "boolean"
},
"italic": {
"description": "Whether the text is italic.",
"type": "boolean"
},
"letterSpacing": {
"description": "Letter spacing in points.",
"format": "double",
"type": "number"
},
"pixelFontSize": {
"description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ \u00f7 `72.0`.",
"format": "double",
"type": "number"
},
"smallcaps": {
"description": "Whether the text is in small caps. This feature is not supported yet.",
"type": "boolean"
},
"strikeout": {
"description": "Whether the text is strikethrough. This feature is not supported yet.",
"type": "boolean"
},
"subscript": {
"description": "Whether the text is a subscript. This feature is not supported yet.",
"type": "boolean"
},
"superscript": {
"description": "Whether the text is a superscript. This feature is not supported yet.",
"type": "boolean"
},
"textColor": {
"$ref": "GoogleTypeColor",
"description": "Color of the text."
},
"underlined": {
"description": "Whether the text is underlined.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentPageVisualElement": {
"description": "Detected non-text visual elements, for example, checkbox, signature etc. on the page.",
"id": "GoogleCloudDocumentaiV1DocumentPageVisualElement",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
"description": "Layout for VisualElement."
},
"type": {
"description": "Type of the VisualElement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentProvenance": {
"description": "Structure to identify provenance relationships between annotations in different revisions.",
"id": "GoogleCloudDocumentaiV1DocumentProvenance",
"properties": {
"id": {
"deprecated": true,
"description": "The Id of this operation. Needs to be unique within the scope of the revision.",
"format": "int32",
"type": "integer"
},
"parents": {
"description": "References to the original elements that are replaced.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenanceParent"
},
"type": "array"
},
"revision": {
"deprecated": true,
"description": "The index of the revision that produced this element.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "The type of provenance operation.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"ADD",
"REMOVE",
"UPDATE",
"REPLACE",
"EVAL_REQUESTED",
"EVAL_APPROVED",
"EVAL_SKIPPED"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
true,
true,
true
],
"enumDescriptions": [
"Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.",
"Add an element.",
"Remove an element identified by `parent`.",
"Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.",
"Currently unused. Replace an element identified by `parent`.",
"Deprecated. Request human review for the element identified by `parent`.",
"Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.",
"Deprecated. Element is skipped in the validation process."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentProvenanceParent": {
"description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.",
"id": "GoogleCloudDocumentaiV1DocumentProvenanceParent",
"properties": {
"id": {
"deprecated": true,
"description": "The id of the parent provenance.",
"format": "int32",
"type": "integer"
},
"index": {
"description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.",
"format": "int32",
"type": "integer"
},
"revision": {
"description": "The index of the index into current revision's parent_ids list.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentRevision": {
"description": "Contains past or forward revisions of this document.",
"id": "GoogleCloudDocumentaiV1DocumentRevision",
"properties": {
"agent": {
"description": "If the change was made by a person specify the name or id of that person.",
"type": "string"
},
"createTime": {
"description": "The time that the revision was created, internally generated by doc proto storage at the time of create.",
"format": "google-datetime",
"type": "string"
},
"humanReview": {
"$ref": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview",
"description": "Human Review information of this revision."
},
"id": {
"description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
"type": "string"
},
"parent": {
"deprecated": true,
"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": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"parentIds": {
"description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.",
"items": {
"type": "string"
},
"type": "array"
},
"processor": {
"description": "If the annotation was made by processor identify the processor by its resource name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentRevisionHumanReview": {
"description": "Human Review information of the document.",
"id": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview",
"properties": {
"state": {
"description": "Human review state. For example, `requested`, `succeeded`, `rejected`.",
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentSchema": {
"description": "The schema defines the output of the processed document by a processor.",
"id": "GoogleCloudDocumentaiV1DocumentSchema",
"properties": {
"description": {
"description": "Description of the schema.",
"type": "string"
},
"displayName": {
"description": "Display name to show users.",
"type": "string"
},
"documentPrompt": {
"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
"type": "string"
},
"entityTypes": {
"description": "Entity types of the schema.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityType"
},
"type": "array"
},
"metadata": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchemaMetadata",
"description": "Metadata of the schema."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentSchemaEntityType": {
"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.",
"id": "GoogleCloudDocumentaiV1DocumentSchemaEntityType",
"properties": {
"baseTypes": {
"description": "The entity type that this type is derived from. For now, one and only one should be set.",
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "User defined name for the type.",
"type": "string"
},
"enumValues": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues",
"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
},
"name": {
"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
"type": "string"
},
"properties": {
"description": "Description the nested structure, or composition of an entity.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues": {
"description": "Defines the a list of enum values.",
"id": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues",
"properties": {
"values": {
"description": "The individual values that this enum values type can include.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty": {
"description": "Defines properties that can be part of the entity type.",
"id": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty",
"properties": {
"displayName": {
"description": "User defined name for the property.",
"type": "string"
},
"method": {
"description": "Specifies how the entity's value is obtained.",
"enum": [
"METHOD_UNSPECIFIED",
"EXTRACT",
"DERIVE",
"RELAXED_EXTRACT"
],
"enumDescriptions": [
"Unspecified method. It defaults to `EXTRACT`.",
"The entity's value is directly extracted as-is from the document text.",
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document.",
"Attempts to extract the position and value as-is from the document text. If the value cannot be grounded in the text, it falls back to derivation through inference, for both position and value. Note: The inference fallback is currently only supported for boolean entities."
],
"type": "string"
},
"name": {
"description": "The name of the property. Follows the same guidelines as the EntityType name.",
"type": "string"
},
"occurrenceType": {
"description": "Occurrence type limits the number of instances an entity type appears in the document.",
"enum": [
"OCCURRENCE_TYPE_UNSPECIFIED",
"OPTIONAL_ONCE",
"OPTIONAL_MULTIPLE",
"REQUIRED_ONCE",
"REQUIRED_MULTIPLE"
],
"enumDescriptions": [
"Unspecified occurrence type.",
"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.",
"The entity type will appear zero or multiple times.",
"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.",
"The entity type will appear once or more times."
],
"type": "string"
},
"valueType": {
"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentSchemaMetadata": {
"description": "Metadata for global schema behavior.",
"id": "GoogleCloudDocumentaiV1DocumentSchemaMetadata",
"properties": {
"documentAllowMultipleLabels": {
"description": "If true, on a given page, there can be multiple `document` annotations covering it.",
"type": "boolean"
},
"documentSplitter": {
"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).",
"type": "boolean"
},
"prefixedNamingOnProperties": {
"description": "If set, all the nested entities must be prefixed with the parents.",
"type": "boolean"
},
"skipNamingValidation": {
"description": "If set, this will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentShardInfo": {
"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.",
"id": "GoogleCloudDocumentaiV1DocumentShardInfo",
"properties": {
"pageOffset": {
"description": "The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.",
"format": "int32",
"type": "integer"
},
"shardCount": {
"description": "Total number of shards.",
"format": "int64",
"type": "string"
},
"shardIndex": {
"description": "The 0-based index of this shard.",
"format": "int64",
"type": "string"
},
"textOffset": {
"description": "The index of the first character in Document.text in the overall document global text.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentStyle": {
"description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
"id": "GoogleCloudDocumentaiV1DocumentStyle",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Text background color."
},
"color": {
"$ref": "GoogleTypeColor",
"description": "Text color."
},
"fontFamily": {
"description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp",
"type": "string"
},
"fontSize": {
"$ref": "GoogleCloudDocumentaiV1DocumentStyleFontSize",
"description": "Font size."
},
"fontWeight": {
"description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.",
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
},
"textDecoration": {
"description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ",
"type": "string"
},
"textStyle": {
"description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentStyleFontSize": {
"description": "Font size with unit.",
"id": "GoogleCloudDocumentaiV1DocumentStyleFontSize",
"properties": {
"size": {
"description": "Font size for the text.",
"format": "float",
"type": "number"
},
"unit": {
"description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentTextAnchor": {
"description": "Text reference indexing into the Document.text.",
"id": "GoogleCloudDocumentaiV1DocumentTextAnchor",
"properties": {
"content": {
"description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.",
"type": "string"
},
"textSegments": {
"description": "The text segments from the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment": {
"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",
"id": "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment",
"properties": {
"endIndex": {
"description": "TextSegment half open end UTF-8 char index in the Document.text.",
"format": "int64",
"type": "string"
},
"startIndex": {
"description": "TextSegment start UTF-8 char index in the Document.text.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DocumentTextChange": {
"description": "This message is used for text changes aka. OCR corrections.",
"id": "GoogleCloudDocumentaiV1DocumentTextChange",
"properties": {
"changedText": {
"description": "The text that replaces the text identified in the `text_anchor`.",
"type": "string"
},
"provenance": {
"deprecated": true,
"description": "The history of this annotation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1DocumentProvenance"
},
"type": "array"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor",
"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."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1Documents": {
"description": "A set of inline documents.",
"id": "GoogleCloudDocumentaiV1Documents",
"properties": {
"documents": {
"description": "The list of documents.",
"items": {
"$ref": "GoogleCloudDocumentaiV1Document"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EnableProcessorMetadata": {
"description": "The long-running operation metadata for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiV1EnableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EnableProcessorRequest": {
"description": "Request message for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiV1EnableProcessorRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1EnableProcessorResponse": {
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1EnableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata": {
"description": "Metadata of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest": {
"description": "Evaluates the given ProcessorVersion against the supplied documents.",
"id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest",
"properties": {
"evaluationDocuments": {
"$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
"description": "Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": {
"description": "Response of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse",
"properties": {
"evaluation": {
"description": "The resource name of the created evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1Evaluation": {
"description": "An evaluation of a ProcessorVersion's performance.",
"id": "GoogleCloudDocumentaiV1Evaluation",
"properties": {
"allEntitiesMetrics": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics",
"description": "Metrics for all the entities in aggregate."
},
"createTime": {
"description": "The time that the evaluation was created.",
"format": "google-datetime",
"type": "string"
},
"documentCounters": {
"$ref": "GoogleCloudDocumentaiV1EvaluationCounters",
"description": "Counters for the documents used in the evaluation."
},
"entityMetrics": {
"additionalProperties": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics"
},
"description": "Metrics across confidence levels, for different entities.",
"type": "object"
},
"kmsKeyName": {
"description": "The KMS key name used for encryption.",
"type": "string"
},
"kmsKeyVersionName": {
"description": "The KMS key version with which data is encrypted.",
"type": "string"
},
"name": {
"description": "The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`",
"type": "string"
},
"revisions": {
"description": "Contains all revisions of the evaluation, excluding the latest one.",
"items": {
"$ref": "GoogleCloudDocumentaiV1EvaluationEvaluationRevision"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics": {
"description": "Evaluations metrics, at a specific confidence level.",
"id": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics",
"properties": {
"confidenceLevel": {
"description": "The confidence level.",
"format": "float",
"type": "number"
},
"metrics": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMetrics",
"description": "The metrics at the specific confidence level."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluationCounters": {
"description": "Evaluation counters for the documents that were used.",
"id": "GoogleCloudDocumentaiV1EvaluationCounters",
"properties": {
"evaluatedDocumentsCount": {
"description": "How many documents were used in the evaluation.",
"format": "int32",
"type": "integer"
},
"failedDocumentsCount": {
"description": "How many documents were not included in the evaluation as Document AI failed to process them.",
"format": "int32",
"type": "integer"
},
"inputDocumentsCount": {
"description": "How many documents were sent for evaluation.",
"format": "int32",
"type": "integer"
},
"invalidDocumentsCount": {
"description": "How many documents were not included in the evaluation as they didn't pass validation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluationEvaluationRevision": {
"description": "A revision of the evaluation.",
"id": "GoogleCloudDocumentaiV1EvaluationEvaluationRevision",
"properties": {
"allEntitiesMetrics": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics",
"description": "Output only. Metrics for all the entities in aggregate.",
"readOnly": true
},
"documentCounters": {
"$ref": "GoogleCloudDocumentaiV1EvaluationCounters",
"description": "Output only. Counters for the documents used in the evaluation.",
"readOnly": true
},
"entityMetrics": {
"additionalProperties": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics"
},
"description": "Output only. Metrics across confidence levels, for different entities.",
"readOnly": true,
"type": "object"
},
"revisionId": {
"description": "Output only. The revision ID of the evaluation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluationMetrics": {
"description": "Evaluation metrics, either in aggregate or about a specific entity.",
"id": "GoogleCloudDocumentaiV1EvaluationMetrics",
"properties": {
"f1Score": {
"description": "The calculated F1 score.",
"format": "float",
"type": "number"
},
"falseNegativesCount": {
"description": "The amount of false negatives.",
"format": "int32",
"type": "integer"
},
"falsePositivesCount": {
"description": "The amount of false positives.",
"format": "int32",
"type": "integer"
},
"groundTruthDocumentCount": {
"description": "The amount of documents with a ground truth occurrence.",
"format": "int32",
"type": "integer"
},
"groundTruthOccurrencesCount": {
"description": "The amount of occurrences in ground truth documents.",
"format": "int32",
"type": "integer"
},
"precision": {
"description": "The calculated precision.",
"format": "float",
"type": "number"
},
"predictedDocumentCount": {
"description": "The amount of documents with a predicted occurrence.",
"format": "int32",
"type": "integer"
},
"predictedOccurrencesCount": {
"description": "The amount of occurrences in predicted documents.",
"format": "int32",
"type": "integer"
},
"recall": {
"description": "The calculated recall.",
"format": "float",
"type": "number"
},
"totalDocumentsCount": {
"description": "The amount of documents that had an occurrence of this label.",
"format": "int32",
"type": "integer"
},
"truePositivesCount": {
"description": "The amount of true positives.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics": {
"description": "Metrics across multiple confidence levels.",
"id": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics",
"properties": {
"auprc": {
"description": "The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.",
"format": "float",
"type": "number"
},
"auprcExact": {
"description": "The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.",
"format": "float",
"type": "number"
},
"confidenceLevelMetrics": {
"description": "Metrics across confidence levels with fuzzy matching enabled.",
"items": {
"$ref": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics"
},
"type": "array"
},
"confidenceLevelMetricsExact": {
"description": "Metrics across confidence levels with only exact matching.",
"items": {
"$ref": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics"
},
"type": "array"
},
"estimatedCalibrationError": {
"description": "The Estimated Calibration Error (ECE) of the confidence of the predicted entities.",
"format": "float",
"type": "number"
},
"estimatedCalibrationErrorExact": {
"description": "The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.",
"format": "float",
"type": "number"
},
"metricsType": {
"description": "The metrics type for the label.",
"enum": [
"METRICS_TYPE_UNSPECIFIED",
"AGGREGATE"
],
"enumDescriptions": [
"The metrics type is unspecified. By default, metrics without a particular specification are for leaf entity types (i.e., top-level entity types without child types, or child types which are not parent types themselves).",
"Indicates whether metrics for this particular label type represent an aggregate of metrics for other types instead of being based on actual TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf) entity types are an aggregate of metrics for their children."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluationReference": {
"description": "Gives a short summary of an evaluation, and links to the evaluation itself.",
"id": "GoogleCloudDocumentaiV1EvaluationReference",
"properties": {
"aggregateMetrics": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMetrics",
"description": "An aggregate of the statistics for the evaluation with fuzzy matching on."
},
"aggregateMetricsExact": {
"$ref": "GoogleCloudDocumentaiV1EvaluationMetrics",
"description": "An aggregate of the statistics for the evaluation with fuzzy matching off."
},
"evaluation": {
"description": "The resource name of the evaluation.",
"type": "string"
},
"operation": {
"description": "The resource name of the Long Running Operation for the evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1FetchProcessorTypesResponse": {
"description": "Response message for the FetchProcessorTypes method.",
"id": "GoogleCloudDocumentaiV1FetchProcessorTypesResponse",
"properties": {
"processorTypes": {
"description": "The list of processor types.",
"items": {
"$ref": "GoogleCloudDocumentaiV1ProcessorType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1GcsDocument": {
"description": "Specifies a document stored on Cloud Storage.",
"id": "GoogleCloudDocumentaiV1GcsDocument",
"properties": {
"gcsUri": {
"description": "The Cloud Storage object uri.",
"type": "string"
},
"mimeType": {
"description": "An IANA MIME type (RFC6838) of the content.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1GcsDocuments": {
"description": "Specifies a set of documents on Cloud Storage.",
"id": "GoogleCloudDocumentaiV1GcsDocuments",
"properties": {
"documents": {
"description": "The list of documents.",
"items": {
"$ref": "GoogleCloudDocumentaiV1GcsDocument"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1GcsPrefix": {
"description": "Specifies all documents on Cloud Storage with a common prefix.",
"id": "GoogleCloudDocumentaiV1GcsPrefix",
"properties": {
"gcsUriPrefix": {
"description": "The URI prefix.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1GenerateSchemaVersionRequest": {
"description": "Request message for GenerateSchemaVersion.",
"id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest",
"properties": {
"baseSchemaVersion": {
"description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
"type": "string"
},
"gcsDocuments": {
"$ref": "GoogleCloudDocumentaiV1GcsDocuments",
"description": "The set of documents placed on Cloud Storage."
},
"gcsPrefix": {
"$ref": "GoogleCloudDocumentaiV1GcsPrefix",
"description": "The common prefix of documents placed on Cloud Storage."
},
"generateSchemaVersionParams": {
"$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams",
"description": "Optional. User specified parameters for the schema generation."
},
"inlineDocuments": {
"$ref": "GoogleCloudDocumentaiV1Documents",
"description": "The set of documents specified inline. For each document, its `uri` or `content` field must be set."
},
"rawDocuments": {
"$ref": "GoogleCloudDocumentaiV1RawDocuments",
"description": "The set of raw documents."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams": {
"description": "The parameters for the schema generation.",
"id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams",
"properties": {
"history": {
"$ref": "GoogleCloudDocumentaiV1SchemaGenerationHistory",
"description": "Optional. Previous prompt-answers in a chronological order."
},
"prompt": {
"description": "Optional. The prompt used for the schema generation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1GenerateSchemaVersionResponse": {
"description": "Response message for GenerateSchemaVersion.",
"id": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse",
"properties": {
"schemaVersion": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion",
"description": "The schema version generated by the model."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1HumanReviewStatus": {
"description": "The status of human review on a processed document.",
"id": "GoogleCloudDocumentaiV1HumanReviewStatus",
"properties": {
"humanReviewOperation": {
"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
"type": "string"
},
"state": {
"description": "The state of human review on the processing request.",
"enum": [
"STATE_UNSPECIFIED",
"SKIPPED",
"VALIDATION_PASSED",
"IN_PROGRESS",
"ERROR"
],
"enumDescriptions": [
"Human review state is unspecified. Most likely due to an internal error.",
"Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.",
"Human review validation is triggered and passed, so no review is needed.",
"Human review validation is triggered and the document is under review.",
"Some error happened during triggering human review, see the state_message for details."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the human review state.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ListEvaluationsResponse": {
"description": "The response from `ListEvaluations`.",
"id": "GoogleCloudDocumentaiV1ListEvaluationsResponse",
"properties": {
"evaluations": {
"description": "The evaluations requested.",
"items": {
"$ref": "GoogleCloudDocumentaiV1Evaluation"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ListProcessorTypesResponse": {
"description": "Response message for the ListProcessorTypes method.",
"id": "GoogleCloudDocumentaiV1ListProcessorTypesResponse",
"properties": {
"nextPageToken": {
"description": "Points to the next page, otherwise empty.",
"type": "string"
},
"processorTypes": {
"description": "The processor types.",
"items": {
"$ref": "GoogleCloudDocumentaiV1ProcessorType"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ListProcessorVersionsResponse": {
"description": "Response message for the ListProcessorVersions method.",
"id": "GoogleCloudDocumentaiV1ListProcessorVersionsResponse",
"properties": {
"nextPageToken": {
"description": "Points to the next processor, otherwise empty.",
"type": "string"
},
"processorVersions": {
"description": "The list of processors.",
"items": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ListProcessorsResponse": {
"description": "Response message for the ListProcessors method.",
"id": "GoogleCloudDocumentaiV1ListProcessorsResponse",
"properties": {
"nextPageToken": {
"description": "Points to the next processor, otherwise empty.",
"type": "string"
},
"processors": {
"description": "The list of processors.",
"items": {
"$ref": "GoogleCloudDocumentaiV1Processor"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ListSchemaVersionsResponse": {
"description": "Response message for ListSchemaVersions.",
"id": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse",
"properties": {
"nextPageToken": {
"description": "Points to the next SchemaVersion, otherwise empty.",
"type": "string"
},
"schemaVersions": {
"description": "The list of SchemaVersions.",
"items": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ListSchemasResponse": {
"description": "Response message for ListSchemas.",
"id": "GoogleCloudDocumentaiV1ListSchemasResponse",
"properties": {
"nextPageToken": {
"description": "Points to the next Schema, otherwise empty.",
"type": "string"
},
"schemas": {
"description": "The list of Schemas.",
"items": {
"$ref": "GoogleCloudDocumentaiV1NextSchema"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1NextSchema": {
"description": "NextSchema is a collection of SchemaVersions.",
"id": "GoogleCloudDocumentaiV1NextSchema",
"properties": {
"createTime": {
"description": "Output only. The time when the Schema was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The user-defined name of the Schema.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The {{gcp_name_short}} labels for the Schema.",
"type": "object"
},
"name": {
"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
"type": "string"
},
"updateTime": {
"description": "Output only. The time when the Schema was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1NormalizedVertex": {
"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.",
"id": "GoogleCloudDocumentaiV1NormalizedVertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "float",
"type": "number"
},
"y": {
"description": "Y coordinate (starts from the top of the image).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1OcrConfig": {
"description": "Config for Document OCR.",
"id": "GoogleCloudDocumentaiV1OcrConfig",
"properties": {
"advancedOcrOptions": {
"description": "A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.",
"items": {
"type": "string"
},
"type": "array"
},
"computeStyleInfo": {
"deprecated": true,
"description": "Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead.",
"type": "boolean"
},
"disableCharacterBoxesDetection": {
"description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.",
"type": "boolean"
},
"enableImageQualityScores": {
"description": "Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call.",
"type": "boolean"
},
"enableNativePdfParsing": {
"description": "Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.",
"type": "boolean"
},
"enableSymbol": {
"description": "Includes symbol level OCR information if set to true.",
"type": "boolean"
},
"hints": {
"$ref": "GoogleCloudDocumentaiV1OcrConfigHints",
"description": "Hints for the OCR model."
},
"premiumFeatures": {
"$ref": "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures",
"description": "Configurations for premium OCR features."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1OcrConfigHints": {
"description": "Hints for OCR Engine",
"id": "GoogleCloudDocumentaiV1OcrConfigHints",
"properties": {
"languageHints": {
"description": "List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting 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).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1OcrConfigPremiumFeatures": {
"description": "Configurations for premium OCR features.",
"id": "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures",
"properties": {
"computeStyleInfo": {
"description": "Turn on font identification model and return font style information.",
"type": "boolean"
},
"enableMathOcr": {
"description": "Turn on the model that can extract LaTeX math formulas.",
"type": "boolean"
},
"enableSelectionMarkDetection": {
"description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessOptions": {
"description": "Options for Process API",
"id": "GoogleCloudDocumentaiV1ProcessOptions",
"properties": {
"fromEnd": {
"description": "Only process certain pages from the end, same as above.",
"format": "int32",
"type": "integer"
},
"fromStart": {
"description": "Only process certain pages from the start. Process all if the document has fewer pages.",
"format": "int32",
"type": "integer"
},
"individualPageSelector": {
"$ref": "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector",
"description": "Which pages to process (1-indexed)."
},
"layoutConfig": {
"$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig",
"description": "Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types."
},
"ocrConfig": {
"$ref": "GoogleCloudDocumentaiV1OcrConfig",
"description": "Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types."
},
"schemaOverride": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchema",
"description": "Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector": {
"description": "A list of individual page numbers.",
"id": "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector",
"properties": {
"pages": {
"description": "Optional. Indices of the pages (starting from 1).",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig": {
"description": "Serving config for layout parser processor.",
"id": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig",
"properties": {
"chunkingConfig": {
"$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig",
"description": "Optional. Config for chunking in layout parser processor."
},
"enableImageAnnotation": {
"description": "Optional. Whether to include image annotations in layout parser response.",
"type": "boolean"
},
"enableTableAnnotation": {
"description": "Optional. Whether to include table annotations in layout parser response.",
"type": "boolean"
},
"returnBoundingBoxes": {
"description": "Optional. Whether to include bounding boxes in layout parser processor response.",
"type": "boolean"
},
"returnImages": {
"description": "Optional. Whether to include images in layout parser processor response.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig": {
"description": "Serving config for chunking.",
"id": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig",
"properties": {
"chunkSize": {
"description": "Optional. The chunk sizes to use when splitting documents, in order of level.",
"format": "int32",
"type": "integer"
},
"includeAncestorHeadings": {
"description": "Optional. Whether or not to include ancestor headings when splitting.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessRequest": {
"description": "Request message for the ProcessDocument method.",
"id": "GoogleCloudDocumentaiV1ProcessRequest",
"properties": {
"fieldMask": {
"description": "Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.",
"format": "google-fieldmask",
"type": "string"
},
"gcsDocument": {
"$ref": "GoogleCloudDocumentaiV1GcsDocument",
"description": "A raw document on Google Cloud Storage."
},
"imagelessMode": {
"description": "Optional. Option to remove images from the document.",
"type": "boolean"
},
"inlineDocument": {
"$ref": "GoogleCloudDocumentaiV1Document",
"description": "An inline document proto."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
"type": "object"
},
"processOptions": {
"$ref": "GoogleCloudDocumentaiV1ProcessOptions",
"description": "Inference-time options for the process API"
},
"rawDocument": {
"$ref": "GoogleCloudDocumentaiV1RawDocument",
"description": "A raw document content (bytes)."
},
"skipHumanReview": {
"deprecated": true,
"description": "Whether human review should be skipped for this request. Default to `false`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessResponse": {
"description": "Response message for the ProcessDocument method.",
"id": "GoogleCloudDocumentaiV1ProcessResponse",
"properties": {
"document": {
"$ref": "GoogleCloudDocumentaiV1Document",
"description": "The document payload, will populate fields based on the processor's behavior."
},
"humanReviewStatus": {
"$ref": "GoogleCloudDocumentaiV1HumanReviewStatus",
"description": "The status of human review on the processed document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1Processor": {
"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
"id": "GoogleCloudDocumentaiV1Processor",
"properties": {
"activeSchemaVersion": {
"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
"type": "string"
},
"createTime": {
"description": "Output only. The time the processor was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"defaultProcessorVersion": {
"description": "The default processor version.",
"type": "string"
},
"displayName": {
"description": "The display name of the processor.",
"type": "string"
},
"kmsKeyName": {
"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.",
"type": "string"
},
"name": {
"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`",
"readOnly": true,
"type": "string"
},
"processEndpoint": {
"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.",
"readOnly": true,
"type": "string"
},
"processorVersionAliases": {
"description": "Output only. The processor version aliases.",
"items": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersionAlias"
},
"readOnly": true,
"type": "array"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Output only. The state of the processor.",
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"DISABLED",
"ENABLING",
"DISABLING",
"CREATING",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"The processor is in an unspecified state.",
"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.",
"The processor is disabled.",
"The processor is being enabled, will become `ENABLED` if successful.",
"The processor is being disabled, will become `DISABLED` if successful.",
"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.",
"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.",
"The processor is being deleted, will be removed if successful."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorType": {
"description": "A processor type is responsible for performing a certain document understanding task on a certain type of document.",
"id": "GoogleCloudDocumentaiV1ProcessorType",
"properties": {
"allowCreation": {
"description": "Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.",
"type": "boolean"
},
"availableLocations": {
"description": "The locations in which this processor is available.",
"items": {
"$ref": "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo"
},
"type": "array"
},
"category": {
"description": "The processor category, used by UI to group processor types.",
"type": "string"
},
"launchStage": {
"description": "Launch stage of the processor type",
"enum": [
"LAUNCH_STAGE_UNSPECIFIED",
"UNIMPLEMENTED",
"PRELAUNCH",
"EARLY_ACCESS",
"ALPHA",
"BETA",
"GA",
"DEPRECATED"
],
"enumDescriptions": [
"Do not use this default value.",
"The feature is not yet implemented. Users can not use it.",
"Prelaunch features are hidden from users and are only visible internally.",
"Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.",
"Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.",
"Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.",
"GA features are open to all developers and are considered stable and fully qualified for production use.",
"Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation."
],
"type": "string"
},
"name": {
"description": "The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`",
"type": "string"
},
"sampleDocumentUris": {
"description": "A set of Cloud Storage URIs of sample documents for this processor.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorTypeLocationInfo": {
"description": "The location information about where the processor is available.",
"id": "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo",
"properties": {
"locationId": {
"description": "The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorVersion": {
"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.",
"id": "GoogleCloudDocumentaiV1ProcessorVersion",
"properties": {
"createTime": {
"description": "Output only. The time the processor version was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deprecationInfo": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo",
"description": "Output only. If set, information about the eventual deprecation of this version.",
"readOnly": true
},
"displayName": {
"description": "The display name of the processor version.",
"type": "string"
},
"documentSchema": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchema",
"description": "Output only. The schema of the processor version. Describes the output.",
"readOnly": true
},
"genAiModelInfo": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo",
"description": "Output only. Information about Generative AI model-based processor versions.",
"readOnly": true
},
"googleManaged": {
"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
"readOnly": true,
"type": "boolean"
},
"kmsKeyName": {
"description": "Output only. The KMS key name used for encryption.",
"readOnly": true,
"type": "string"
},
"kmsKeyVersionName": {
"description": "Output only. The KMS key version with which data is encrypted.",
"readOnly": true,
"type": "string"
},
"latestEvaluation": {
"$ref": "GoogleCloudDocumentaiV1EvaluationReference",
"description": "Output only. The most recently invoked evaluation for the processor version.",
"readOnly": true
},
"modelType": {
"description": "Output only. The model type of this processor version.",
"enum": [
"MODEL_TYPE_UNSPECIFIED",
"MODEL_TYPE_GENERATIVE",
"MODEL_TYPE_CUSTOM"
],
"enumDescriptions": [
"The processor version has unspecified model type.",
"The processor version has generative model type.",
"The processor version has custom model type."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`",
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Output only. The state of the processor version.",
"enum": [
"STATE_UNSPECIFIED",
"DEPLOYED",
"DEPLOYING",
"UNDEPLOYED",
"UNDEPLOYING",
"CREATING",
"DELETING",
"FAILED",
"IMPORTING"
],
"enumDescriptions": [
"The processor version is in an unspecified state.",
"The processor version is deployed and can be used for processing.",
"The processor version is being deployed.",
"The processor version is not deployed and cannot be used for processing.",
"The processor version is being undeployed.",
"The processor version is being created.",
"The processor version is being deleted.",
"The processor version failed and is in an indeterminate state.",
"The processor version is being imported."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorVersionAlias": {
"description": "Contains the alias and the aliased resource name of processor version.",
"id": "GoogleCloudDocumentaiV1ProcessorVersionAlias",
"properties": {
"alias": {
"description": "The alias in the form of `processor_version` resource name.",
"type": "string"
},
"processorVersion": {
"description": "The resource name of aliased processor version.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo": {
"description": "Information about the upcoming deprecation of this processor version.",
"id": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo",
"properties": {
"deprecationTime": {
"description": "The time at which this processor version will be deprecated.",
"format": "google-datetime",
"type": "string"
},
"replacementProcessorVersion": {
"description": "If set, the processor version that will be used as a replacement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": {
"description": "Information about Generative AI model-based processor versions.",
"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo",
"properties": {
"customGenAiModelInfo": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
"description": "Information for a custom Generative AI model created by the user."
},
"foundationGenAiModelInfo": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
"description": "Information for a pretrained Google-managed foundation model."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.",
"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
"properties": {
"baseProcessorVersionId": {
"description": "The base processor version ID for the custom model.",
"type": "string"
},
"customModelType": {
"description": "The type of custom model created by the user.",
"enum": [
"CUSTOM_MODEL_TYPE_UNSPECIFIED",
"VERSIONED_FOUNDATION",
"FINE_TUNED"
],
"enumDescriptions": [
"The model type is unspecified.",
"The model is a versioned foundation model.",
"The model is a finetuned foundation model."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
"description": "Information for a pretrained Google-managed foundation model.",
"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
"properties": {
"finetuningAllowed": {
"description": "Whether fine tuning is allowed for this base processor version.",
"type": "boolean"
},
"minTrainLabeledDocuments": {
"description": "The minimum number of labeled documents in the training dataset required for fine tuning.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1RawDocument": {
"description": "Payload message of raw document content (bytes).",
"id": "GoogleCloudDocumentaiV1RawDocument",
"properties": {
"content": {
"description": "Inline document content.",
"format": "byte",
"type": "string"
},
"displayName": {
"description": "The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\\\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated.",
"type": "string"
},
"mimeType": {
"description": "An IANA MIME type (RFC6838) indicating the nature and format of the content.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1RawDocuments": {
"description": "Specifies a set of raw documents.",
"id": "GoogleCloudDocumentaiV1RawDocuments",
"properties": {
"documents": {
"description": "Specifies raw document content and mime type.",
"items": {
"$ref": "GoogleCloudDocumentaiV1RawDocument"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": {
"description": "The long-running operation metadata for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"questionId": {
"description": "The Crowd Compute question ID.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ReviewDocumentRequest": {
"description": "Request message for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1ReviewDocumentRequest",
"properties": {
"documentSchema": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchema",
"description": "The document schema of the human review task."
},
"enableSchemaValidation": {
"description": "Whether the validation should be performed on the ad-hoc review request.",
"type": "boolean"
},
"inlineDocument": {
"$ref": "GoogleCloudDocumentaiV1Document",
"description": "An inline document proto."
},
"priority": {
"description": "The priority of the human review task.",
"enum": [
"DEFAULT",
"URGENT"
],
"enumDescriptions": [
"The default priority level.",
"The urgent priority level. The labeling manager should allocate labeler resource to the urgent task queue to respect this priority level."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ReviewDocumentResponse": {
"description": "Response message for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1ReviewDocumentResponse",
"properties": {
"gcsDestination": {
"description": "The Cloud Storage uri for the human reviewed document if the review is succeeded.",
"type": "string"
},
"rejectionReason": {
"description": "The reason why the review is rejected by reviewer.",
"type": "string"
},
"state": {
"description": "The state of the review operation.",
"enum": [
"STATE_UNSPECIFIED",
"REJECTED",
"SUCCEEDED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"The review operation is rejected by the reviewer.",
"The review operation is succeeded."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SchemaGenerationHistory": {
"description": "The history of schema generation iterations.",
"id": "GoogleCloudDocumentaiV1SchemaGenerationHistory",
"properties": {
"iterations": {
"description": "Required. Previous prompt-answers in a chronological order.",
"items": {
"$ref": "GoogleCloudDocumentaiV1SchemaGenerationIteration"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SchemaGenerationIteration": {
"description": "A single iteration of the schema generation.",
"id": "GoogleCloudDocumentaiV1SchemaGenerationIteration",
"properties": {
"adjustedSchema": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion",
"description": "Optional. The previous schema version adjusted by the model."
},
"generatedSchema": {
"$ref": "GoogleCloudDocumentaiV1SchemaVersion",
"description": "Required. The schema version generated by the model."
},
"prompt": {
"description": "Optional. The prompt used for the iteration.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SchemaVersion": {
"description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.",
"id": "GoogleCloudDocumentaiV1SchemaVersion",
"properties": {
"createTime": {
"description": "Output only. The time when the SchemaVersion was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The user-defined name of the SchemaVersion.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The {{gcp_name_short}} labels for the SchemaVersion.",
"type": "object"
},
"name": {
"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
"type": "string"
},
"schema": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchema",
"description": "Required. The schema of the SchemaVersion."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": {
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest": {
"description": "Request message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest",
"properties": {
"defaultProcessorVersion": {
"description": "Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse": {
"description": "Response message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionMetadata": {
"description": "The metadata that represents a processor version being created.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"testDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation",
"description": "The test dataset validation information."
},
"trainingDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation",
"description": "The training dataset validation information."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation": {
"description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation",
"properties": {
"datasetErrorCount": {
"description": "The total number of dataset errors.",
"format": "int32",
"type": "integer"
},
"datasetErrors": {
"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"documentErrorCount": {
"description": "The total number of document errors.",
"format": "int32",
"type": "integer"
},
"documentErrors": {
"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionRequest": {
"description": "Request message for the TrainProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequest",
"properties": {
"baseProcessorVersion": {
"description": "Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.",
"type": "string"
},
"customDocumentExtractionOptions": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions",
"description": "Options to control Custom Document Extraction (CDE) Processor."
},
"documentSchema": {
"$ref": "GoogleCloudDocumentaiV1DocumentSchema",
"description": "Optional. The schema the processor version will be trained with."
},
"foundationModelTuningOptions": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions",
"description": "Options to control foundation model tuning of a processor."
},
"inputData": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData",
"description": "Optional. The input data used to train the ProcessorVersion."
},
"processorVersion": {
"$ref": "GoogleCloudDocumentaiV1ProcessorVersion",
"description": "Required. The processor version to be created."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions": {
"description": "Options to control the training of the Custom Document Extraction (CDE) Processor.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions",
"properties": {
"trainingMethod": {
"description": "Optional. Training method to use for CDE training.",
"enum": [
"TRAINING_METHOD_UNSPECIFIED",
"MODEL_BASED",
"TEMPLATE_BASED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions": {
"description": "Options to control foundation model tuning of the processor.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions",
"properties": {
"learningRateMultiplier": {
"description": "Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.",
"format": "float",
"type": "number"
},
"previousFineTunedProcessorVersionName": {
"description": "Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.",
"type": "string"
},
"trainSteps": {
"description": "Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData": {
"description": "The input data used to train a new ProcessorVersion.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData",
"properties": {
"testDocuments": {
"$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
"description": "The documents used for testing the trained version."
},
"trainingDocuments": {
"$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
"description": "The documents used for training the new version."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionResponse": {
"description": "The response for TrainProcessorVersion.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The resource name of the processor version produced by training.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1UndeployProcessorVersionRequest": {
"description": "Request message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1UndeployProcessorVersionRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1UndeployProcessorVersionResponse": {
"description": "Response message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1UndeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1Vertex": {
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
"id": "GoogleCloudDocumentaiV1Vertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "int32",
"type": "integer"
},
"y": {
"description": "Y coordinate (starts from the top of the image).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": {
"id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"errorDocumentCount": {
"description": "Total number of documents that failed to be deleted in storage.",
"format": "int32",
"type": "integer"
},
"individualBatchDeleteStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of documents deleting from dataset.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": {
"description": "The status of each individual document in the batch delete process.",
"id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of deleting the document in storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": {
"description": "Response of the delete documents operation.",
"id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessMetadata": {
"description": "The long-running operation metadata for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"individualProcessStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus"
},
"type": "array"
},
"state": {
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
],
"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"
},
"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"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus": {
"description": "The status of a each individual document in the batch process.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus",
"properties": {
"humanReviewOperation": {
"deprecated": true,
"description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.",
"type": "string"
},
"humanReviewStatus": {
"$ref": "GoogleCloudDocumentaiV1beta3HumanReviewStatus",
"description": "The status of human review on the processed document."
},
"inputGcsSource": {
"description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.",
"type": "string"
},
"outputGcsDestination": {
"description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status processing the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessResponse": {
"description": "Response message for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3CommonOperationMetadata": {
"description": "The common metadata for long running operations.",
"id": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"resource": {
"description": "A related resource to this operation.",
"type": "string"
},
"state": {
"description": "The state of the operation.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3Dataset": {
"description": "A singleton resource under a Processor which configures a collection of documents.",
"id": "GoogleCloudDocumentaiV1beta3Dataset",
"properties": {
"documentWarehouseConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
"deprecated": true,
"description": "Optional. Deprecated. Warehouse-based dataset configuration is not supported."
},
"gcsManagedConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",
"description": "Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location."
},
"name": {
"description": "Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset`",
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Required. State of the dataset. Ignored when updating dataset.",
"enum": [
"STATE_UNSPECIFIED",
"UNINITIALIZED",
"INITIALIZING",
"INITIALIZED"
],
"enumDescriptions": [
"Default unspecified enum, should not be used.",
"Dataset has not been initialized.",
"Dataset is being initialized.",
"Dataset has been initialized."
],
"type": "string"
},
"unmanagedDatasetConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig",
"description": "Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed)."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig": {
"description": "Configuration specific to the Document AI Warehouse-based implementation.",
"id": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
"properties": {
"collection": {
"description": "Output only. The collection in Document AI Warehouse associated with the dataset.",
"readOnly": true,
"type": "string"
},
"schema": {
"description": "Output only. The schema in Document AI Warehouse associated with the dataset.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig": {
"description": "Configuration specific to the Cloud Storage-based implementation.",
"id": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",
"properties": {
"gcsPrefix": {
"$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix",
"description": "Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": {
"description": "Configuration specific to an unmanaged dataset.",
"id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": {
"description": "The long-running operation metadata for the DeleteProcessor method.",
"id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeleteProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse": {
"description": "Response message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": {
"description": "The long-running operation metadata for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DisableProcessorResponse": {
"description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1beta3DisableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentId": {
"description": "Document Identifier.",
"id": "GoogleCloudDocumentaiV1beta3DocumentId",
"properties": {
"gcsManagedDocId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId",
"description": "A document id within user-managed Cloud Storage."
},
"revisionRef": {
"$ref": "GoogleCloudDocumentaiV1beta3RevisionRef",
"description": "Points to a specific revision of the document if set."
},
"unmanagedDocId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
"description": "A document id within unmanaged dataset."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.",
"id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId",
"properties": {
"cwDocId": {
"deprecated": true,
"description": "Id of the document (indexed) managed by Content Warehouse.",
"type": "string"
},
"gcsUri": {
"description": "Required. The Cloud Storage URI where the actual document is stored.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.",
"id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
"properties": {
"docId": {
"description": "Required. The id of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentSchema": {
"description": "The schema defines the output of the processed document by a processor.",
"id": "GoogleCloudDocumentaiV1beta3DocumentSchema",
"properties": {
"description": {
"description": "Description of the schema.",
"type": "string"
},
"displayName": {
"description": "Display name to show users.",
"type": "string"
},
"documentPrompt": {
"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
"type": "string"
},
"entityTypes": {
"description": "Entity types of the schema.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType"
},
"type": "array"
},
"metadata": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata",
"description": "Metadata of the schema."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType": {
"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.",
"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType",
"properties": {
"baseTypes": {
"description": "The entity type that this type is derived from. For now, one and only one should be set.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.",
"type": "string"
},
"displayName": {
"description": "User defined name for the type.",
"type": "string"
},
"entityTypeMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata",
"description": "Metadata for the entity type."
},
"enumValues": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues",
"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
},
"name": {
"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
"type": "string"
},
"properties": {
"description": "Description the nested structure, or composition of an entity.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues": {
"description": "Defines the a list of enum values.",
"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues",
"properties": {
"values": {
"description": "The individual values that this enum values type can include.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty": {
"description": "Defines properties that can be part of the entity type.",
"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty",
"properties": {
"description": {
"description": "The description of the property. Could be used to provide more information about the property for model calls.",
"type": "string"
},
"displayName": {
"description": "User defined name for the property.",
"type": "string"
},
"method": {
"description": "Specifies how the entity's value is obtained.",
"enum": [
"METHOD_UNSPECIFIED",
"EXTRACT",
"DERIVE",
"RELAXED_EXTRACT"
],
"enumDescriptions": [
"Unspecified method. It defaults to `EXTRACT`.",
"The entity's value is directly extracted as-is from the document text.",
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document.",
"Attempts to extract the position and value as-is from the document text. If the value cannot be grounded in the text, it falls back to derivation through inference, for both position and value. Note: The inference fallback is currently only supported for boolean entities."
],
"type": "string"
},
"name": {
"description": "The name of the property. Follows the same guidelines as the EntityType name.",
"type": "string"
},
"occurrenceType": {
"description": "Occurrence type limits the number of instances an entity type appears in the document.",
"enum": [
"OCCURRENCE_TYPE_UNSPECIFIED",
"OPTIONAL_ONCE",
"OPTIONAL_MULTIPLE",
"REQUIRED_ONCE",
"REQUIRED_MULTIPLE"
],
"enumDescriptions": [
"Unspecified occurrence type.",
"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.",
"The entity type will appear zero or multiple times.",
"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.",
"The entity type will appear once or more times."
],
"type": "string"
},
"propertyMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3PropertyMetadata",
"description": "Any additional metadata about the property can be added here."
},
"valueType": {
"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata": {
"description": "Metadata for global schema behavior.",
"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata",
"properties": {
"documentAllowMultipleLabels": {
"description": "If true, on a given page, there can be multiple `document` annotations covering it.",
"type": "boolean"
},
"documentSplitter": {
"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).",
"type": "boolean"
},
"prefixedNamingOnProperties": {
"description": "If set, all the nested entities must be prefixed with the parents.",
"type": "boolean"
},
"skipNamingValidation": {
"description": "If set, this will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": {
"description": "The long-running operation metadata for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EnableProcessorResponse": {
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EntityTypeMetadata": {
"description": "Metadata about an entity type.",
"id": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata",
"properties": {
"inactive": {
"description": "Whether the entity type should be considered inactive.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": {
"description": "Metadata of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": {
"description": "Response of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse",
"properties": {
"evaluation": {
"description": "The resource name of the created evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EvaluationMetrics": {
"description": "Evaluation metrics, either in aggregate or about a specific entity.",
"id": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
"properties": {
"f1Score": {
"description": "The calculated F1 score.",
"format": "float",
"type": "number"
},
"falseNegativesCount": {
"description": "The amount of false negatives.",
"format": "int32",
"type": "integer"
},
"falsePositivesCount": {
"description": "The amount of false positives.",
"format": "int32",
"type": "integer"
},
"groundTruthDocumentCount": {
"description": "The amount of documents with a ground truth occurrence.",
"format": "int32",
"type": "integer"
},
"groundTruthOccurrencesCount": {
"description": "The amount of occurrences in ground truth documents.",
"format": "int32",
"type": "integer"
},
"precision": {
"description": "The calculated precision.",
"format": "float",
"type": "number"
},
"predictedDocumentCount": {
"description": "The amount of documents with a predicted occurrence.",
"format": "int32",
"type": "integer"
},
"predictedOccurrencesCount": {
"description": "The amount of occurrences in predicted documents.",
"format": "int32",
"type": "integer"
},
"recall": {
"description": "The calculated recall.",
"format": "float",
"type": "number"
},
"totalDocumentsCount": {
"description": "The amount of documents that had an occurrence of this label.",
"format": "int32",
"type": "integer"
},
"truePositivesCount": {
"description": "The amount of true positives.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EvaluationReference": {
"description": "Gives a short summary of an evaluation, and links to the evaluation itself.",
"id": "GoogleCloudDocumentaiV1beta3EvaluationReference",
"properties": {
"aggregateMetrics": {
"$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
"description": "An aggregate of the statistics for the evaluation with fuzzy matching on."
},
"aggregateMetricsExact": {
"$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
"description": "An aggregate of the statistics for the evaluation with fuzzy matching off."
},
"evaluation": {
"description": "The resource name of the evaluation.",
"type": "string"
},
"operation": {
"description": "The resource name of the Long Running Operation for the evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3FieldExtractionMetadata": {
"description": "Metadata for how this field value is extracted.",
"id": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata",
"properties": {
"summaryOptions": {
"$ref": "GoogleCloudDocumentaiV1beta3SummaryOptions",
"description": "Summary options config."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3GcsPrefix": {
"description": "Specifies all documents on Cloud Storage with a common prefix.",
"id": "GoogleCloudDocumentaiV1beta3GcsPrefix",
"properties": {
"gcsUriPrefix": {
"description": "The URI prefix.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3HumanReviewStatus": {
"description": "The status of human review on a processed document.",
"id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus",
"properties": {
"humanReviewOperation": {
"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
"type": "string"
},
"state": {
"description": "The state of human review on the processing request.",
"enum": [
"STATE_UNSPECIFIED",
"SKIPPED",
"VALIDATION_PASSED",
"IN_PROGRESS",
"ERROR"
],
"enumDescriptions": [
"Human review state is unspecified. Most likely due to an internal error.",
"Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.",
"Human review validation is triggered and passed, so no review is needed.",
"Human review validation is triggered and the document is under review.",
"Some error happened during triggering human review, see the state_message for details."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the human review state.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": {
"description": "Metadata of the import document operation.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"importConfigValidationResults": {
"description": "Validation statuses of the batch documents import config.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult"
},
"type": "array"
},
"individualImportStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of the documents that are qualified for importing.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": {
"description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI specified in the import config.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The validation status of import config."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": {
"description": "The status of each individual document in the import process.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI of the document.",
"type": "string"
},
"outputDocumentId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
"description": "The document id of imported document if it was successful, otherwise empty."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the importing of the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": {
"description": "Response of the import document operation.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": {
"description": "The long-running operation metadata for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata for the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": {
"description": "The response message for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The destination processor version name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3Processor": {
"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
"id": "GoogleCloudDocumentaiV1beta3Processor",
"properties": {
"activeSchemaVersion": {
"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
"type": "string"
},
"createTime": {
"description": "Output only. The time the processor was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"defaultProcessorVersion": {
"description": "The default processor version.",
"type": "string"
},
"displayName": {
"description": "The display name of the processor.",
"type": "string"
},
"kmsKeyName": {
"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.",
"type": "string"
},
"name": {
"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`",
"readOnly": true,
"type": "string"
},
"processEndpoint": {
"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.",
"readOnly": true,
"type": "string"
},
"processorVersionAliases": {
"description": "Output only. The processor version aliases.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias"
},
"readOnly": true,
"type": "array"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Output only. The state of the processor.",
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"DISABLED",
"ENABLING",
"DISABLING",
"CREATING",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"The processor is in an unspecified state.",
"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.",
"The processor is disabled.",
"The processor is being enabled, will become `ENABLED` if successful.",
"The processor is being disabled, will become `DISABLED` if successful.",
"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.",
"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.",
"The processor is being deleted, will be removed if successful."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ProcessorVersion": {
"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.",
"id": "GoogleCloudDocumentaiV1beta3ProcessorVersion",
"properties": {
"createTime": {
"description": "Output only. The time the processor version was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deprecationInfo": {
"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo",
"description": "Output only. If set, information about the eventual deprecation of this version.",
"readOnly": true
},
"displayName": {
"description": "The display name of the processor version.",
"type": "string"
},
"documentSchema": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema",
"description": "Output only. The schema of the processor version. Describes the output.",
"readOnly": true
},
"genAiModelInfo": {
"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo",
"description": "Output only. Information about Generative AI model-based processor versions.",
"readOnly": true
},
"googleManaged": {
"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
"readOnly": true,
"type": "boolean"
},
"kmsKeyName": {
"description": "Output only. The KMS key name used for encryption.",
"readOnly": true,
"type": "string"
},
"kmsKeyVersionName": {
"description": "Output only. The KMS key version with which data is encrypted.",
"readOnly": true,
"type": "string"
},
"latestEvaluation": {
"$ref": "GoogleCloudDocumentaiV1beta3EvaluationReference",
"description": "Output only. The most recently invoked evaluation for the processor version.",
"readOnly": true
},
"modelType": {
"description": "Output only. The model type of this processor version.",
"enum": [
"MODEL_TYPE_UNSPECIFIED",
"MODEL_TYPE_GENERATIVE",
"MODEL_TYPE_CUSTOM"
],
"enumDescriptions": [
"The processor version has unspecified model type.",
"The processor version has generative model type.",
"The processor version has custom model type."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`",
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Output only. The state of the processor version.",
"enum": [
"STATE_UNSPECIFIED",
"DEPLOYED",
"DEPLOYING",
"UNDEPLOYED",
"UNDEPLOYING",
"CREATING",
"DELETING",
"FAILED",
"IMPORTING"
],
"enumDescriptions": [
"The processor version is in an unspecified state.",
"The processor version is deployed and can be used for processing.",
"The processor version is being deployed.",
"The processor version is not deployed and cannot be used for processing.",
"The processor version is being undeployed.",
"The processor version is being created.",
"The processor version is being deleted.",
"The processor version failed and is in an indeterminate state.",
"The processor version is being imported."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ProcessorVersionAlias": {
"description": "Contains the alias and the aliased resource name of processor version.",
"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias",
"properties": {
"alias": {
"description": "The alias in the form of `processor_version` resource name.",
"type": "string"
},
"processorVersion": {
"description": "The resource name of aliased processor version.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo": {
"description": "Information about the upcoming deprecation of this processor version.",
"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo",
"properties": {
"deprecationTime": {
"description": "The time at which this processor version will be deprecated.",
"format": "google-datetime",
"type": "string"
},
"replacementProcessorVersion": {
"description": "If set, the processor version that will be used as a replacement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": {
"description": "Information about Generative AI model-based processor versions.",
"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo",
"properties": {
"customGenAiModelInfo": {
"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
"description": "Information for a custom Generative AI model created by the user."
},
"foundationGenAiModelInfo": {
"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
"description": "Information for a pretrained Google-managed foundation model."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.",
"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
"properties": {
"baseProcessorVersionId": {
"description": "The base processor version ID for the custom model.",
"type": "string"
},
"customModelType": {
"description": "The type of custom model created by the user.",
"enum": [
"CUSTOM_MODEL_TYPE_UNSPECIFIED",
"VERSIONED_FOUNDATION",
"FINE_TUNED"
],
"enumDescriptions": [
"The model type is unspecified.",
"The model is a versioned foundation model.",
"The model is a finetuned foundation model."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
"description": "Information for a pretrained Google-managed foundation model.",
"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
"properties": {
"finetuningAllowed": {
"description": "Whether fine tuning is allowed for this base processor version.",
"type": "boolean"
},
"minTrainLabeledDocuments": {
"description": "The minimum number of labeled documents in the training dataset required for fine tuning.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3PropertyMetadata": {
"description": "Metadata about a property.",
"id": "GoogleCloudDocumentaiV1beta3PropertyMetadata",
"properties": {
"fieldExtractionMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata",
"description": "Field extraction metadata on the property."
},
"inactive": {
"description": "Whether the property should be considered as \"inactive\".",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": {
"description": "The long-running operation metadata for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"questionId": {
"description": "The Crowd Compute question ID.",
"type": "string"
},
"state": {
"description": "Used only when Operation.done is false.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"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"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ReviewDocumentResponse": {
"description": "Response message for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentResponse",
"properties": {
"gcsDestination": {
"description": "The Cloud Storage uri for the human reviewed document if the review is succeeded.",
"type": "string"
},
"rejectionReason": {
"description": "The reason why the review is rejected by reviewer.",
"type": "string"
},
"state": {
"description": "The state of the review operation.",
"enum": [
"STATE_UNSPECIFIED",
"REJECTED",
"SUCCEEDED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"The review operation is rejected by the reviewer.",
"The review operation is succeeded."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3RevisionRef": {
"description": "The revision reference specifies which revision on the document to read.",
"id": "GoogleCloudDocumentaiV1beta3RevisionRef",
"properties": {
"latestProcessorVersion": {
"description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"type": "string"
},
"revisionCase": {
"description": "Reads the revision by the predefined case.",
"enum": [
"REVISION_CASE_UNSPECIFIED",
"LATEST_HUMAN_REVIEW",
"LATEST_TIMESTAMP",
"BASE_OCR_REVISION"
],
"enumDescriptions": [
"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
"The latest revision made by a human.",
"The latest revision based on timestamp.",
"The first (OCR) revision."
],
"type": "string"
},
"revisionId": {
"description": "Reads the revision given by the id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": {
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse": {
"description": "Response message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3SummaryOptions": {
"description": "Metadata for document summarization.",
"id": "GoogleCloudDocumentaiV1beta3SummaryOptions",
"properties": {
"format": {
"description": "The format the summary should be in.",
"enum": [
"FORMAT_UNSPECIFIED",
"PARAGRAPH",
"BULLETS"
],
"enumDescriptions": [
"Default.",
"Format the output in paragraphs.",
"Format the output in bullets."
],
"type": "string"
},
"length": {
"description": "How long the summary should be.",
"enum": [
"LENGTH_UNSPECIFIED",
"BRIEF",
"MODERATE",
"COMPREHENSIVE"
],
"enumDescriptions": [
"Default.",
"A brief summary of one or two sentences.",
"A paragraph-length summary.",
"The longest option available."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata": {
"description": "The metadata that represents a processor version being created.",
"id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"testDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The test dataset validation information."
},
"trainingDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The training dataset validation information."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation": {
"description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
"id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation",
"properties": {
"datasetErrorCount": {
"description": "The total number of dataset errors.",
"format": "int32",
"type": "integer"
},
"datasetErrors": {
"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"documentErrorCount": {
"description": "The total number of document errors.",
"format": "int32",
"type": "integer"
},
"documentErrors": {
"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse": {
"description": "The response for TrainProcessorVersion.",
"id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The resource name of the processor version produced by training.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse": {
"description": "Response message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata": {
"id": "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UpdateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata for the long-running operation."
}
},
"type": "object"
},
"GoogleCloudLocationListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "GoogleCloudLocationListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudLocationLocation"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudLocationLocation": {
"description": "A resource that represents a Google Cloud location.",
"id": "GoogleCloudLocationLocation",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"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": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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.",
"type": "object"
},
"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"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. 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`.",
"type": "object"
}
},
"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); }",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"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).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"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.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeColor": {
"description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value\u2014for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...",
"id": "GoogleTypeColor",
"properties": {
"alpha": {
"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 rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).",
"format": "float",
"type": "number"
},
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "GoogleTypeDate",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeDateTime": {
"description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
"id": "GoogleTypeDateTime",
"properties": {
"day": {
"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.",
"format": "int32",
"type": "integer"
},
"hours": {
"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
},
"timeZone": {
"$ref": "GoogleTypeTimeZone",
"description": "Time zone."
},
"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 }.",
"format": "google-duration",
"type": "string"
},
"year": {
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeMoney": {
"description": "Represents an amount of money with its currency type.",
"id": "GoogleTypeMoney",
"properties": {
"currencyCode": {
"description": "The three-letter currency code defined in ISO 4217.",
"type": "string"
},
"nanos": {
"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",
"type": "integer"
},
"units": {
"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleTypePostalAddress": {
"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.",
"id": "GoogleTypePostalAddress",
"properties": {
"addressLines": {
"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 (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In 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).",
"items": {
"type": "string"
},
"type": "array"
},
"administrativeArea": {
"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. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.",
"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"
},
"locality": {
"description": "Optional. Generally refers to the city or 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"
},
"organization": {
"description": "Optional. The name of the organization at the address.",
"type": "string"
},
"postalCode": {
"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 (for example, state or zip code validation in the United States).",
"type": "string"
},
"recipients": {
"description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.",
"items": {
"type": "string"
},
"type": "array"
},
"regionCode": {
"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 https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"revision": {
"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.",
"format": "int32",
"type": "integer"
},
"sortingCode": {
"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 (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (C\u00f4te d'Ivoire).",
"type": "string"
},
"sublocality": {
"description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeTimeZone": {
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "GoogleTypeTimeZone",
"properties": {
"id": {
"description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
"type": "string"
},
"version": {
"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Document AI API",
"version": "v1",
"version_module": true
}