google-apis-documentai_v1beta3 0.58.0 → 0.60.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -271,6 +271,36 @@ module Google
271
271
  execute_or_queue_command(command, &block)
272
272
  end
273
273
 
274
+ # Gets a processor type detail.
275
+ # @param [String] name
276
+ # Required. The processor type resource name.
277
+ # @param [String] fields
278
+ # Selector specifying which fields to include in a partial response.
279
+ # @param [String] quota_user
280
+ # Available to use for quota purposes for server-side applications. Can be any
281
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
282
+ # @param [Google::Apis::RequestOptions] options
283
+ # Request-specific options
284
+ #
285
+ # @yield [result, err] Result & error if block supplied
286
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType] parsed result object
287
+ # @yieldparam err [StandardError] error object if request failed
288
+ #
289
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType]
290
+ #
291
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
292
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
293
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
294
+ def get_project_location_processor_type(name, fields: nil, quota_user: nil, options: nil, &block)
295
+ command = make_simple_command(:get, 'v1beta3/{+name}', options)
296
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType::Representation
297
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType
298
+ command.params['name'] = name unless name.nil?
299
+ command.query['fields'] = fields unless fields.nil?
300
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
301
+ execute_or_queue_command(command, &block)
302
+ end
303
+
274
304
  # Lists the processor types that exist.
275
305
  # @param [String] parent
276
306
  # Required. The location of processor type to list. The available processor
@@ -757,6 +787,42 @@ module Google
757
787
  execute_or_queue_command(command, &block)
758
788
  end
759
789
 
