google-cloud-document_ai-v1 0.2.4 → 0.5.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.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -6
  3. data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +1490 -58
  4. data/lib/google/cloud/document_ai/v1/document_processor_service/operations.rb +3 -0
  5. data/lib/google/cloud/document_ai/v1/document_processor_service/paths.rb +38 -0
  6. data/lib/google/cloud/document_ai/v1/version.rb +1 -1
  7. data/lib/google/cloud/document_ai/v1.rb +2 -0
  8. data/lib/google/cloud/documentai/v1/barcode_pb.rb +24 -0
  9. data/lib/google/cloud/documentai/v1/document_io_pb.rb +0 -1
  10. data/lib/google/cloud/documentai/v1/document_pb.rb +20 -2
  11. data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb +142 -1
  12. data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +34 -0
  13. data/lib/google/cloud/documentai/v1/document_schema_pb.rb +60 -0
  14. data/lib/google/cloud/documentai/v1/geometry_pb.rb +0 -1
  15. data/lib/google/cloud/documentai/v1/operation_metadata_pb.rb +3 -2
  16. data/lib/google/cloud/documentai/v1/processor_pb.rb +71 -0
  17. data/lib/google/cloud/documentai/v1/processor_type_pb.rb +34 -0
  18. data/proto_docs/google/api/launch_stage.rb +71 -0
  19. data/proto_docs/google/cloud/documentai/v1/barcode.rb +71 -0
  20. data/proto_docs/google/cloud/documentai/v1/document.rb +87 -31
  21. data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +354 -5
  22. data/proto_docs/google/cloud/documentai/v1/document_schema.rb +154 -0
  23. data/proto_docs/google/cloud/documentai/v1/operation_metadata.rb +3 -0
  24. data/proto_docs/google/cloud/documentai/v1/processor.rb +171 -0
  25. data/proto_docs/google/cloud/documentai/v1/processor_type.rb +62 -0
  26. data/proto_docs/google/protobuf/any.rb +3 -3
  27. data/proto_docs/google/protobuf/empty.rb +0 -2
  28. data/proto_docs/google/protobuf/field_mask.rb +1 -1
  29. metadata +41 -12
