google-cloud-document_ai-v1beta3 0.6.0 → 0.9.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (25) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -1
  4. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +468 -16
  5. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb +6 -6
  6. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb +17 -0
  7. data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
  8. data/lib/google/cloud/documentai/v1beta3/document_pb.rb +5 -0
  9. data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +64 -16
  10. data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +14 -0
  11. data/lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb +36 -0
  12. data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +45 -0
  13. data/lib/google/cloud/documentai/v1beta3/processor_type_pb.rb +32 -0
  14. data/proto_docs/google/api/field_behavior.rb +7 -1
  15. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +30 -20
  16. data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +149 -39
  17. data/proto_docs/google/cloud/documentai/v1beta3/geometry.rb +2 -2
  18. data/proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb +65 -0
  19. data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +86 -0
  20. data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +59 -0
  21. data/proto_docs/google/type/color.rb +16 -11
  22. data/proto_docs/google/type/date.rb +14 -11
  23. data/proto_docs/google/type/datetime.rb +9 -1
  24. data/proto_docs/google/type/money.rb +1 -1
  25. metadata +19 -7
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -396,9 +396,9 @@ module Google
396
396
  end
397
397
 
398
398
  ##
399
- # Waits for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
399
+ # Waits until the specified long-running operation is done or reaches at most
400
+ # a specified timeout, returning the latest state. If the operation is
401
+ # already done, the latest state is immediately returned. If the timeout
402
402
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
403
  # timeout is used. If the server does not support this method, it returns
404
404
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -500,7 +500,7 @@ module Google
500
500
  #
501
501
  # @!attribute [rw] endpoint
502
502
  # The hostname or hostname:port of the service endpoint.
503
- # Defaults to `"us-documentai.googleapis.com"`.
503
+ # Defaults to `"documentai.googleapis.com"`.
504
504
  # @return [::String]
505
505
  # @!attribute [rw] credentials
506
506
  # Credentials to send with calls. You may provide any of the following types:
@@ -551,7 +551,7 @@ module Google
551
551
  class Configuration
552
552
  extend ::Gapic::Config
553
553
 
554
- config_attr :endpoint, "us-documentai.googleapis.com", ::String
554
+ config_attr :endpoint, "documentai.googleapis.com", ::String
555
555
  config_attr :credentials, nil do |value|
556
556
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
557
557
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -43,6 +43,23 @@ module Google
43
43
  "projects/#{project}/locations/#{location}/processors/#{processor}/humanReviewConfig"
44
44
  end
45
45
 
46
+ ##
47
+ # Create a fully-qualified Location resource string.
48
+ #
49
+ # The resource will be in the following format:
50
+ #
51
+ # `projects/{project}/locations/{location}`
52
+ #
53
+ # @param project [String]
54
+ # @param location [String]
55
+ #
56
+ # @return [::String]
57
+ def location_path project:, location:
58
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
59
+
60
+ "projects/#{project}/locations/#{location}"
61
+ end
62
+
46
63
  ##
47
64
  # Create a fully-qualified Processor resource string.
48
65
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1beta3
24
- VERSION = "0.6.0"
24
+ VERSION = "0.9.1"
25
25
  end
26
26
  end
27
27
  end
@@ -63,6 +63,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
63
63
  repeated :visual_elements, :message, 9, "google.cloud.documentai.v1beta3.Document.Page.VisualElement"
64
64
  repeated :tables, :message, 10, "google.cloud.documentai.v1beta3.Document.Page.Table"
65
65
  repeated :form_fields, :message, 11, "google.cloud.documentai.v1beta3.Document.Page.FormField"
66
+ optional :provenance, :message, 16, "google.cloud.documentai.v1beta3.Document.Provenance"
66
67
  end
67
68
  add_message "google.cloud.documentai.v1beta3.Document.Page.Dimension" do
68
69
  optional :width, :float, 1
@@ -150,6 +151,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
150
151
  repeated :name_detected_languages, :message, 3, "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage"
151
152
  repeated :value_detected_languages, :message, 4, "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage"
