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