@@ -0,0 +1,171 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DocumentAI
23
+ module V1
24
+ # A processor version is an implementation of a processor. Each processor
25
+ # can have multiple versions, pre-trained by Google internally or up-trained
26
+ # by the customer. At a time, a processor can only have one default version
27
+ # version. So the processor's behavior (when processing documents) is defined
28
+ # by a default version
29
+ # @!attribute [rw] name
30
+ # @return [::String]
31
+ # The resource name of the processor version.
32
+ # Format:
33
+ # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
34
+ # @!attribute [rw] display_name
35
+ # @return [::String]
36
+ # The display name of the processor version.
37
+ # @!attribute [rw] state
38
+ # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::State]
39
+ # The state of the processor version.
40
+ # @!attribute [rw] create_time
41
+ # @return [::Google::Protobuf::Timestamp]
42
+ # The time the processor version was created.
43
+ # @!attribute [rw] kms_key_name
44
+ # @return [::String]
45
+ # The KMS key name used for encryption.
46
+ # @!attribute [rw] kms_key_version_name
47
+ # @return [::String]
48
+ # The KMS key version with which data is encrypted.
49
+ # @!attribute [rw] google_managed
50
+ # @return [::Boolean]
51
+ # Denotes that this ProcessorVersion is managed by google.
52
+ # @!attribute [rw] deprecation_info
53
+ # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo]
54
+ # If set, information about the eventual deprecation of this version.
55
+ class ProcessorVersion
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # Information about the upcoming deprecation of this processor version.
60
+ # @!attribute [rw] deprecation_time
61
+ # @return [::Google::Protobuf::Timestamp]
62
+ # The time at which this processor version will be deprecated.
63
+ # @!attribute [rw] replacement_processor_version
64
+ # @return [::String]
65
+ # If set, the processor version that will be used as a replacement.
66
+ class DeprecationInfo
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # The possible states of the processor version.
72
+ module State
73
+ # The processor version is in an unspecified state.
74
+ STATE_UNSPECIFIED = 0
75
+
76
+ # The processor version is deployed and can be used for processing.
77
+ DEPLOYED = 1
78
+
79
+ # The processor version is being deployed.
80
+ DEPLOYING = 2
81
+
82
+ # The processor version is not deployed and cannot be used for processing.
83
+ UNDEPLOYED = 3
84
+
85
+ # The processor version is being undeployed.
86
+ UNDEPLOYING = 4
87
+
88
+ # The processor version is being created.
89
+ CREATING = 5
90
+
91
+ # The processor version is being deleted.
92
+ DELETING = 6
93
+
94
+ # The processor version failed and is in an indeterminate state.
95
+ FAILED = 7
96
+ end
97
+ end
98
+
99
+ # The first-class citizen for Document AI. Each processor defines how to
100
+ # extract structural information from a document.
101
+ # @!attribute [r] name
102
+ # @return [::String]
103
+ # Output only. Immutable. The resource name of the processor.
104
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`
105
+ # @!attribute [rw] type
106
+ # @return [::String]
107
+ # The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
108
+ # To get a list of processors types, see
109
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
110
+ # @!attribute [rw] display_name
111
+ # @return [::String]
112
+ # The display name of the processor.
113
+ # @!attribute [r] state
114
+ # @return [::Google::Cloud::DocumentAI::V1::Processor::State]
115
+ # Output only. The state of the processor.
116
+ # @!attribute [rw] default_processor_version
117
+ # @return [::String]
118
+ # The default processor version.
119
+ # @!attribute [r] process_endpoint
120
+ # @return [::String]
121
+ # Output only. Immutable. The http endpoint that can be called to invoke processing.
122
+ # @!attribute [rw] create_time
123
+ # @return [::Google::Protobuf::Timestamp]
124
+ # The time the processor was created.
125
+ # @!attribute [rw] kms_key_name
126
+ # @return [::String]
127
+ # The KMS key used for encryption/decryption in CMEK scenarios.
128
+ # See https://cloud.google.com/security-key-management.
129
+ class Processor
130
+ include ::Google::Protobuf::MessageExts
131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
132
+
133
+ # The possible states of the processor.
134
+ module State
135
+ # The processor is in an unspecified state.
136
+ STATE_UNSPECIFIED = 0
137
+
138
+ # The processor is enabled, i.e., has an enabled version which can
139
+ # currently serve processing requests and all the feature dependencies have
140
+ # been successfully initialized.
141
+ ENABLED = 1
142
+
143
+ # The processor is disabled.
144
+ DISABLED = 2
145
+
146
+ # The processor is being enabled, will become ENABLED if successful.
147
+ ENABLING = 3
148
+
149
+ # The processor is being disabled, will become DISABLED if successful.
150
+ DISABLING = 4
151
+
152
+ # The processor is being created, will become either ENABLED (for
153
+ # successful creation) or FAILED (for failed ones).
154
+ # Once a processor is in this state, it can then be used for document
155
+ # processing, but the feature dependencies of the processor might not be
156
+ # fully created yet.
157
+ CREATING = 5
158
+
159
+ # The processor failed during creation or initialization of feature
160
+ # dependencies. The user should delete the processor and recreate one as
161
+ # all the functionalities of the processor are disabled.
162
+ FAILED = 6
163
+
164
+ # The processor is being deleted, will be removed if successful.
165
+ DELETING = 7
166
+ end
167
+ end
168
+ end
169
+ end
170
+ end
171
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DocumentAI
23
+ module V1
24
+ # A processor type is responsible for performing a certain document
25
+ # understanding task on a certain type of document.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # The resource name of the processor type.
29
+ # Format: projects/\\{project}/processorTypes/\\{processor_type}
30
+ # @!attribute [rw] type
31
+ # @return [::String]
32
+ # The type of the processor, e.g., "invoice_parsing".
33
+ # @!attribute [rw] category
34
+ # @return [::String]
35
+ # The processor category, used by UI to group processor types.
36
+ # @!attribute [rw] available_locations
37
+ # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>]
38
+ # The locations in which this processor is available.
39
+ # @!attribute [rw] allow_creation
40
+ # @return [::Boolean]
41
+ # Whether the processor type allows creation. If true, users can create a
42
+ # processor of this processor type. Otherwise, users need to request access.
43
+ # @!attribute [rw] launch_stage
44
+ # @return [::Google::Api::LaunchStage]
45
+ # Launch stage of the processor type
46
+ class ProcessorType
47
+ include ::Google::Protobuf::MessageExts
48
+ extend ::Google::Protobuf::MessageExts::ClassMethods
49
+
50
+ # The location information about where the processor is available.
51
+ # @!attribute [rw] location_id
52
+ # @return [::String]
53
+ # The location id, currently must be one of [us, eu].
54
+ class LocationInfo
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -44,7 +44,7 @@ module Google
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
46
  #
47
- # Example 3: Pack and unpack a message in Python.
47
+ # Example 3: Pack and unpack a message in Python.
48
48
  #
49
49
  # foo = Foo(...)
50
50
  # any = Any()
@@ -54,7 +54,7 @@ module Google
54
54
  # any.Unpack(foo)
55
55
  # ...
56
56
  #
57
- # Example 4: Pack and unpack a message in Go
57
+ # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
60
  # any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
75
75
  #
76
76
  #
77
77
  # JSON
78
- # ====
78
+ #
79
79
  # The JSON representation of an `Any` value uses the regular
80
80
  # representation of the deserialized, embedded message, with an
81
81
  # additional field `@type` which contains the type URL. Example:
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2021 Google LLC
3
+ # Copyright 2022 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-document_ai-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.4
4
+ version: 0.5.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-01-11 00:00:00.000000000 Z
11
+ date: 2022-08-11 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: '0.7'
19
+ version: '0.10'
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.7'
29
+ version: '0.10'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -44,34 +44,54 @@ dependencies:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
46
  version: '1.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: google-cloud-location
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0.0'
54
+ - - "<"
55
+ - !ruby/object:Gem::Version
56
+ version: 2.a
57
+ type: :runtime
58
+ prerelease: false
59
+ version_requirements: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '0.0'
64
+ - - "<"
65
+ - !ruby/object:Gem::Version
66
+ version: 2.a
47
67
  - !ruby/object:Gem::Dependency
48
68
  name: google-style
49
69
  requirement: !ruby/object:Gem::Requirement
50
70
  requirements:
51
71
  - - "~>"
52
72
  - !ruby/object:Gem::Version
53
- version: 1.25.1
73
+ version: 1.26.1
54
74
  type: :development
55
75
  prerelease: false
56
76
  version_requirements: !ruby/object:Gem::Requirement
57
77
  requirements:
58
78
  - - "~>"
59
79
  - !ruby/object:Gem::Version
60
- version: 1.25.1
80
+ version: 1.26.1
61
81
  - !ruby/object:Gem::Dependency
62
82
  name: minitest
63
83
  requirement: !ruby/object:Gem::Requirement
64
84
  requirements:
65
85
  - - "~>"
66
86
  - !ruby/object:Gem::Version
67
- version: '5.14'
87
+ version: '5.16'
68
88
  type: :development
69
89
  prerelease: false
70
90
  version_requirements: !ruby/object:Gem::Requirement
71
91
  requirements:
72
92
  - - "~>"
73
93
  - !ruby/object:Gem::Version
74
- version: '5.14'
94
+ version: '5.16'
75
95
  - !ruby/object:Gem::Dependency
76
96
  name: minitest-focus
77
97
  requirement: !ruby/object:Gem::Requirement
@@ -106,14 +126,14 @@ dependencies:
106
126
  requirements:
107
127
  - - ">="
108
128
  - !ruby/object:Gem::Version
109
- version: '12.0'
129
+ version: '13.0'
110
130
  type: :development
111
131
  prerelease: false
112
132
  version_requirements: !ruby/object:Gem::Requirement
113
133
  requirements:
114
134
  - - ">="
115
135
  - !ruby/object:Gem::Version
116
- version: '12.0'
136
+ version: '13.0'
117
137
  - !ruby/object:Gem::Dependency
118
138
  name: redcarpet
119
139
  requirement: !ruby/object:Gem::Requirement
@@ -178,20 +198,29 @@ files:
178
198
  - lib/google/cloud/document_ai/v1/document_processor_service/operations.rb
179
199
  - lib/google/cloud/document_ai/v1/document_processor_service/paths.rb
180
200
  - lib/google/cloud/document_ai/v1/version.rb
201
+ - lib/google/cloud/documentai/v1/barcode_pb.rb
181
202
  - lib/google/cloud/documentai/v1/document_io_pb.rb
182
203
  - lib/google/cloud/documentai/v1/document_pb.rb
183
204
  - lib/google/cloud/documentai/v1/document_processor_service_pb.rb
184
205
  - lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb
206
+ - lib/google/cloud/documentai/v1/document_schema_pb.rb
185
207
  - lib/google/cloud/documentai/v1/geometry_pb.rb
186
208
  - lib/google/cloud/documentai/v1/operation_metadata_pb.rb
209
+ - lib/google/cloud/documentai/v1/processor_pb.rb
210
+ - lib/google/cloud/documentai/v1/processor_type_pb.rb
187
211
  - proto_docs/README.md
188
212
  - proto_docs/google/api/field_behavior.rb
213
+ - proto_docs/google/api/launch_stage.rb
189
214
  - proto_docs/google/api/resource.rb
215
+ - proto_docs/google/cloud/documentai/v1/barcode.rb
190
216
  - proto_docs/google/cloud/documentai/v1/document.rb
191
217
  - proto_docs/google/cloud/documentai/v1/document_io.rb
192
218
  - proto_docs/google/cloud/documentai/v1/document_processor_service.rb
219
+ - proto_docs/google/cloud/documentai/v1/document_schema.rb
193
220
  - proto_docs/google/cloud/documentai/v1/geometry.rb
194
221
  - proto_docs/google/cloud/documentai/v1/operation_metadata.rb
222
+ - proto_docs/google/cloud/documentai/v1/processor.rb
223
+ - proto_docs/google/cloud/documentai/v1/processor_type.rb
195
224
  - proto_docs/google/longrunning/operations.rb
196
225
  - proto_docs/google/protobuf/any.rb
197
226
  - proto_docs/google/protobuf/duration.rb
@@ -217,14 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
217
246
  requirements:
218
247
  - - ">="
219
248
  - !ruby/object:Gem::Version
220
- version: '2.5'
249
+ version: '2.6'
221
250
  required_rubygems_version: !ruby/object:Gem::Requirement
222
251
  requirements:
223
252
  - - ">="
224
253
  - !ruby/object:Gem::Version
225
254
  version: '0'
226
255
  requirements: []
227
- rubygems_version: 3.3.4
256
+ rubygems_version: 3.3.14
228
257
  signing_key:
229
258
  specification_version: 4
230
259
  summary: API Client library for the Document AI V1 API