790
+ # Evaluates a ProcessorVersion against annotated documents, producing an
791
+ # Evaluation.
792
+ # @param [String] processor_version
793
+ # Required. The resource name of the ProcessorVersion to evaluate. `projects/`
794
+ # project`/locations/`location`/processors/`processor`/processorVersions/`
795
+ # processorVersion``
796
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest] google_cloud_documentai_v1beta3_evaluate_processor_version_request_object
797
+ # @param [String] fields
798
+ # Selector specifying which fields to include in a partial response.
799
+ # @param [String] quota_user
800
+ # Available to use for quota purposes for server-side applications. Can be any
801
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
802
+ # @param [Google::Apis::RequestOptions] options
803
+ # Request-specific options
804
+ #
805
+ # @yield [result, err] Result & error if block supplied
806
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
807
+ # @yieldparam err [StandardError] error object if request failed
808
+ #
809
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
810
+ #
811
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
812
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
813
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
814
+ def evaluate_project_location_processor_processor_version_processor_version(processor_version, google_cloud_documentai_v1beta3_evaluate_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
815
+ command = make_simple_command(:post, 'v1beta3/{+processorVersion}:evaluateProcessorVersion', options)
816
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest::Representation
817
+ command.request_object = google_cloud_documentai_v1beta3_evaluate_processor_version_request_object
818
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
819
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
820
+ command.params['processorVersion'] = processor_version unless processor_version.nil?
821
+ command.query['fields'] = fields unless fields.nil?
822
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
823
+ execute_or_queue_command(command, &block)
824
+ end
825
+
760
826
  # Gets a processor version detail.
761
827
  # @param [String] name
762
828
  # Required. The processor resource name.
@@ -864,6 +930,42 @@ module Google
864
930
  execute_or_queue_command(command, &block)
865
931
  end
866
932
 
933
+ # Trains a new processor version. Operation metadata is returned as
934
+ # cloud_documentai_core.TrainProcessorVersionMetadata.
935
+ # @param [String] parent
936
+ # Required. The parent (project, location and processor) to create the new
937
+ # version for. Format: `projects/`project`/locations/`location`/processors/`
938
+ # processor``.
939
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest] google_cloud_documentai_v1beta3_train_processor_version_request_object
940
+ # @param [String] fields
941
+ # Selector specifying which fields to include in a partial response.
942
+ # @param [String] quota_user
943
+ # Available to use for quota purposes for server-side applications. Can be any
944
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
945
+ # @param [Google::Apis::RequestOptions] options
946
+ # Request-specific options
947
+ #
948
+ # @yield [result, err] Result & error if block supplied
949
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
950
+ # @yieldparam err [StandardError] error object if request failed
951
+ #
952
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
953
+ #
954
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
955
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
956
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
957
+ def train_project_location_processor_processor_version(parent, google_cloud_documentai_v1beta3_train_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
958
+ command = make_simple_command(:post, 'v1beta3/{+parent}/processorVersions:train', options)
959
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest::Representation
960
+ command.request_object = google_cloud_documentai_v1beta3_train_processor_version_request_object
961
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
962
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
963
+ command.params['parent'] = parent unless parent.nil?
964
+ command.query['fields'] = fields unless fields.nil?
965
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
966
+ execute_or_queue_command(command, &block)
967
+ end
968
+
867
969
  # Undeploys the processor version.
868
970
  # @param [String] name
869
971
  # Required. The processor version resource name to be undeployed.
@@ -896,6 +998,78 @@ module Google
896
998
  command.query['quotaUser'] = quota_user unless quota_user.nil?
897
999
  execute_or_queue_command(command, &block)
898
1000
  end
1001
+
1002
+ # Retrieves a specific evaluation.
1003
+ # @param [String] name
1004
+ # Required. The resource name of the Evaluation to get. `projects/`project`/
1005
+ # locations/`location`/processors/`processor`/processorVersions/`
1006
+ # processorVersion`/evaluations/`evaluation``
1007
+ # @param [String] fields
1008
+ # Selector specifying which fields to include in a partial response.
1009
+ # @param [String] quota_user
1010
+ # Available to use for quota purposes for server-side applications. Can be any
1011
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1012
+ # @param [Google::Apis::RequestOptions] options
1013
+ # Request-specific options
1014
+ #
1015
+ # @yield [result, err] Result & error if block supplied
1016
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Evaluation] parsed result object
1017
+ # @yieldparam err [StandardError] error object if request failed
1018
+ #
1019
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Evaluation]
1020
+ #
1021
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1022
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1023
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1024
+ def get_project_location_processor_processor_version_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
1025
+ command = make_simple_command(:get, 'v1beta3/{+name}', options)
1026
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Evaluation::Representation
1027
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Evaluation
1028
+ command.params['name'] = name unless name.nil?
1029
+ command.query['fields'] = fields unless fields.nil?
1030
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1031
+ execute_or_queue_command(command, &block)
1032
+ end
1033
+
1034
+ # Retrieves a set of evaluations for a given processor version.
1035
+ # @param [String] parent
1036
+ # Required. The resource name of the ProcessorVersion to list evaluations for. `
1037
+ # projects/`project`/locations/`location`/processors/`processor`/
1038
+ # processorVersions/`processorVersion``
1039
+ # @param [Fixnum] page_size
1040
+ # The standard list page size. If unspecified, at most 5 evaluations will be
1041
+ # returned. The maximum value is 100; values above 100 will be coerced to 100.
1042
+ # @param [String] page_token
1043
+ # A page token, received from a previous `ListEvaluations` call. Provide this to
1044
+ # retrieve the subsequent page.
1045
+ # @param [String] fields
1046
+ # Selector specifying which fields to include in a partial response.
1047
+ # @param [String] quota_user
1048
+ # Available to use for quota purposes for server-side applications. Can be any
1049
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1050
+ # @param [Google::Apis::RequestOptions] options
1051
+ # Request-specific options
1052
+ #
1053
+ # @yield [result, err] Result & error if block supplied
1054
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListEvaluationsResponse] parsed result object
1055
+ # @yieldparam err [StandardError] error object if request failed
1056
+ #
1057
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListEvaluationsResponse]
1058
+ #
1059
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1060
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1061
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1062
+ def list_project_location_processor_processor_version_evaluations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1063
+ command = make_simple_command(:get, 'v1beta3/{+parent}/evaluations', options)
1064
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListEvaluationsResponse::Representation
1065
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
1066
+ command.params['parent'] = parent unless parent.nil?
1067
+ command.query['pageSize'] = page_size unless page_size.nil?
1068
+ command.query['pageToken'] = page_token unless page_token.nil?
1069
+ command.query['fields'] = fields unless fields.nil?
1070
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1071
+ execute_or_queue_command(command, &block)
1072
+ end
899
1073
 
900
1074
  protected
901
1075
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-documentai_v1beta3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.58.0
4
+ version: 0.60.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-10-03 00:00:00.000000000 Z
11
+ date: 2023-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.9.0
19
+ version: 0.9.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.9.0
29
+ version: 0.9.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.58.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.60.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.3.14
78
+ rubygems_version: 3.4.2
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Document AI API V1beta3