152
153
  optional :value_type, :string, 5
154
+ optional :provenance, :message, 8, "google.cloud.documentai.v1beta3.Document.Provenance"
153
155
  end
154
156
  add_message "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage" do
155
157
  optional :language_code, :string, 1
@@ -199,6 +201,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
199
201
  optional :layout_type, :enum, 2, "google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType"
200
202
  optional :layout_id, :string, 3
201
203
  optional :bounding_poly, :message, 4, "google.cloud.documentai.v1beta3.BoundingPoly"
204
+ optional :confidence, :float, 5
202
205
  end
203
206
  add_enum "google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType" do
204
207
  value :LAYOUT_TYPE_UNSPECIFIED, 0
@@ -218,6 +221,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
218
221
  end
219
222
  add_message "google.cloud.documentai.v1beta3.Document.Provenance.Parent" do
220
223
  optional :revision, :int32, 1
224
+ optional :index, :int32, 3
221
225
  optional :id, :int32, 2
222
226
  end
223
227
  add_enum "google.cloud.documentai.v1beta3.Document.Provenance.OperationType" do
@@ -227,6 +231,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
227
231
  value :REPLACE, 3
228
232
  value :EVAL_REQUESTED, 4
229
233
  value :EVAL_APPROVED, 5
234
+ value :EVAL_SKIPPED, 6
230
235
  end
231
236
  add_message "google.cloud.documentai.v1beta3.Document.Revision" do
232
237
  optional :id, :string, 1
@@ -9,6 +9,9 @@ require 'google/api/field_behavior_pb'
9
9
  require 'google/api/resource_pb'
10
10
  require 'google/cloud/documentai/v1beta3/document_pb'
11
11
  require 'google/cloud/documentai/v1beta3/document_io_pb'
12
+ require 'google/cloud/documentai/v1beta3/operation_metadata_pb'
13
+ require 'google/cloud/documentai/v1beta3/processor_pb'
14
+ require 'google/cloud/documentai/v1beta3/processor_type_pb'
12
15
  require 'google/longrunning/operations_pb'
13
16
  require 'google/protobuf/field_mask_pb'
14
17
  require 'google/protobuf/timestamp_pb'
@@ -81,13 +84,60 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
81
84
  value :CANCELLED, 5
82
85
  value :FAILED, 6
83
86
  end
87
+ add_message "google.cloud.documentai.v1beta3.FetchProcessorTypesRequest" do
88
+ optional :parent, :string, 1
89
+ end
90
+ add_message "google.cloud.documentai.v1beta3.FetchProcessorTypesResponse" do
91
+ repeated :processor_types, :message, 1, "google.cloud.documentai.v1beta3.ProcessorType"
92
+ end
93
+ add_message "google.cloud.documentai.v1beta3.ListProcessorsRequest" do
94
+ optional :parent, :string, 1
95
+ optional :page_size, :int32, 2
96
+ optional :page_token, :string, 3
97
+ end
98
+ add_message "google.cloud.documentai.v1beta3.ListProcessorsResponse" do
99
+ repeated :processors, :message, 1, "google.cloud.documentai.v1beta3.Processor"
100
+ optional :next_page_token, :string, 2
101
+ end
102
+ add_message "google.cloud.documentai.v1beta3.CreateProcessorRequest" do
103
+ optional :parent, :string, 1
104
+ optional :processor, :message, 2, "google.cloud.documentai.v1beta3.Processor"
105
+ end
106
+ add_message "google.cloud.documentai.v1beta3.DeleteProcessorRequest" do
107
+ optional :name, :string, 1
108
+ end
109
+ add_message "google.cloud.documentai.v1beta3.DeleteProcessorMetadata" do
110
+ optional :common_metadata, :message, 5, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
111
+ end
112
+ add_message "google.cloud.documentai.v1beta3.EnableProcessorRequest" do
113
+ optional :name, :string, 1
114
+ end
115
+ add_message "google.cloud.documentai.v1beta3.EnableProcessorResponse" do
116
+ end
117
+ add_message "google.cloud.documentai.v1beta3.EnableProcessorMetadata" do
118
+ optional :common_metadata, :message, 5, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
119
+ end
120
+ add_message "google.cloud.documentai.v1beta3.DisableProcessorRequest" do
121
+ optional :name, :string, 1
122
+ end
123
+ add_message "google.cloud.documentai.v1beta3.DisableProcessorResponse" do
124
+ end
125
+ add_message "google.cloud.documentai.v1beta3.DisableProcessorMetadata" do
126
+ optional :common_metadata, :message, 5, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
127
+ end
84
128
  add_message "google.cloud.documentai.v1beta3.ReviewDocumentRequest" do
