googleapis/google/cloud/documentai/v1beta3/documentai_v1beta3.yaml
Google APIs 39bd091b05 feat: A new field revisions is added to message .google.cloud.documentai.v1beta3.Evaluation
feat: A new field `document_type` is added to message `.google.cloud.documentai.v1beta3.ImportDocumentsRequest`
feat: A new field `document_prompt` is added to message `.google.cloud.documentai.v1beta3.DocumentSchema`
feat: A new field `enable_table_split` is added to message `.google.cloud.documentai.v1beta3.OcrConfig.LayoutParsingParams`
feat: Added new messages `Documents` and `RawDocuments` for inline document input
feat: The method `ReviewDocument` in `.google.cloud.documentai.v1beta3.DocumentProcessorService` is deprecated
feat: The field `skip_human_review` in messages `.google.cloud.documentai.v1beta3.ProcessRequest` and `.google.cloud.documentai.v1beta3.BatchProcessRequest` is deprecated
fix!: Removed the `SpannerIndexingConfig` message and the `spanner_indexing_config` field from `.google.cloud.documentai.v1beta3.Dataset`
BREAKING CHANGE: The `SpannerIndexingConfig` message and the `spanner_indexing_config` field within the `Dataset` message have been removed. Client code referencing these will need to stop referencing these in case of an error
docs: Updated comments for various fields and messages

PiperOrigin-RevId: 866382481
2026-02-06 03:34:56 -08:00

123 lines
5.5 KiB
YAML

type: google.api.Service
config_version: 3
name: documentai.googleapis.com
title: Cloud Document AI API
apis:
- name: google.cloud.documentai.v1beta3.DocumentProcessorService
- name: google.cloud.documentai.v1beta3.DocumentService
- name: google.cloud.location.Locations
- name: google.longrunning.Operations
types:
- name: google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata
- name: google.cloud.documentai.v1beta3.BatchDeleteDocumentsResponse
- name: google.cloud.documentai.v1beta3.BatchProcessMetadata
- name: google.cloud.documentai.v1beta3.BatchProcessResponse
- name: google.cloud.documentai.v1beta3.Dataset
- name: google.cloud.documentai.v1beta3.DeleteProcessorMetadata
- name: google.cloud.documentai.v1beta3.DeleteProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.DeployProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.DeployProcessorVersionResponse
- name: google.cloud.documentai.v1beta3.DisableProcessorMetadata
- name: google.cloud.documentai.v1beta3.DisableProcessorResponse
- name: google.cloud.documentai.v1beta3.EnableProcessorMetadata
- name: google.cloud.documentai.v1beta3.EnableProcessorResponse
- name: google.cloud.documentai.v1beta3.EvaluateProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.EvaluateProcessorVersionResponse
- name: google.cloud.documentai.v1beta3.ImportDocumentsMetadata
- name: google.cloud.documentai.v1beta3.ImportDocumentsResponse
- name: google.cloud.documentai.v1beta3.ImportProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.ImportProcessorVersionResponse
- name: google.cloud.documentai.v1beta3.Processor
- name: google.cloud.documentai.v1beta3.ProcessorVersion
- name: google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata
- name: google.cloud.documentai.v1beta3.ReviewDocumentResponse
- name: google.cloud.documentai.v1beta3.SetDefaultProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.SetDefaultProcessorVersionResponse
- name: google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.TrainProcessorVersionResponse
- name: google.cloud.documentai.v1beta3.UndeployProcessorVersionMetadata
- name: google.cloud.documentai.v1beta3.UndeployProcessorVersionResponse
- name: google.cloud.documentai.v1beta3.UpdateDatasetOperationMetadata
- name: google.cloud.documentai.v1beta3.UpdateProcessorVersionMetadata
documentation:
summary: |-
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.
rules:
- selector: google.cloud.location.Locations.GetLocation
description: Gets information about a location.
- selector: google.cloud.location.Locations.ListLocations
description: |-
Lists information about the supported locations for this service.
This method can be called in two ways:
* **List all public locations:** Use the path `GET /v1/locations`.
* **List project-visible locations:** Use the path
`GET /v1/projects/{project_id}/locations`. This may include public
locations as well as private or other locations specifically visible
to the project.
http:
rules:
- selector: google.cloud.location.Locations.GetLocation
get: '/v1beta3/{name=projects/*/locations/*}'
additional_bindings:
- get: '/uiv1beta3/{name=projects/*/locations/*}'
- selector: google.cloud.location.Locations.ListLocations
get: '/v1beta3/{name=projects/*}/locations'
additional_bindings:
- get: '/uiv1beta3/{name=projects/*}/locations'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1beta3/{name=projects/*/locations/*/operations/*}:cancel'
additional_bindings:
- post: '/uiv1beta3/{name=projects/*/locations/*/operations/*}:cancel'
- selector: google.longrunning.Operations.GetOperation
get: '/v1beta3/{name=projects/*/locations/*/operations/*}'
additional_bindings:
- get: '/uiv1beta3/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.ListOperations
get: '/v1beta3/{name=projects/*/locations/*/operations}'
additional_bindings:
- get: '/uiv1beta3/{name=projects/*/locations/*/operations}'
authentication:
rules:
- selector: 'google.cloud.documentai.v1beta3.DocumentProcessorService.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.cloud.documentai.v1beta3.DocumentService.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.location.Locations.GetLocation
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.location.Locations.ListLocations
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
publishing:
new_issue_uri: https://issuetracker.google.com/issues/new?component=1132231&template=1639002
documentation_uri: https://cloud.google.com/document-ai/docs
api_short_name: documentai
github_label: 'api: documentai'
organization: CLOUD
library_settings:
- version: google.cloud.documentai.v1beta3
dotnet_settings:
common: {}
ignored_resources:
- documentai.googleapis.com/Location
proto_reference_documentation_uri: https://cloud.google.com/document-ai/docs/reference/rpc