blob: b99e6a823d4a90568cfb9007e1b9e275d4486b8f [file] [log] [blame]
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="documentai_v1beta3.html">Cloud Document AI API</a> . <a href="documentai_v1beta3.projects.html">projects</a> . <a href="documentai_v1beta3.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="documentai_v1beta3.projects.locations.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="documentai_v1beta3.projects.locations.processors.html">processors()</a></code>
84</p>
85<p class="firstline">Returns the processors Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
yoshi-code-bot3fd11cb2021-04-28 05:44:03 -070091 <code><a href="#fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</a></code></p>
92<p class="firstline">Fetches processor types.</p>
93<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080094 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
95<p class="firstline">Gets information about a location.</p>
96<p class="toc_element">
97 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
98<p class="firstline">Lists information about the supported locations for this service.</p>
99<p class="toc_element">
100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
101<p class="firstline">Retrieves the next page of results.</p>
102<h3>Method Details</h3>
103<div class="method">
104 <code class="details" id="close">close()</code>
105 <pre>Close httplib2 connections.</pre>
106</div>
107
108<div class="method">
yoshi-code-bot3fd11cb2021-04-28 05:44:03 -0700109 <code class="details" id="fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</code>
110 <pre>Fetches processor types.
111
112Args:
113 parent: string, Required. The project of processor type to list. The available processor types may depend on the whitelisting on projects. Format: projects/{project}/locations/{location} (required)
114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119Returns:
120 An object of the form:
121
122 { # Response message for fetch processor types.
123 &quot;processorTypes&quot;: [ # The list of processor types.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700124 { # A processor type is responsible for performing a certain document understanding task on a certain type of document. All processor types are created by the documentai service internally. User will only list all available processor types via UI. For different users (projects), the available processor types may be different since we&#x27;ll expose the access of some types via EAP whitelisting. We make the ProcessorType a resource under location so we have a unified API and keep the possibility that UI will load different available processor types from different regions. But for alpha the behavior is that the user will always get the union of all available processor types among all regions no matter which regionalized endpoint is called, and then we use the &#x27;available_locations&#x27; field to show under which regions a processor type is available. For example, users can call either the &#x27;US&#x27; or &#x27;EU&#x27; endpoint to feach processor types. In the return, we will have an &#x27;invoice parsing&#x27; processor with &#x27;available_locations&#x27; field only containing &#x27;US&#x27;. So the user can try to create an &#x27;invoice parsing&#x27; processor under the location &#x27;US&#x27;. Such attempt of creating under the location &#x27;EU&#x27; will fail. Next ID: 8.
yoshi-code-bot3fd11cb2021-04-28 05:44:03 -0700125 &quot;allowCreation&quot;: True or False, # Whether the processor type allows creation. If yes, user can create a processor of this processor type. Otherwise, user needs to require for whitelisting.
126 &quot;availableLocations&quot;: [ # The locations in which this processor is available.
127 { # The location information about where the processor is available.
128 &quot;locationId&quot;: &quot;A String&quot;, # The location id, currently must be one of [us, eu].
129 },
130 ],
131 &quot;category&quot;: &quot;A String&quot;, # The processor category, used by UI to group processor types.
132 &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
yoshi-code-bot3fd11cb2021-04-28 05:44:03 -0700133 &quot;type&quot;: &quot;A String&quot;, # The type of the processor, e.g, &quot;invoice_parsing&quot;.
134 },
135 ],
136}</pre>
137</div>
138
139<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 <code class="details" id="get">get(name, x__xgafv=None)</code>
141 <pre>Gets information about a location.
142
143Args:
144 name: string, Resource name for the location. (required)
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
153 { # A resource that represents Google Cloud Platform location.
154 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
155 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
156 &quot;a_key&quot;: &quot;A String&quot;,
157 },
158 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
159 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
161 },
162 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
163}</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
168 <pre>Lists information about the supported locations for this service.
169
170Args:
171 name: string, The resource that owns the locations collection, if applicable. (required)
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700172 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700173 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700174 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
183 { # The response message for Locations.ListLocations.
184 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
185 { # A resource that represents Google Cloud Platform location.
186 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
187 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
188 &quot;a_key&quot;: &quot;A String&quot;,
189 },
190 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
191 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
192 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
193 },
194 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
195 },
196 ],
197 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
198}</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
203 <pre>Retrieves the next page of results.
204
205Args:
206 previous_request: The request for the previous page. (required)
207 previous_response: The response from the request for the previous page. (required)
208
209Returns:
210 A request object that you can call &#x27;execute()&#x27; on to request the next
211 page. Returns None if there are no more items in the collection.
212 </pre>
213</div>
214
215</body></html>