85
129
  optional :human_review_config, :string, 1
86
130
  optional :document, :message, 2, "google.cloud.documentai.v1beta3.Document"
131
+ optional :enable_schema_validation, :bool, 3
132
+ optional :priority, :enum, 5, "google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority"
87
133
  oneof :source do
88
134
  optional :inline_document, :message, 4, "google.cloud.documentai.v1beta3.Document"
89
135
  end
90
136
  end
137
+ add_enum "google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority" do
138
+ value :DEFAULT, 0
139
+ value :URGENT, 1
140
+ end
91
141
  add_message "google.cloud.documentai.v1beta3.ReviewDocumentResponse" do
92
142
  optional :gcs_destination, :string, 1
93
143
  end
@@ -106,20 +156,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
106
156
  value :FAILED, 4
107
157
  value :CANCELLED, 5
108
158
  end
109
- add_message "google.cloud.documentai.v1beta3.CommonOperationMetadata" do
110
- optional :state, :enum, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata.State"
111
- optional :state_message, :string, 2
112
- optional :create_time, :message, 3, "google.protobuf.Timestamp"
113
- optional :update_time, :message, 4, "google.protobuf.Timestamp"
114
- end
115
- add_enum "google.cloud.documentai.v1beta3.CommonOperationMetadata.State" do
116
- value :STATE_UNSPECIFIED, 0
117
- value :RUNNING, 1
118
- value :CANCELLING, 2
119
- value :SUCCEEDED, 3
120
- value :FAILED, 4
121
- value :CANCELLED, 5
122
- end
123
159
  end
124
160
  end
125
161
 
@@ -138,12 +174,24 @@ module Google
138
174
  BatchProcessMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.BatchProcessMetadata").msgclass
139
175
  BatchProcessMetadata::IndividualProcessStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus").msgclass
140
176
  BatchProcessMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.BatchProcessMetadata.State").enummodule
177
+ FetchProcessorTypesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.FetchProcessorTypesRequest").msgclass
178
+ FetchProcessorTypesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.FetchProcessorTypesResponse").msgclass
179
+ ListProcessorsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ListProcessorsRequest").msgclass
180
+ ListProcessorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ListProcessorsResponse").msgclass
181
+ CreateProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CreateProcessorRequest").msgclass
182
+ DeleteProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DeleteProcessorRequest").msgclass
183
+ DeleteProcessorMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DeleteProcessorMetadata").msgclass
184
+ EnableProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EnableProcessorRequest").msgclass
185
+ EnableProcessorResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EnableProcessorResponse").msgclass
186
+ EnableProcessorMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EnableProcessorMetadata").msgclass
187
+ DisableProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DisableProcessorRequest").msgclass
188
+ DisableProcessorResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DisableProcessorResponse").msgclass
189
+ DisableProcessorMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DisableProcessorMetadata").msgclass
141
190
  ReviewDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentRequest").msgclass
191
+ ReviewDocumentRequest::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority").enummodule
142
192
  ReviewDocumentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentResponse").msgclass
143
193
  ReviewDocumentOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata").msgclass
144
194
  ReviewDocumentOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata.State").enummodule
145
- CommonOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata").msgclass
146
- CommonOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata.State").enummodule
147
195
  end
148
196
  end
