google-cloud-document_ai-v1 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -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
@@ -0,0 +1,229 @@
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 Protobuf
22
+ # `FieldMask` represents a set of symbolic field paths, for example:
23
+ #
24
+ # paths: "f.a"
25
+ # paths: "f.b.d"
26
+ #
27
+ # Here `f` represents a field in some root message, `a` and `b`
28
+ # fields in the message found in `f`, and `d` a field found in the
29
+ # message in `f.b`.
30
+ #
31
+ # Field masks are used to specify a subset of fields that should be
32
+ # returned by a get operation or modified by an update operation.
33
+ # Field masks also have a custom JSON encoding (see below).
34
+ #
35
+ # # Field Masks in Projections
36
+ #
37
+ # When used in the context of a projection, a response message or
38
+ # sub-message is filtered by the API to only contain those fields as
39
+ # specified in the mask. For example, if the mask in the previous
40
+ # example is applied to a response message as follows:
41
+ #
42
+ # f {
43
+ # a : 22
44
+ # b {
45
+ # d : 1
46
+ # x : 2
47
+ # }
48
+ # y : 13
49
+ # }
50
+ # z: 8
51
+ #
52
+ # The result will not contain specific values for fields x,y and z
53
+ # (their value will be set to the default, and omitted in proto text
54
+ # output):
55
+ #
56
+ #
57
+ # f {
58
+ # a : 22
59
+ # b {
60
+ # d : 1
61
+ # }
62
+ # }
63
+ #
64
+ # A repeated field is not allowed except at the last position of a
65
+ # paths string.
66
+ #
67
+ # If a FieldMask object is not present in a get operation, the
68
+ # operation applies to all fields (as if a FieldMask of all fields
69
+ # had been specified).
70
+ #
71
+ # Note that a field mask does not necessarily apply to the
72
+ # top-level response message. In case of a REST get operation, the
73
+ # field mask applies directly to the response, but in case of a REST
74
+ # list operation, the mask instead applies to each individual message
75
+ # in the returned resource list. In case of a REST custom method,
76
+ # other definitions may be used. Where the mask applies will be
77
+ # clearly documented together with its declaration in the API. In
78
+ # any case, the effect on the returned resource/resources is required
79
+ # behavior for APIs.
80
+ #
81
+ # # Field Masks in Update Operations
82
+ #
83
+ # A field mask in update operations specifies which fields of the
84
+ # targeted resource are going to be updated. The API is required
85
+ # to only change the values of the fields as specified in the mask
86
+ # and leave the others untouched. If a resource is passed in to
87
+ # describe the updated values, the API ignores the values of all
88
+ # fields not covered by the mask.
89
+ #
90
+ # If a repeated field is specified for an update operation, new values will
91
+ # be appended to the existing repeated field in the target resource. Note that
92
+ # a repeated field is only allowed in the last position of a `paths` string.
93
+ #
94
+ # If a sub-message is specified in the last position of the field mask for an
95
+ # update operation, then new value will be merged into the existing sub-message
96
+ # in the target resource.
97
+ #
98
+ # For example, given the target message:
99
+ #
100
+ # f {
101
+ # b {
102
+ # d: 1
103
+ # x: 2
104
+ # }
105
+ # c: [1]
106
+ # }
107
+ #
108
+ # And an update message:
109
+ #
110
+ # f {
111
+ # b {
112
+ # d: 10
113
+ # }
114
+ # c: [2]
115
+ # }
116
+ #
117
+ # then if the field mask is:
118
+ #
119
+ # paths: ["f.b", "f.c"]
120
+ #
121
+ # then the result will be:
122
+ #
123
+ # f {
124
+ # b {
125
+ # d: 10
126
+ # x: 2
127
+ # }
128
+ # c: [1, 2]
129
+ # }
130
+ #
131
+ # An implementation may provide options to override this default behavior for
132
+ # repeated and message fields.
133
+ #
134
+ # In order to reset a field's value to the default, the field must
135
+ # be in the mask and set to the default value in the provided resource.
136
+ # Hence, in order to reset all fields of a resource, provide a default
137
+ # instance of the resource and set all fields in the mask, or do
138
+ # not provide a mask as described below.
139
+ #
140
+ # If a field mask is not present on update, the operation applies to
141
+ # all fields (as if a field mask of all fields has been specified).
142
+ # Note that in the presence of schema evolution, this may mean that
143
+ # fields the client does not know and has therefore not filled into
144
+ # the request will be reset to their default. If this is unwanted
145
+ # behavior, a specific service may require a client to always specify
146
+ # a field mask, producing an error if not.
147
+ #
148
+ # As with get operations, the location of the resource which
149
+ # describes the updated values in the request message depends on the
150
+ # operation kind. In any case, the effect of the field mask is
151
+ # required to be honored by the API.
152
+ #
153
+ # ## Considerations for HTTP REST
154
+ #
155
+ # The HTTP kind of an update operation which uses a field mask must
156
+ # be set to PATCH instead of PUT in order to satisfy HTTP semantics
157
+ # (PUT must only be used for full updates).
158
+ #
159
+ # # JSON Encoding of Field Masks
160
+ #
161
+ # In JSON, a field mask is encoded as a single string where paths are
162
+ # separated by a comma. Fields name in each path are converted
163
+ # to/from lower-camel naming conventions.
164
+ #
165
+ # As an example, consider the following message declarations:
166
+ #
167
+ # message Profile {
168
+ # User user = 1;
169
+ # Photo photo = 2;
170
+ # }
171
+ # message User {
172
+ # string display_name = 1;
173
+ # string address = 2;
174
+ # }
175
+ #
176
+ # In proto a field mask for `Profile` may look as such:
177
+ #
178
+ # mask {
179
+ # paths: "user.display_name"
180
+ # paths: "photo"
181
+ # }
182
+ #
183
+ # In JSON, the same mask is represented as below:
184
+ #
185
+ # {
186
+ # mask: "user.displayName,photo"
187
+ # }
188
+ #
189
+ # # Field Masks and Oneof Fields
190
+ #
191
+ # Field masks treat fields in oneofs just as regular fields. Consider the
192
+ # following message:
193
+ #
194
+ # message SampleMessage {
195
+ # oneof test_oneof {
196
+ # string name = 4;
197
+ # SubMessage sub_message = 9;
198
+ # }
199
+ # }
200
+ #
201
+ # The field mask can be:
202
+ #
203
+ # mask {
204
+ # paths: "name"
205
+ # }
206
+ #
207
+ # Or:
208
+ #
209
+ # mask {
210
+ # paths: "sub_message"
211
+ # }
212
+ #
213
+ # Note that oneof type names ("test_oneof" in this case) cannot be used in
214
+ # paths.
215
+ #
216
+ # ## Field Mask Verification
217
+ #
218
+ # The implementation of any API method which has a FieldMask type field in the
219
+ # request should verify the included field paths, and return an
220
+ # `INVALID_ARGUMENT` error if any path is unmappable.
221
+ # @!attribute [rw] paths
222
+ # @return [::Array<::String>]
223
+ # The set of field mask paths.
224
+ class FieldMask
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+ end
229
+ end
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.4.0
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-07-02 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
@@ -44,6 +44,26 @@ 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
@@ -178,24 +198,34 @@ 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
198
227
  - proto_docs/google/protobuf/empty.rb
228
+ - proto_docs/google/protobuf/field_mask.rb
199
229
  - proto_docs/google/protobuf/timestamp.rb
200
230
  - proto_docs/google/protobuf/wrappers.rb
201
231
  - proto_docs/google/rpc/status.rb