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_v1beta3.projects.locations.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,7 @@ <h3>Method Details</h3>
122
122
{ # Response message for fetch processor types.
123
123
"processorTypes": [ # The list of processor types.
124
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'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 'available_locations' field to show under which regions a processor type is available. For example, users can call either the 'US' or 'EU' endpoint to feach processor types. In the return, we will have an 'invoice parsing' processor with 'available_locations' field only containing 'US'. So the user can try to create an 'invoice parsing' processor under the location 'US'. Such attempt of creating under the location 'EU' will fail. Next ID: 8.
125
-
"allowCreation": 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.
125
+
"allowCreation": 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
126
"availableLocations": [ # The locations in which this processor is available.
127
127
{ # The location information about where the processor is available.
128
128
"locationId": "A String", # The location id, currently must be one of [us, eu].
name: string, Required. The processor resource name. (required)
358
+
x__xgafv: string, V1 error format.
359
+
Allowed values
360
+
1 - v1 error format
361
+
2 - v2 error format
362
+
363
+
Returns:
364
+
An object of the form:
365
+
366
+
{ # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
367
+
"createTime": "A String", # The time the processor was created.
368
+
"defaultProcessorVersion": "A String", # The default processor version.
369
+
"displayName": "A String", # The display name of the processor.
370
+
"kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
371
+
"name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
372
+
"processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
373
+
"state": "A String", # Output only. The state of the processor.
374
+
"type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
<pre>Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
2626
+
2627
+
Args:
2628
+
processor: string, Required. The resource name of the Processor to change default version. (required)
2629
+
body: object, The request body.
2630
+
The object takes the form of:
2631
+
2632
+
{ # Request message for the set default processor version method.
2633
+
"defaultProcessorVersion": "A String", # Required. The resource name of child ProcessorVersion to use as default.
2634
+
}
2635
+
2636
+
x__xgafv: string, V1 error format.
2637
+
Allowed values
2638
+
1 - v1 error format
2639
+
2 - v2 error format
2640
+
2641
+
Returns:
2642
+
An object of the form:
2643
+
2644
+
{ # This resource represents a long-running operation that is the result of a network API call.
2645
+
"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.
2646
+
"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.
2647
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
2648
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
2649
+
{
2650
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
2651
+
},
2652
+
],
2653
+
"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.
2654
+
},
2655
+
"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.
2656
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
2657
+
},
2658
+
"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}`.
2659
+
"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`.
2660
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
0 commit comments