149
197
  end
@@ -41,6 +41,20 @@ module Google
41
41
  # LRO endpoint to batch process many documents. The output is written
42
42
  # to Cloud Storage as JSON in the [Document] format.
43
43
  rpc :BatchProcessDocuments, ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest, ::Google::Longrunning::Operation
44
+ # Fetches processor types.
45
+ rpc :FetchProcessorTypes, ::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesRequest, ::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse
46
+ # Lists all processors which belong to this project.
47
+ rpc :ListProcessors, ::Google::Cloud::DocumentAI::V1beta3::ListProcessorsRequest, ::Google::Cloud::DocumentAI::V1beta3::ListProcessorsResponse
48
+ # Creates a processor from the type processor that the user chose.
49
+ # The processor will be at "ENABLED" state by default after its creation.
50
+ rpc :CreateProcessor, ::Google::Cloud::DocumentAI::V1beta3::CreateProcessorRequest, ::Google::Cloud::DocumentAI::V1beta3::Processor
51
+ # Deletes the processor, unloads all deployed model artifacts if it was
52
+ # enabled and then deletes all artifacts associated with this processor.
53
+ rpc :DeleteProcessor, ::Google::Cloud::DocumentAI::V1beta3::DeleteProcessorRequest, ::Google::Longrunning::Operation
54
+ # Enables a processor
55
+ rpc :EnableProcessor, ::Google::Cloud::DocumentAI::V1beta3::EnableProcessorRequest, ::Google::Longrunning::Operation
56
+ # Disables a processor
57
+ rpc :DisableProcessor, ::Google::Cloud::DocumentAI::V1beta3::DisableProcessorRequest, ::Google::Longrunning::Operation
44
58
  # Send a document for Human Review. The input document should be processed by
45
59
  # the specified processor.
46
60
  rpc :ReviewDocument, ::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest, ::Google::Longrunning::Operation
@@ -0,0 +1,36 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/documentai/v1beta3/operation_metadata.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/protobuf/timestamp_pb'
7
+ require 'google/api/annotations_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/cloud/documentai/v1beta3/operation_metadata.proto", :syntax => :proto3) do
10
+ add_message "google.cloud.documentai.v1beta3.CommonOperationMetadata" do
11
+ optional :state, :enum, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata.State"
12
+ optional :state_message, :string, 2
13
+ optional :create_time, :message, 3, "google.protobuf.Timestamp"
14
+ optional :update_time, :message, 4, "google.protobuf.Timestamp"
15
+ end
16
+ add_enum "google.cloud.documentai.v1beta3.CommonOperationMetadata.State" do
17
+ value :STATE_UNSPECIFIED, 0
18
+ value :RUNNING, 1
19
+ value :CANCELLING, 2
20
+ value :SUCCEEDED, 3
21
+ value :FAILED, 4
22
+ value :CANCELLED, 5
23
+ end
24
+ end
25
+ end
26
+
27
+ module Google
28
+ module Cloud
29
+ module DocumentAI
30
+ module V1beta3
31
+ CommonOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata").msgclass
32
+ CommonOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata.State").enummodule
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,45 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/documentai/v1beta3/processor.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
8
+ require 'google/cloud/documentai/v1beta3/document_io_pb'
9
+ require 'google/protobuf/timestamp_pb'
10
+ require 'google/api/annotations_pb'
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/cloud/documentai/v1beta3/processor.proto", :syntax => :proto3) do
13
+ add_message "google.cloud.documentai.v1beta3.Processor" do
14
+ optional :name, :string, 1
15
+ optional :type, :string, 2
16
+ optional :display_name, :string, 3
17
+ optional :state, :enum, 4, "google.cloud.documentai.v1beta3.Processor.State"
18
+ optional :default_processor_version, :string, 9
19
+ optional :process_endpoint, :string, 6
20
+ optional :create_time, :message, 7, "google.protobuf.Timestamp"
21
+ optional :kms_key_name, :string, 8
22
+ end
23
+ add_enum "google.cloud.documentai.v1beta3.Processor.State" do
24
+ value :STATE_UNSPECIFIED, 0
25
+ value :ENABLED, 1
26
+ value :DISABLED, 2
27
+ value :ENABLING, 3
28
+ value :DISABLING, 4
29
+ value :CREATING, 5
30
+ value :FAILED, 6
31
+ value :DELETING, 7
32
+ end
33
+ end
34
+ end
35
+
36
+ module Google
37
+ module Cloud
38
+ module DocumentAI
39
+ module V1beta3
40
+ Processor = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Processor").msgclass
41
+ Processor::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Processor.State").enummodule
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,32 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/documentai/v1beta3/processor_type.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/resource_pb'
7
+ require 'google/api/annotations_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/cloud/documentai/v1beta3/processor_type.proto", :syntax => :proto3) do
10
+ add_message "google.cloud.documentai.v1beta3.ProcessorType" do
11
+ optional :name, :string, 1
12
+ optional :type, :string, 2
13
+ optional :category, :string, 3
14
+ repeated :available_locations, :message, 4, "google.cloud.documentai.v1beta3.ProcessorType.LocationInfo"
15
+ optional :allow_creation, :bool, 6
16
+ end
17
+ add_message "google.cloud.documentai.v1beta3.ProcessorType.LocationInfo" do
18
+ optional :location_id, :string, 1
19
+ end
20
+ end
21
+ end
22
+
23
+ module Google
24
+ module Cloud
25
+ module DocumentAI
26
+ module V1beta3
27
+ ProcessorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ProcessorType").msgclass
28
+ ProcessorType::LocationInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ProcessorType.LocationInfo").msgclass
29
+ end
30
+ end
31
+ end
32
+ end
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
60
+ # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  end
@@ -28,14 +28,14 @@ module Google
28
28
  # optimize for quality.
