google-apis-documentai_v1beta3 0.22.0 → 0.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/lib/google/apis/documentai_v1beta3/classes.rb +659 -4
- data/lib/google/apis/documentai_v1beta3/gem_version.rb +2 -2
- data/lib/google/apis/documentai_v1beta3/representations.rb +396 -0
- data/lib/google/apis/documentai_v1beta3/service.rb +231 -0
- metadata +3 -3
@@ -439,6 +439,36 @@ module Google
|
|
439
439
|
execute_or_queue_command(command, &block)
|
440
440
|
end
|
441
441
|
|
442
|
+
# Gets a processor detail.
|
443
|
+
# @param [String] name
|
444
|
+
# Required. The processor resource name.
|
445
|
+
# @param [String] fields
|
446
|
+
# Selector specifying which fields to include in a partial response.
|
447
|
+
# @param [String] quota_user
|
448
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
449
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
450
|
+
# @param [Google::Apis::RequestOptions] options
|
451
|
+
# Request-specific options
|
452
|
+
#
|
453
|
+
# @yield [result, err] Result & error if block supplied
|
454
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] parsed result object
|
455
|
+
# @yieldparam err [StandardError] error object if request failed
|
456
|
+
#
|
457
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor]
|
458
|
+
#
|
459
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
460
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
461
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
462
|
+
def get_project_location_processor(name, fields: nil, quota_user: nil, options: nil, &block)
|
463
|
+
command = make_simple_command(:get, 'v1beta3/{+name}', options)
|
464
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
|
465
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor
|
466
|
+
command.params['name'] = name unless name.nil?
|
467
|
+
command.query['fields'] = fields unless fields.nil?
|
468
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
469
|
+
execute_or_queue_command(command, &block)
|
470
|
+
end
|
471
|
+
|
442
472
|
# Lists all processors which belong to this project.
|
443
473
|
# @param [String] parent
|
444
474
|
# Required. The parent (project and location) which owns this collection of
|
@@ -516,6 +546,40 @@ module Google
|
|
516
546
|
execute_or_queue_command(command, &block)
|
517
547
|
end
|
518
548
|
|
549
|
+
# Set the default (active) version of a Processor that will be used in
|
550
|
+
# ProcessDocument and BatchProcessDocuments.
|
551
|
+
# @param [String] processor
|
552
|
+
# Required. The resource name of the Processor to change default version.
|
553
|
+
# @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest] google_cloud_documentai_v1beta3_set_default_processor_version_request_object
|
554
|
+
# @param [String] fields
|
555
|
+
# Selector specifying which fields to include in a partial response.
|
556
|
+
# @param [String] quota_user
|
557
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
558
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
559
|
+
# @param [Google::Apis::RequestOptions] options
|
560
|
+
# Request-specific options
|
561
|
+
#
|
562
|
+
# @yield [result, err] Result & error if block supplied
|
563
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
564
|
+
# @yieldparam err [StandardError] error object if request failed
|
565
|
+
#
|
566
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
567
|
+
#
|
568
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
569
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
570
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
571
|
+
def set_project_location_processor_default_processor_version(processor, google_cloud_documentai_v1beta3_set_default_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
572
|
+
command = make_simple_command(:post, 'v1beta3/{+processor}:setDefaultProcessorVersion', options)
|
573
|
+
command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest::Representation
|
574
|
+
command.request_object = google_cloud_documentai_v1beta3_set_default_processor_version_request_object
|
575
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
576
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
577
|
+
command.params['processor'] = processor unless processor.nil?
|
578
|
+
command.query['fields'] = fields unless fields.nil?
|
579
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
580
|
+
execute_or_queue_command(command, &block)
|
581
|
+
end
|
582
|
+
|
519
583
|
# Send a document for Human Review. The input document should be processed by
|
520
584
|
# the specified processor.
|
521
585
|
# @param [String] human_review_config
|
@@ -588,6 +652,140 @@ module Google
|
|
588
652
|
execute_or_queue_command(command, &block)
|
589
653
|
end
|
590
654
|
|
655
|
+
# Deletes the processor version, all artifacts under the processor version will
|
656
|
+
# be deleted.
|
657
|
+
# @param [String] name
|
658
|
+
# Required. The processor version resource name to be deleted.
|
659
|
+
# @param [String] fields
|
660
|
+
# Selector specifying which fields to include in a partial response.
|
661
|
+
# @param [String] quota_user
|
662
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
663
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
664
|
+
# @param [Google::Apis::RequestOptions] options
|
665
|
+
# Request-specific options
|
666
|
+
#
|
667
|
+
# @yield [result, err] Result & error if block supplied
|
668
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
669
|
+
# @yieldparam err [StandardError] error object if request failed
|
670
|
+
#
|
671
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
672
|
+
#
|
673
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
674
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
675
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
676
|
+
def delete_project_location_processor_processor_version(name, fields: nil, quota_user: nil, options: nil, &block)
|
677
|
+
command = make_simple_command(:delete, 'v1beta3/{+name}', options)
|
678
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
679
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
680
|
+
command.params['name'] = name unless name.nil?
|
681
|
+
command.query['fields'] = fields unless fields.nil?
|
682
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
683
|
+
execute_or_queue_command(command, &block)
|
684
|
+
end
|
685
|
+
|
686
|
+
# Deploys the processor version.
|
687
|
+
# @param [String] name
|
688
|
+
# Required. The processor version resource name to be deployed.
|
689
|
+
# @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest] google_cloud_documentai_v1beta3_deploy_processor_version_request_object
|
690
|
+
# @param [String] fields
|
691
|
+
# Selector specifying which fields to include in a partial response.
|
692
|
+
# @param [String] quota_user
|
693
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
694
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
695
|
+
# @param [Google::Apis::RequestOptions] options
|
696
|
+
# Request-specific options
|
697
|
+
#
|
698
|
+
# @yield [result, err] Result & error if block supplied
|
699
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
700
|
+
# @yieldparam err [StandardError] error object if request failed
|
701
|
+
#
|
702
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
703
|
+
#
|
704
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
705
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
706
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
707
|
+
def deploy_project_location_processor_processor_version(name, google_cloud_documentai_v1beta3_deploy_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
708
|
+
command = make_simple_command(:post, 'v1beta3/{+name}:deploy', options)
|
709
|
+
command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest::Representation
|
710
|
+
command.request_object = google_cloud_documentai_v1beta3_deploy_processor_version_request_object
|
711
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
712
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
713
|
+
command.params['name'] = name unless name.nil?
|
714
|
+
command.query['fields'] = fields unless fields.nil?
|
715
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
716
|
+
execute_or_queue_command(command, &block)
|
717
|
+
end
|
718
|
+
|
719
|
+
# Gets a processor version detail.
|
720
|
+
# @param [String] name
|
721
|
+
# Required. The processor resource name.
|
722
|
+
# @param [String] fields
|
723
|
+
# Selector specifying which fields to include in a partial response.
|
724
|
+
# @param [String] quota_user
|
725
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
726
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
727
|
+
# @param [Google::Apis::RequestOptions] options
|
728
|
+
# Request-specific options
|
729
|
+
#
|
730
|
+
# @yield [result, err] Result & error if block supplied
|
731
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion] parsed result object
|
732
|
+
# @yieldparam err [StandardError] error object if request failed
|
733
|
+
#
|
734
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion]
|
735
|
+
#
|
736
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
737
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
738
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
739
|
+
def get_project_location_processor_processor_version(name, fields: nil, quota_user: nil, options: nil, &block)
|
740
|
+
command = make_simple_command(:get, 'v1beta3/{+name}', options)
|
741
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion::Representation
|
742
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorVersion
|
743
|
+
command.params['name'] = name unless name.nil?
|
744
|
+
command.query['fields'] = fields unless fields.nil?
|
745
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
746
|
+
execute_or_queue_command(command, &block)
|
747
|
+
end
|
748
|
+
|
749
|
+
# Lists all versions of a processor.
|
750
|
+
# @param [String] parent
|
751
|
+
# Required. The parent (project, location and processor) to list all versions.
|
752
|
+
# Format: projects/`project`/locations/`location`/processors/`processor`
|
753
|
+
# @param [Fixnum] page_size
|
754
|
+
# The maximum number of processor versions to return. If unspecified, at most 10
|
755
|
+
# processor versions will be returned. The maximum value is 20; values above 20
|
756
|
+
# will be coerced to 20.
|
757
|
+
# @param [String] page_token
|
758
|
+
# We will return the processor versions sorted by creation time. The page token
|
759
|
+
# will point to the next processor version.
|
760
|
+
# @param [String] fields
|
761
|
+
# Selector specifying which fields to include in a partial response.
|
762
|
+
# @param [String] quota_user
|
763
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
764
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
765
|
+
# @param [Google::Apis::RequestOptions] options
|
766
|
+
# Request-specific options
|
767
|
+
#
|
768
|
+
# @yield [result, err] Result & error if block supplied
|
769
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse] parsed result object
|
770
|
+
# @yieldparam err [StandardError] error object if request failed
|
771
|
+
#
|
772
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse]
|
773
|
+
#
|
774
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
775
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
776
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
777
|
+
def list_project_location_processor_processor_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
778
|
+
command = make_simple_command(:get, 'v1beta3/{+parent}/processorVersions', options)
|
779
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse::Representation
|
780
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse
|
781
|
+
command.params['parent'] = parent unless parent.nil?
|
782
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
783
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
784
|
+
command.query['fields'] = fields unless fields.nil?
|
785
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
786
|
+
execute_or_queue_command(command, &block)
|
787
|
+
end
|
788
|
+
|
591
789
|
# Processes a single document.
|
592
790
|
# @param [String] name
|
593
791
|
# Required. The resource name of the Processor or ProcessorVersion to use for
|
@@ -624,6 +822,39 @@ module Google
|
|
624
822
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
625
823
|
execute_or_queue_command(command, &block)
|
626
824
|
end
|
825
|
+
|
826
|
+
# Undeploys the processor version.
|
827
|
+
# @param [String] name
|
828
|
+
# Required. The processor version resource name to be undeployed.
|
829
|
+
# @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest] google_cloud_documentai_v1beta3_undeploy_processor_version_request_object
|
830
|
+
# @param [String] fields
|
831
|
+
# Selector specifying which fields to include in a partial response.
|
832
|
+
# @param [String] quota_user
|
833
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
834
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
835
|
+
# @param [Google::Apis::RequestOptions] options
|
836
|
+
# Request-specific options
|
837
|
+
#
|
838
|
+
# @yield [result, err] Result & error if block supplied
|
839
|
+
# @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
|
840
|
+
# @yieldparam err [StandardError] error object if request failed
|
841
|
+
#
|
842
|
+
# @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
|
843
|
+
#
|
844
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
845
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
846
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
847
|
+
def undeploy_project_location_processor_processor_version(name, google_cloud_documentai_v1beta3_undeploy_processor_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
848
|
+
command = make_simple_command(:post, 'v1beta3/{+name}:undeploy', options)
|
849
|
+
command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest::Representation
|
850
|
+
command.request_object = google_cloud_documentai_v1beta3_undeploy_processor_version_request_object
|
851
|
+
command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
|
852
|
+
command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
|
853
|
+
command.params['name'] = name unless name.nil?
|
854
|
+
command.query['fields'] = fields unless fields.nil?
|
855
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
856
|
+
execute_or_queue_command(command, &block)
|
857
|
+
end
|
627
858
|
|
628
859
|
protected
|
629
860
|
|
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.
|
4
|
+
version: 0.26.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: 2021-
|
11
|
+
date: 2021-10-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -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/master/generated/google-apis-documentai_v1beta3/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.26.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-documentai_v1beta3
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|