You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1.projects.locations.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ <h3>Method Details</h3>
136
136
Args:
137
137
name: string, The resource that owns the locations collection, if applicable. (required)
138
138
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
139
-
pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
139
+
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
140
140
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1.uiv1beta3.projects.locations.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -131,7 +131,7 @@ <h3>Method Details</h3>
131
131
Args:
132
132
name: string, The resource that owns the locations collection, if applicable. (required)
133
133
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
134
-
pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
134
+
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
135
135
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1beta3.projects.locations.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ <h3>Method Details</h3>
136
136
Args:
137
137
name: string, The resource that owns the locations collection, if applicable. (required)
138
138
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
139
-
pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
139
+
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
140
140
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
<p class="firstline">Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.</p>
<p class="firstline">Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.</p>
<pre>Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
192
+
193
+
Args:
194
+
parent: string, Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location} (required)
195
+
body: object, The request body.
196
+
The object takes the form of:
197
+
198
+
{ # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
199
+
"createTime": "A String", # The time the processor was created.
200
+
"defaultProcessorVersion": "A String", # The default processor version.
201
+
"displayName": "A String", # The display name of the processor.
202
+
"kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
203
+
"name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
204
+
"processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
205
+
"state": "A String", # Output only. The state of the processor.
206
+
"type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
207
+
}
208
+
209
+
x__xgafv: string, V1 error format.
210
+
Allowed values
211
+
1 - v1 error format
212
+
2 - v2 error format
213
+
214
+
Returns:
215
+
An object of the form:
216
+
217
+
{ # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
218
+
"createTime": "A String", # The time the processor was created.
219
+
"defaultProcessorVersion": "A String", # The default processor version.
220
+
"displayName": "A String", # The display name of the processor.
221
+
"kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
222
+
"name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
223
+
"processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
224
+
"state": "A String", # Output only. The state of the processor.
225
+
"type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
<pre>Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
232
+
233
+
Args:
234
+
name: string, Required. The processor resource name to be deleted. (required)
235
+
x__xgafv: string, V1 error format.
236
+
Allowed values
237
+
1 - v1 error format
238
+
2 - v2 error format
239
+
240
+
Returns:
241
+
An object of the form:
242
+
243
+
{ # This resource represents a long-running operation that is the result of a network API call.
244
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
245
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
246
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
247
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
248
+
{
249
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
250
+
},
251
+
],
252
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
253
+
},
254
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
255
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
256
+
},
257
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
258
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
259
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
name: string, Required. The processor resource name to be disabled. (required)
270
+
body: object, The request body.
271
+
The object takes the form of:
272
+
273
+
{ # Request message for the disable processor method.
274
+
}
275
+
276
+
x__xgafv: string, V1 error format.
277
+
Allowed values
278
+
1 - v1 error format
279
+
2 - v2 error format
280
+
281
+
Returns:
282
+
An object of the form:
283
+
284
+
{ # This resource represents a long-running operation that is the result of a network API call.
285
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
286
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
287
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
288
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
289
+
{
290
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
291
+
},
292
+
],
293
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
294
+
},
295
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
296
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
297
+
},
298
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
299
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
300
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
name: string, Required. The processor resource name to be enabled. (required)
311
+
body: object, The request body.
312
+
The object takes the form of:
313
+
314
+
{ # Request message for the enable processor method.
315
+
}
316
+
317
+
x__xgafv: string, V1 error format.
318
+
Allowed values
319
+
1 - v1 error format
320
+
2 - v2 error format
321
+
322
+
Returns:
323
+
An object of the form:
324
+
325
+
{ # This resource represents a long-running operation that is the result of a network API call.
326
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
327
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
328
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
329
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
330
+
{
331
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
332
+
},
333
+
],
334
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
335
+
},
336
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
337
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
338
+
},
339
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
340
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
341
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Lists all processors which belong to this project.
349
+
350
+
Args:
351
+
parent: string, Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location} (required)
352
+
pageSize: integer, The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100.
353
+
pageToken: string, We will return the processors sorted by creation time. The page token will point to the next processor.
354
+
x__xgafv: string, V1 error format.
355
+
Allowed values
356
+
1 - v1 error format
357
+
2 - v2 error format
358
+
359
+
Returns:
360
+
An object of the form:
361
+
362
+
{ # Response message for list processors.
363
+
"nextPageToken": "A String", # Points to the next processor, otherwise empty.
364
+
"processors": [ # The list of processors.
365
+
{ # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
366
+
"createTime": "A String", # The time the processor was created.
367
+
"defaultProcessorVersion": "A String", # The default processor version.
368
+
"displayName": "A String", # The display name of the processor.
369
+
"kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
370
+
"name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
371
+
"processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
372
+
"state": "A String", # Output only. The state of the processor.
373
+
"type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
0 commit comments