google-cloud-document_ai-v1beta3 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +145 -31
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb +19 -0
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service.rb +1 -1
- data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
- data/lib/google/cloud/document_ai/v1beta3.rb +2 -2
- data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +4 -0
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +10 -0
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +6 -2
- data/lib/google/cloud/documentai/v1beta3/processor_type_pb.rb +1 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document.rb +145 -79
- data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +10 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +68 -27
- data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +1 -1
- data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +2 -1
- data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +3 -0
- metadata +7 -7
@@ -21,6 +21,16 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module DocumentAI
|
23
23
|
module V1beta3
|
24
|
+
# Options for Process API
|
25
|
+
# @!attribute [rw] ocr_config
|
26
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::OcrConfig]
|
27
|
+
# Only applicable to "Document OCR Processor". Returns error if set on other
|
28
|
+
# processor types.
|
29
|
+
class ProcessOptions
|
30
|
+
include ::Google::Protobuf::MessageExts
|
31
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
32
|
+
end
|
33
|
+
|
24
34
|
# Request message for the process document method.
|
25
35
|
# @!attribute [rw] inline_document
|
26
36
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
@@ -30,11 +40,15 @@ module Google
|
|
30
40
|
# A raw document content (bytes).
|
31
41
|
# @!attribute [rw] name
|
32
42
|
# @return [::String]
|
33
|
-
# Required. The resource name of the
|
43
|
+
# Required. The resource name of the
|
44
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
|
34
45
|
# {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}
|
35
|
-
# to use for processing. If a
|
36
|
-
#
|
37
|
-
#
|
46
|
+
# to use for processing. If a
|
47
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} is specified, the
|
48
|
+
# server will use its [default
|
49
|
+
# version][google.cloud.documentai.v1beta3.Processor.default_processor_version].
|
50
|
+
# Format: `projects/{project}/locations/{location}/processors/{processor}`,
|
51
|
+
# or
|
38
52
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
39
53
|
# @!attribute [rw] document
|
40
54
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
@@ -48,6 +62,9 @@ module Google
|
|
48
62
|
# Specifies which fields to include in ProcessResponse's document.
|
49
63
|
# Only supports top level document and pages field so it must be in the form
|
50
64
|
# of `{document_field_name}` or `pages.{page_field_name}`.
|
65
|
+
# @!attribute [rw] process_options
|
66
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions]
|
67
|
+
# Inference-time options for the process API
|
51
68
|
class ProcessRequest
|
52
69
|
include ::Google::Protobuf::MessageExts
|
53
70
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -114,7 +131,8 @@ module Google
|
|
114
131
|
# Request message for batch process document method.
|
115
132
|
# @!attribute [rw] name
|
116
133
|
# @return [::String]
|
117
|
-
# Required. The resource name of
|
134
|
+
# Required. The resource name of
|
135
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
|
118
136
|
# {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
|
119
137
|
# Format: `projects/{project}/locations/{location}/processors/{processor}`,
|
120
138
|
# or
|
@@ -135,6 +153,9 @@ module Google
|
|
135
153
|
# @return [::Boolean]
|
136
154
|
# Whether Human Review feature should be skipped for this request. Default to
|
137
155
|
# false.
|
156
|
+
# @!attribute [rw] process_options
|
157
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions]
|
158
|
+
# Inference-time options for the process API
|
138
159
|
class BatchProcessRequest
|
139
160
|
include ::Google::Protobuf::MessageExts
|
140
161
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -297,8 +318,8 @@ module Google
|
|
297
318
|
# Request message for list all processors belongs to a project.
|
298
319
|
# @!attribute [rw] parent
|
299
320
|
# @return [::String]
|
300
|
-
# Required. The parent (project and location) which owns this collection of
|
301
|
-
# Format: `projects/{project}/locations/{location}`
|
321
|
+
# Required. The parent (project and location) which owns this collection of
|
322
|
+
# Processors. Format: `projects/{project}/locations/{location}`
|
302
323
|
# @!attribute [rw] page_size
|
303
324
|
# @return [::Integer]
|
304
325
|
# The maximum number of processors to return.
|
@@ -325,6 +346,15 @@ module Google
|
|
325
346
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
326
347
|
end
|
327
348
|
|
349
|
+
# Request message for get processor.
|
350
|
+
# @!attribute [rw] name
|
351
|
+
# @return [::String]
|
352
|
+
# Required. The processor type resource name.
|
353
|
+
class GetProcessorTypeRequest
|
354
|
+
include ::Google::Protobuf::MessageExts
|
355
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
356
|
+
end
|
357
|
+
|
328
358
|
# Request message for get processor.
|
329
359
|
# @!attribute [rw] name
|
330
360
|
# @return [::String]
|
@@ -346,8 +376,9 @@ module Google
|
|
346
376
|
# Request message for list all processor versions belongs to a processor.
|
347
377
|
# @!attribute [rw] parent
|
348
378
|
# @return [::String]
|
349
|
-
# Required. The parent (project, location and processor) to list all
|
350
|
-
# Format:
|
379
|
+
# Required. The parent (project, location and processor) to list all
|
380
|
+
# versions. Format:
|
381
|
+
# `projects/{project}/locations/{location}/processors/{processor}`
|
351
382
|
# @!attribute [rw] page_size
|
352
383
|
# @return [::Integer]
|
353
384
|
# The maximum number of processor versions to return.
|
@@ -446,12 +477,13 @@ module Google
|
|
446
477
|
# on that region, the creation will fail.
|
447
478
|
# @!attribute [rw] parent
|
448
479
|
# @return [::String]
|
449
|
-
# Required. The parent (project and location) under which to create the
|
450
|
-
# Format: `projects/{project}/locations/{location}`
|
480
|
+
# Required. The parent (project and location) under which to create the
|
481
|
+
# processor. Format: `projects/{project}/locations/{location}`
|
451
482
|
# @!attribute [rw] processor
|
452
483
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Processor]
|
453
|
-
# Required. The processor to be created, requires [processor_type] and
|
454
|
-
# to be set. Also, the processor is under CMEK if CMEK fields
|
484
|
+
# Required. The processor to be created, requires [processor_type] and
|
485
|
+
# [display_name] to be set. Also, the processor is under CMEK if CMEK fields
|
486
|
+
# are set.
|
455
487
|
class CreateProcessorRequest
|
456
488
|
include ::Google::Protobuf::MessageExts
|
457
489
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -528,11 +560,14 @@ module Google
|
|
528
560
|
# Request message for the set default processor version method.
|
529
561
|
# @!attribute [rw] processor
|
530
562
|
# @return [::String]
|
531
|
-
# Required. The resource name of the
|
563
|
+
# Required. The resource name of the
|
564
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} to change default
|
565
|
+
# version.
|
532
566
|
# @!attribute [rw] default_processor_version
|
533
567
|
# @return [::String]
|
534
|
-
# Required. The resource name of child
|
535
|
-
#
|
568
|
+
# Required. The resource name of child
|
569
|
+
# {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to use
|
570
|
+
# as default. Format:
|
536
571
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
|
537
572
|
class SetDefaultProcessorVersionRequest
|
538
573
|
include ::Google::Protobuf::MessageExts
|
@@ -558,8 +593,9 @@ module Google
|
|
558
593
|
# Request message for the create processor version method.
|
559
594
|
# @!attribute [rw] parent
|
560
595
|
# @return [::String]
|
561
|
-
# Required. The parent (project, location and processor) to create the new
|
562
|
-
# Format:
|
596
|
+
# Required. The parent (project, location and processor) to create the new
|
597
|
+
# version for. Format:
|
598
|
+
# `projects/{project}/locations/{location}/processors/{processor}`.
|
563
599
|
# @!attribute [rw] processor_version
|
564
600
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion]
|
565
601
|
# Required. The processor version to be created.
|
@@ -571,8 +607,8 @@ module Google
|
|
571
607
|
# Optional. The input data used to train the `ProcessorVersion`.
|
572
608
|
# @!attribute [rw] base_processor_version
|
573
609
|
# @return [::String]
|
574
|
-
# Optional. The processor version to use as a base for training. This
|
575
|
-
# must be a child of `parent`. Format:
|
610
|
+
# Optional. The processor version to use as a base for training. This
|
611
|
+
# processor version must be a child of `parent`. Format:
|
576
612
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
|
577
613
|
class TrainProcessorVersionRequest
|
578
614
|
include ::Google::Protobuf::MessageExts
|
@@ -644,8 +680,8 @@ module Google
|
|
644
680
|
# An inline document proto.
|
645
681
|
# @!attribute [rw] human_review_config
|
646
682
|
# @return [::String]
|
647
|
-
# Required. The resource name of the HumanReviewConfig that the document will
|
648
|
-
# reviewed with.
|
683
|
+
# Required. The resource name of the HumanReviewConfig that the document will
|
684
|
+
# be reviewed with.
|
649
685
|
# @!attribute [rw] document
|
650
686
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
651
687
|
# The document that needs human review.
|
@@ -750,12 +786,14 @@ module Google
|
|
750
786
|
# Evaluates the given ProcessorVersion against the supplied documents.
|
751
787
|
# @!attribute [rw] processor_version
|
752
788
|
# @return [::String]
|
753
|
-
# Required. The resource name of the
|
789
|
+
# Required. The resource name of the
|
790
|
+
# {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to
|
791
|
+
# evaluate.
|
754
792
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
755
793
|
# @!attribute [rw] evaluation_documents
|
756
794
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
|
757
|
-
# Optional. The documents used in the evaluation. If unspecified, use the
|
758
|
-
# dataset as evaluation input.
|
795
|
+
# Optional. The documents used in the evaluation. If unspecified, use the
|
796
|
+
# processor's dataset as evaluation input.
|
759
797
|
class EvaluateProcessorVersionRequest
|
760
798
|
include ::Google::Protobuf::MessageExts
|
761
799
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -782,7 +820,8 @@ module Google
|
|
782
820
|
# Retrieves a specific Evaluation.
|
783
821
|
# @!attribute [rw] name
|
784
822
|
# @return [::String]
|
785
|
-
# Required. The resource name of the
|
823
|
+
# Required. The resource name of the
|
824
|
+
# {::Google::Cloud::DocumentAI::V1beta3::Evaluation Evaluation} to get.
|
786
825
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
|
787
826
|
class GetEvaluationRequest
|
788
827
|
include ::Google::Protobuf::MessageExts
|
@@ -792,7 +831,9 @@ module Google
|
|
792
831
|
# Retrieves a list of evaluations for a given ProcessorVersion.
|
793
832
|
# @!attribute [rw] parent
|
794
833
|
# @return [::String]
|
795
|
-
# Required. The resource name of the
|
834
|
+
# Required. The resource name of the
|
835
|
+
# {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion} to
|
836
|
+
# list evaluations for.
|
796
837
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
797
838
|
# @!attribute [rw] page_size
|
798
839
|
# @return [::Integer]
|
@@ -58,7 +58,7 @@ module Google
|
|
58
58
|
# conventions:
|
59
59
|
#
|
60
60
|
# - *use `snake_casing`*
|
61
|
-
# - name matching is case-
|
61
|
+
# - name matching is case-sensitive
|
62
62
|
# - Maximum 64 characters.
|
63
63
|
# - Must start with a letter.
|
64
64
|
# - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
|
@@ -121,7 +121,8 @@ module Google
|
|
121
121
|
# The default processor version.
|
122
122
|
# @!attribute [r] process_endpoint
|
123
123
|
# @return [::String]
|
124
|
-
# Output only. Immutable. The http endpoint that can be called to invoke
|
124
|
+
# Output only. Immutable. The http endpoint that can be called to invoke
|
125
|
+
# processing.
|
125
126
|
# @!attribute [rw] create_time
|
126
127
|
# @return [::Google::Protobuf::Timestamp]
|
127
128
|
# The time the processor was created.
|
@@ -43,6 +43,9 @@ module Google
|
|
43
43
|
# @!attribute [rw] launch_stage
|
44
44
|
# @return [::Google::Api::LaunchStage]
|
45
45
|
# Launch stage of the processor type
|
46
|
+
# @!attribute [rw] sample_document_uris
|
47
|
+
# @return [::Array<::String>]
|
48
|
+
# A set of Cloud Storage URIs of sample documents for this processor.
|
46
49
|
class ProcessorType
|
47
50
|
include ::Google::Protobuf::MessageExts
|
48
51
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-document_ai-v1beta3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.17.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:
|
11
|
+
date: 2023-01-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: 0.16.0
|
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:
|
29
|
+
version: 0.16.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,7 +50,7 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - ">="
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: '0.
|
53
|
+
version: '0.3'
|
54
54
|
- - "<"
|
55
55
|
- !ruby/object:Gem::Version
|
56
56
|
version: 2.a
|
@@ -60,7 +60,7 @@ dependencies:
|
|
60
60
|
requirements:
|
61
61
|
- - ">="
|
62
62
|
- !ruby/object:Gem::Version
|
63
|
-
version: '0.
|
63
|
+
version: '0.3'
|
64
64
|
- - "<"
|
65
65
|
- !ruby/object:Gem::Version
|
66
66
|
version: 2.a
|
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
256
256
|
- !ruby/object:Gem::Version
|
257
257
|
version: '0'
|
258
258
|
requirements: []
|
259
|
-
rubygems_version: 3.
|
259
|
+
rubygems_version: 3.4.2
|
260
260
|
signing_key:
|
261
261
|
specification_version: 4
|
262
262
|
summary: API Client library for the Document AI V1beta3 API
|