xref: /aosp_15_r20/external/googleapis/google/cloud/documentai/v1beta2/documentai_v1beta2.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1type: google.api.Service
2config_version: 3
3name: documentai.googleapis.com
4title: Cloud Document AI API
5
6apis:
7- name: google.cloud.documentai.v1beta2.DocumentUnderstandingService
8- name: google.cloud.location.Locations
9- name: google.longrunning.Operations
10
11types:
12- name: google.cloud.documentai.v1beta2.BatchProcessDocumentsResponse
13- name: google.cloud.documentai.v1beta2.Document
14- name: google.cloud.documentai.v1beta2.OperationMetadata
15
16documentation:
17  summary: |-
18    Service to parse structured information from unstructured or
19    semi-structured documents using state-of-the-art Google AI such as natural
20    language, computer vision, translation, and AutoML.
21  rules:
22  - selector: google.cloud.location.Locations.GetLocation
23    description: Gets information about a location.
24
25  - selector: google.cloud.location.Locations.ListLocations
26    description: Lists information about the supported locations for this service.
27
28http:
29  rules:
30  - selector: google.cloud.location.Locations.GetLocation
31    get: '/uiv1beta3/{name=projects/*/locations/*}'
32  - selector: google.cloud.location.Locations.ListLocations
33    get: '/uiv1beta3/{name=projects/*}/locations'
34  - selector: google.longrunning.Operations.CancelOperation
35    post: '/uiv1beta3/{name=projects/*/locations/*/operations/*}:cancel'
36  - selector: google.longrunning.Operations.GetOperation
37    get: '/v1beta2/{name=projects/*/operations/*}'
38    additional_bindings:
39    - get: '/v1beta2/{name=projects/*/locations/*/operations/*}'
40    - get: '/uiv1beta3/{name=projects/*/locations/*/operations/*}'
41  - selector: google.longrunning.Operations.ListOperations
42    get: '/uiv1beta3/{name=projects/*/locations/*/operations}'
43
44authentication:
45  rules:
46  - selector: google.cloud.documentai.v1beta2.DocumentUnderstandingService.BatchProcessDocuments
47    oauth:
48      canonical_scopes: |-
49        https://www.googleapis.com/auth/cloud-platform
50  - selector: google.cloud.documentai.v1beta2.DocumentUnderstandingService.ProcessDocument
51    oauth:
52      canonical_scopes: |-
53        https://www.googleapis.com/auth/cloud-platform
54  - selector: google.cloud.location.Locations.GetLocation
55    oauth:
56      canonical_scopes: |-
57        https://www.googleapis.com/auth/cloud-platform
58  - selector: google.cloud.location.Locations.ListLocations
59    oauth:
60      canonical_scopes: |-
61        https://www.googleapis.com/auth/cloud-platform
62  - selector: 'google.longrunning.Operations.*'
63    oauth:
64      canonical_scopes: |-
65        https://www.googleapis.com/auth/cloud-platform
66
67publishing:
68  documentation_uri: https://cloud.google.com/document-ai/docs
69  github_label: 'api: documentai'
70  organization: CLOUD
71  proto_reference_documentation_uri: https://cloud.google.com/document-ai/docs/reference/rpc
72