29
29
  # @!attribute [rw] uri
30
30
  # @return [::String]
31
- # Currently supports Google Cloud Storage URI of the form
31
+ # Optional. Currently supports Google Cloud Storage URI of the form
32
32
  # `gs://bucket_name/object_name`. Object versioning is not supported.
33
33
  # See [Google Cloud Storage Request
34
34
  # URIs](https://cloud.google.com/storage/docs/reference-uris) for more
35
35
  # info.
36
36
  # @!attribute [rw] content
37
37
  # @return [::String]
38
- # Inline document content, represented as a stream of bytes.
38
+ # Optional. Inline document content, represented as a stream of bytes.
39
39
  # Note: As with all `bytes` fields, protobuffers use a pure binary
40
40
  # representation, whereas JSON representations use base64.
41
41
  # @!attribute [rw] mime_type
@@ -45,7 +45,7 @@ module Google
45
45
  # https://www.iana.org/assignments/media-types/media-types.xhtml.
46
46
  # @!attribute [rw] text
47
47
  # @return [::String]
48
- # UTF-8 encoded text in reading order from the document.
48
+ # Optional. UTF-8 encoded text in reading order from the document.
49
49
  # @!attribute [rw] text_styles
50
50
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>]
51
51
  # Styles for the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
@@ -190,6 +190,9 @@ module Google
190
190
  # @!attribute [rw] form_fields
191
191
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField>]
192
192
  # A list of visually detected form fields on the page.
193
+ # @!attribute [rw] provenance
194
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
195
+ # The history of this page.
193
196
  class Page
194
197
  include ::Google::Protobuf::MessageExts
195
198
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -461,6 +464,9 @@ module Google
461
464
  # - blank (this indicates the field_value is normal text)
462
465
  # - "unfilled_checkbox"
463
466
  # - "filled_checkbox"
467
+ # @!attribute [rw] provenance
468
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
469
+ # The history of this annotation.
464
470
  class FormField
465
471
  include ::Google::Protobuf::MessageExts
466
472
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -485,17 +491,17 @@ module Google
485
491
  # organization, or location.
486
492
  # @!attribute [rw] text_anchor
