Skip to content

Commit 02e062e

Browse files
feat(documentai): update the api
#### documentai:v1 The following keys were added: - resources.projects.resources.locations.methods.fetchProcessorTypes (Total Keys: 11) - resources.projects.resources.locations.resources.processors.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.processors.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.processors.methods.disable (Total Keys: 12) - resources.projects.resources.locations.resources.processors.methods.enable (Total Keys: 12) - resources.projects.resources.locations.resources.processors.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.processors.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.processors.methods.setDefaultProcessorVersion (Total Keys: 12) - resources.projects.resources.locations.resources.processors.resources.processorVersions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.processors.resources.processorVersions.methods.deploy (Total Keys: 12) - resources.projects.resources.locations.resources.processors.resources.processorVersions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.processors.resources.processorVersions.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.processors.resources.processorVersions.methods.undeploy (Total Keys: 12) - schemas.GoogleCloudDocumentaiV1DeployProcessorVersionRequest (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1DisableProcessorRequest (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1EnableProcessorRequest (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1EvaluationMetrics (Total Keys: 20) - schemas.GoogleCloudDocumentaiV1EvaluationReference (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1FetchProcessorTypesResponse (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1ListProcessorVersionsResponse (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1ListProcessorsResponse (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1Processor (Total Keys: 34) - schemas.GoogleCloudDocumentaiV1Schema (Total Keys: 13) - schemas.GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1UndeployProcessorVersionRequest (Total Keys: 2)
1 parent 6915ee6 commit 02e062e

6 files changed

+1365
-3
lines changed

docs/dyn/documentai_v1.projects.locations.html

+34
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ <h2>Instance Methods</h2>
8787
<p class="toc_element">
8888
<code><a href="#close">close()</a></code></p>
8989
<p class="firstline">Close httplib2 connections.</p>
90+
<p class="toc_element">
91+
<code><a href="#fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</a></code></p>
92+
<p class="firstline">Fetches processor types.</p>
9093
<p class="toc_element">
9194
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9295
<p class="firstline">Gets information about a location.</p>
@@ -102,6 +105,37 @@ <h3>Method Details</h3>
102105
<pre>Close httplib2 connections.</pre>
103106
</div>
104107

108+
<div class="method">
109+
<code class="details" id="fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</code>
110+
<pre>Fetches processor types.
111+
112+
Args:
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+
119+
Returns:
120+
An object of the form:
121+
122+
{ # Response message for fetch processor types.
123+
&quot;processorTypes&quot;: [ # The list of processor types.
124+
{ # 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.
125+
&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 request access.
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}
133+
&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+
105139
<div class="method">
106140
<code class="details" id="get">get(name, x__xgafv=None)</code>
107141
<pre>Gets information about a location.

0 commit comments

Comments
 (0)