google-cloud-document_ai-v1beta3 0.2.0 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +188 -190
- data/README.md +2 -2
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +32 -19
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb +7 -7
- data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
- data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +54 -0
- data/lib/google/cloud/documentai/v1beta3/document_pb.rb +2 -8
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +44 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document.rb +22 -50
- data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +100 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +106 -0
- metadata +10 -8
@@ -22,6 +22,12 @@ module Google
|
|
22
22
|
module DocumentAI
|
23
23
|
module V1beta3
|
24
24
|
# Request message for the process document method.
|
25
|
+
# @!attribute [rw] inline_document
|
26
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
27
|
+
# An inline document proto.
|
28
|
+
# @!attribute [rw] raw_document
|
29
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::RawDocument]
|
30
|
+
# A raw document content (bytes).
|
25
31
|
# @!attribute [rw] name
|
26
32
|
# @return [::String]
|
27
33
|
# Required. The processor resource name.
|
@@ -37,6 +43,45 @@ module Google
|
|
37
43
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
38
44
|
end
|
39
45
|
|
46
|
+
# The status of human review on a processed document.
|
47
|
+
# @!attribute [rw] state
|
48
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus::State]
|
49
|
+
# The state of human review on the processing request.
|
50
|
+
# @!attribute [rw] state_message
|
51
|
+
# @return [::String]
|
52
|
+
# A message providing more details about the human review state.
|
53
|
+
# @!attribute [rw] human_review_operation
|
54
|
+
# @return [::String]
|
55
|
+
# The name of the operation triggered by the processed document. This field
|
56
|
+
# is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has
|
57
|
+
# the same response type and metadata as the long running operation returned
|
58
|
+
# by [ReviewDocument] method.
|
59
|
+
class HumanReviewStatus
|
60
|
+
include ::Google::Protobuf::MessageExts
|
61
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
62
|
+
|
63
|
+
# The final state of human review on a processed document.
|
64
|
+
module State
|
65
|
+
# Human review state is unspecified. Most likely due to an internal error.
|
66
|
+
STATE_UNSPECIFIED = 0
|
67
|
+
|
68
|
+
# Human review is skipped for the document. This can happen because human
|
69
|
+
# review is not enabled on the processor or the processing request has
|
70
|
+
# been set to skip this document.
|
71
|
+
SKIPPED = 1
|
72
|
+
|
73
|
+
# Human review validation is triggered and passed, so no review is needed.
|
74
|
+
VALIDATION_PASSED = 2
|
75
|
+
|
76
|
+
# Human review validation is triggered and the document is under review.
|
77
|
+
IN_PROGRESS = 3
|
78
|
+
|
79
|
+
# Some error happened during triggering human review, see the
|
80
|
+
# [state_message] for details.
|
81
|
+
ERROR = 4
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
40
85
|
# Response message for the process document method.
|
41
86
|
# @!attribute [rw] document
|
42
87
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
@@ -48,6 +93,9 @@ module Google
|
|
48
93
|
# review process is not triggered, this field will be empty. It has the same
|
49
94
|
# response type and metadata as the long running operation returned by
|
50
95
|
# ReviewDocument method.
|
96
|
+
# @!attribute [rw] human_review_status
|
97
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
|
98
|
+
# The status of human review on the processed document.
|
51
99
|
class ProcessResponse
|
52
100
|
include ::Google::Protobuf::MessageExts
|
53
101
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -63,6 +111,16 @@ module Google
|
|
63
111
|
# @!attribute [rw] output_config
|
64
112
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig]
|
65
113
|
# The overall output config for batch process.
|
114
|
+
# @!attribute [rw] input_documents
|
115
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
|
116
|
+
# The input documents for batch process.
|
117
|
+
# @!attribute [rw] document_output_config
|
118
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig]
|
119
|
+
# The overall output config for batch process.
|
120
|
+
# @!attribute [rw] skip_human_review
|
121
|
+
# @return [::Boolean]
|
122
|
+
# Whether Human Review feature should be skipped for this request. Default to
|
123
|
+
# false.
|
66
124
|
class BatchProcessRequest
|
67
125
|
include ::Google::Protobuf::MessageExts
|
68
126
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -138,6 +196,9 @@ module Google
|
|
138
196
|
# human review process is not triggered, this field will be empty. It has
|
139
197
|
# the same response type and metadata as the long running operation
|
140
198
|
# returned by ReviewDocument method.
|
199
|
+
# @!attribute [rw] human_review_status
|
200
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
|
201
|
+
# The status of human review on the processed document.
|
141
202
|
class IndividualProcessStatus
|
142
203
|
include ::Google::Protobuf::MessageExts
|
143
204
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -169,6 +230,9 @@ module Google
|
|
169
230
|
end
|
170
231
|
|
171
232
|
# Request message for review document method.
|
233
|
+
# @!attribute [rw] inline_document
|
234
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
235
|
+
# An inline document proto.
|
172
236
|
# @!attribute [rw] human_review_config
|
173
237
|
# @return [::String]
|
174
238
|
# Required. The resource name of the HumanReviewConfig that the document will be
|
@@ -204,6 +268,9 @@ module Google
|
|
204
268
|
# @!attribute [rw] update_time
|
205
269
|
# @return [::Google::Protobuf::Timestamp]
|
206
270
|
# The last update time of the operation.
|
271
|
+
# @!attribute [rw] common_metadata
|
272
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
|
273
|
+
# The basic metadata of the long running operation.
|
207
274
|
class ReviewDocumentOperationMetadata
|
208
275
|
include ::Google::Protobuf::MessageExts
|
209
276
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -229,6 +296,45 @@ module Google
|
|
229
296
|
CANCELLED = 5
|
230
297
|
end
|
231
298
|
end
|
299
|
+
|
300
|
+
# The common metadata for long running operations.
|
301
|
+
# @!attribute [rw] state
|
302
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata::State]
|
303
|
+
# The state of the operation.
|
304
|
+
# @!attribute [rw] state_message
|
305
|
+
# @return [::String]
|
306
|
+
# A message providing more details about the current state of processing.
|
307
|
+
# @!attribute [rw] create_time
|
308
|
+
# @return [::Google::Protobuf::Timestamp]
|
309
|
+
# The creation time of the operation.
|
310
|
+
# @!attribute [rw] update_time
|
311
|
+
# @return [::Google::Protobuf::Timestamp]
|
312
|
+
# The last update time of the operation.
|
313
|
+
class CommonOperationMetadata
|
314
|
+
include ::Google::Protobuf::MessageExts
|
315
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
316
|
+
|
317
|
+
# State of the longrunning operation.
|
318
|
+
module State
|
319
|
+
# Unspecified state.
|
320
|
+
STATE_UNSPECIFIED = 0
|
321
|
+
|
322
|
+
# Operation is still running.
|
323
|
+
RUNNING = 1
|
324
|
+
|
325
|
+
# Operation is being cancelled.
|
326
|
+
CANCELLING = 2
|
327
|
+
|
328
|
+
# Operation succeeded.
|
329
|
+
SUCCEEDED = 3
|
330
|
+
|
331
|
+
# Operation failed.
|
332
|
+
FAILED = 4
|
333
|
+
|
334
|
+
# Operation is cancelled.
|
335
|
+
CANCELLED = 5
|
336
|
+
end
|
337
|
+
end
|
232
338
|
end
|
233
339
|
end
|
234
340
|
end
|
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.7.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-03-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,14 +16,14 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.4'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '0.
|
26
|
+
version: '0.4'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: google-cloud-errors
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
@@ -44,14 +44,14 @@ dependencies:
|
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: 1.
|
47
|
+
version: 1.25.1
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: 1.
|
54
|
+
version: 1.25.1
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: minitest
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
@@ -172,6 +172,7 @@ files:
|
|
172
172
|
- lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb
|
173
173
|
- lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb
|
174
174
|
- lib/google/cloud/document_ai/v1beta3/version.rb
|
175
|
+
- lib/google/cloud/documentai/v1beta3/document_io_pb.rb
|
175
176
|
- lib/google/cloud/documentai/v1beta3/document_pb.rb
|
176
177
|
- lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb
|
177
178
|
- lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb
|
@@ -180,6 +181,7 @@ files:
|
|
180
181
|
- proto_docs/google/api/field_behavior.rb
|
181
182
|
- proto_docs/google/api/resource.rb
|
182
183
|
- proto_docs/google/cloud/documentai/v1beta3/document.rb
|
184
|
+
- proto_docs/google/cloud/documentai/v1beta3/document_io.rb
|
183
185
|
- proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
|
184
186
|
- proto_docs/google/cloud/documentai/v1beta3/geometry.rb
|
185
187
|
- proto_docs/google/longrunning/operations.rb
|
@@ -207,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
207
209
|
requirements:
|
208
210
|
- - ">="
|
209
211
|
- !ruby/object:Gem::Version
|
210
|
-
version: '2.
|
212
|
+
version: '2.5'
|
211
213
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
212
214
|
requirements:
|
213
215
|
- - ">="
|
214
216
|
- !ruby/object:Gem::Version
|
215
217
|
version: '0'
|
216
218
|
requirements: []
|
217
|
-
rubygems_version: 3.2.
|
219
|
+
rubygems_version: 3.2.13
|
218
220
|
signing_key:
|
219
221
|
specification_version: 4
|
220
222
|
summary: API Client library for the Document AI V1beta3 API
|