487
493
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor]
488
- # Provenance of the entity.
494
+ # Optional. Provenance of the entity.
489
495
  # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
490
496
  # @!attribute [rw] type
491
497
  # @return [::String]
492
498
  # Entity type from a schema e.g. `Address`.
493
499
  # @!attribute [rw] mention_text
494
500
  # @return [::String]
495
- # Text value in the document e.g. `1600 Amphitheatre Pkwy`.
501
+ # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
496
502
  # @!attribute [rw] mention_id
497
503
  # @return [::String]
498
- # Deprecated. Use `id` field instead.
504
+ # Optional. Deprecated. Use `id` field instead.
499
505
  # @!attribute [rw] confidence
500
506
  # @return [::Float]
501
507
  # Optional. Confidence of detected Schema entity. Range [0, 1].
@@ -531,27 +537,19 @@ module Google
531
537
  # @!attribute [rw] money_value
532
538
  # @return [::Google::Type::Money]
533
539
  # Money value. See also:
534
- #
535
- # https:
536
- # github.com/googleapis/googleapis/blob/master/google/type/money.proto
540
+ # https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
537
541
  # @!attribute [rw] date_value
538
542
  # @return [::Google::Type::Date]
539
543
  # Date value. Includes year, month, day. See also:
540
- #
541
- # https:
542
- # github.com/googleapis/googleapis/blob/master/google/type/date.proto
544
+ # https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
543
545
  # @!attribute [rw] datetime_value
544
546
  # @return [::Google::Type::DateTime]
545
547
  # DateTime value. Includes date, time, and timezone. See also:
546
- #
547
- # https:
548
- # github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
548
+ # https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
549
549
  # @!attribute [rw] address_value
550
550
  # @return [::Google::Type::PostalAddress]
551
551
  # Postal address. See also:
552
- #
553
- # https:
554
- # github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
552
+ # https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
555
553
  # @!attribute [rw] boolean_value
556
554
  # @return [::Boolean]
557
555
  # Boolean value. Can be used for entities with binary values, or for
@@ -629,6 +627,8 @@ module Google
629
627
  # @return [::Integer]
630
628
  # Required. Index into the {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages} element, for example using
631
629
  # [Document.pages][page_refs.page] to locate the related page element.
630
+ # This field is skipped when its value is the default 0. See
631
+ # https://developers.google.com/protocol-buffers/docs/proto3#json.
632
632
  # @!attribute [rw] layout_type
633
633
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType]
634
634
  # Optional. The type of the layout element that is being referenced if any.
@@ -638,6 +638,9 @@ module Google
638
638
  # @!attribute [rw] bounding_poly
639
639
  # @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
640
640
  # Optional. Identifies the bounding polygon of a layout element on the page.
641
+ # @!attribute [rw] confidence
642
+ # @return [::Float]
643
+ # Optional. Confidence of detected page element, if applicable. Range [0, 1].
641
644
  class PageRef
642
645
  include ::Google::Protobuf::MessageExts
643
646
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -696,6 +699,10 @@ module Google
696
699
  # @!attribute [rw] revision
697
700
  # @return [::Integer]
698
701
  # The index of the [Document.revisions] identifying the parent revision.
702
+ # @!attribute [rw] index
703
+ # @return [::Integer]
704
+ # The index of the parent revisions corresponding collection of items
705
+ # (eg. list of entities, properties within entities, etc.)
699
706
  # @!attribute [rw] id
700
707
  # @return [::Integer]
701
708
  # The id of the parent provenance.
@@ -721,9 +728,12 @@ module Google
721
728
  # Element is requested for human review.
722
729
  EVAL_REQUESTED = 4
723
730
 
724
- # Element is review and approved at human review, confidence will be set
725
- # to 1.0
731
+ # Element is reviewed and approved at human review, confidence will be
732
+ # set to 1.0.
726
733
  EVAL_APPROVED = 5
734
+
735
+ # Element is skipped in the validation process.
736
+ EVAL_SKIPPED = 6
727
737
  end
728
738
  end
729
739