xref: /aosp_15_r20/external/googleapis/google/cloud/documentai/v1/documentai_v1.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.v1.DocumentProcessorService
8- name: google.cloud.location.Locations
9- name: google.longrunning.Operations
10
11types:
12- name: google.cloud.documentai.v1.BatchProcessMetadata
13- name: google.cloud.documentai.v1.BatchProcessResponse
14- name: google.cloud.documentai.v1.DeleteProcessorMetadata
15- name: google.cloud.documentai.v1.DeleteProcessorVersionMetadata
16- name: google.cloud.documentai.v1.DeployProcessorVersionMetadata
17- name: google.cloud.documentai.v1.DeployProcessorVersionResponse
18- name: google.cloud.documentai.v1.DisableProcessorMetadata
19- name: google.cloud.documentai.v1.DisableProcessorResponse
20- name: google.cloud.documentai.v1.EnableProcessorMetadata
21- name: google.cloud.documentai.v1.EnableProcessorResponse
22- name: google.cloud.documentai.v1.EvaluateProcessorVersionMetadata
23- name: google.cloud.documentai.v1.EvaluateProcessorVersionResponse
24- name: google.cloud.documentai.v1.ReviewDocumentOperationMetadata
25- name: google.cloud.documentai.v1.ReviewDocumentResponse
26- name: google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata
27- name: google.cloud.documentai.v1.SetDefaultProcessorVersionResponse
28- name: google.cloud.documentai.v1.TrainProcessorVersionMetadata
29- name: google.cloud.documentai.v1.TrainProcessorVersionResponse
30- name: google.cloud.documentai.v1.UndeployProcessorVersionMetadata
31- name: google.cloud.documentai.v1.UndeployProcessorVersionResponse
32
33documentation:
34  summary: |-
35    Service to parse structured information from unstructured or
36    semi-structured documents using state-of-the-art Google AI such as natural
37    language, computer vision, translation, and AutoML.
38  rules:
39  - selector: google.cloud.location.Locations.GetLocation
40    description: Gets information about a location.
41
42  - selector: google.cloud.location.Locations.ListLocations
43    description: Lists information about the supported locations for this service.
44
45http:
46  rules:
47  - selector: google.cloud.location.Locations.GetLocation
48    get: '/v1/{name=projects/*/locations/*}'
49    additional_bindings:
50    - get: '/uiv1beta3/{name=projects/*/locations/*}'
51  - selector: google.cloud.location.Locations.ListLocations
52    get: '/v1/{name=projects/*}/locations'
53    additional_bindings:
54    - get: '/uiv1beta3/{name=projects/*}/locations'
55  - selector: google.longrunning.Operations.CancelOperation
56    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
57    additional_bindings:
58    - post: '/uiv1beta3/{name=projects/*/locations/*/operations/*}:cancel'
59  - selector: google.longrunning.Operations.GetOperation
60    get: '/v1/{name=projects/*/operations/*}'
61    additional_bindings:
62    - get: '/v1/{name=projects/*/locations/*/operations/*}'
63    - get: '/uiv1beta3/{name=projects/*/locations/*/operations/*}'
64  - selector: google.longrunning.Operations.ListOperations
65    get: '/v1/{name=projects/*/locations/*/operations}'
66    additional_bindings:
67    - get: '/uiv1beta3/{name=projects/*/locations/*/operations}'
68
69authentication:
70  rules:
71  - selector: 'google.cloud.documentai.v1.DocumentProcessorService.*'
72    oauth:
73      canonical_scopes: |-
74        https://www.googleapis.com/auth/cloud-platform
75  - selector: google.cloud.location.Locations.GetLocation
76    oauth:
77      canonical_scopes: |-
78        https://www.googleapis.com/auth/cloud-platform
79  - selector: google.cloud.location.Locations.ListLocations
80    oauth:
81      canonical_scopes: |-
82        https://www.googleapis.com/auth/cloud-platform
83  - selector: 'google.longrunning.Operations.*'
84    oauth:
85      canonical_scopes: |-
86        https://www.googleapis.com/auth/cloud-platform
87
88publishing:
89  documentation_uri: https://cloud.google.com/document-ai/docs
90  github_label: 'api: documentai'
91  organization: CLOUD
92  library_settings:
93  - version: google.cloud.documentai.v1
94    dotnet_settings:
95      ignored_resources:
96      - documentai.googleapis.com/Location
97  proto_reference_documentation_uri: https://cloud.google.com/document-ai/docs/reference/rpc
98