google-cloud-document_ai-v1 0.5.0 → 0.7.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7a8df0e7c54fbe8554be8625e55d73f6eb9c5223d99f83a4bf6c122c8d316f85
4
- data.tar.gz: fcfcdc4ea0927bc5660aef1a7902fa1f98a303c88cfef30cc61d204f50eb3c5f
3
+ metadata.gz: 7f05d6623e343422379c6377121682794560789ab36398946866e3bf43138a2c
4
+ data.tar.gz: d9029af403e535d370733de3c57cdf42b986139dcdfcf0d15f93071ed4cb526c
5
5
  SHA512:
6
- metadata.gz: 6a27f8c72292fc8ba8de7fbb1880f1c25e9d6003e80a2af10c45c345c2b867b40bd2eb5293b19f6581740d8869c423ee3e2e43443172e36cfd1ab10d7620b05e
7
- data.tar.gz: b80af305a9fe5091c35f6157e27f6596fdc678fd9676868b18642321b9c8f51814f06fc92b29ee70b6d990b021ca59b234a586d1d94036fca65bba64246e725f
6
+ metadata.gz: 2d9bac78790b5f4a1e55ab4421cb761e5316e016294e515da649615a0dc50f77081305d8b0d54ca87e454c624e91747faa1a43252e916955b5d42e337fcc2448
7
+ data.tar.gz: 7ea0aeca0945ab92ad417fdd901772b0ca69fc71c586e0b7d8616701b04e7314efbcb8005f9fa0dfa1e815450aa065f41a50af06aaf24ea2b9ba192722be61b2
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -223,6 +223,8 @@ module Google
223
223
  # false.
224
224
  # @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
225
225
  # Specifies which fields to include in ProcessResponse's document.
226
+ # Only supports top level document and pages field so it must be in the form
227
+ # of `{document_field_name}` or `pages.{page_field_name}`.
226
228
  #
227
229
  # @yield [response, operation] Access the result along with the RPC operation
228
230
  # @yieldparam response [::Google::Cloud::DocumentAI::V1::ProcessResponse]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1
24
- VERSION = "0.5.0"
24
+ VERSION = "0.7.0"
25
25
  end
26
26
  end
27
27
  end
@@ -3,6 +3,8 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/protobuf/field_mask_pb'
7
+
6
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
7
9
  add_file("google/cloud/documentai/v1/document_io.proto", :syntax => :proto3) do
8
10
  add_message "google.cloud.documentai.v1.RawDocument" do
@@ -32,6 +34,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
32
34
  end
33
35
  add_message "google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig" do
34
36
  optional :gcs_uri, :string, 1
37
+ optional :field_mask, :message, 2, "google.protobuf.FieldMask"
38
+ optional :sharding_config, :message, 3, "google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig"
39
+ end
40
+ add_message "google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig" do
41
+ optional :pages_per_shard, :int32, 1
42
+ optional :pages_overlap, :int32, 2
35
43
  end
36
44
  end
37
45
  end
@@ -47,6 +55,7 @@ module Google
47
55
  BatchDocumentsInputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.BatchDocumentsInputConfig").msgclass
48
56
  DocumentOutputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.DocumentOutputConfig").msgclass
49
57
  DocumentOutputConfig::GcsOutputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig").msgclass
58
+ DocumentOutputConfig::GcsOutputConfig::ShardingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig").msgclass
50
59
  end
51
60
  end
52
61
  end
@@ -45,6 +45,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
45
45
  optional :text_style, :string, 5
46
46
  optional :text_decoration, :string, 6
47
47
  optional :font_size, :message, 7, "google.cloud.documentai.v1.Document.Style.FontSize"
48
+ optional :font_family, :string, 8
48
49
  end
49
50
  add_message "google.cloud.documentai.v1.Document.Style.FontSize" do
50
51
  optional :size, :float, 1
@@ -66,6 +67,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
66
67
  repeated :form_fields, :message, 11, "google.cloud.documentai.v1.Document.Page.FormField"
67
68
  repeated :symbols, :message, 12, "google.cloud.documentai.v1.Document.Page.Symbol"
68
69
  repeated :detected_barcodes, :message, 15, "google.cloud.documentai.v1.Document.Page.DetectedBarcode"
70
+ optional :image_quality_scores, :message, 17, "google.cloud.documentai.v1.Document.Page.ImageQualityScores"
69
71
  optional :provenance, :message, 16, "google.cloud.documentai.v1.Document.Provenance"
70
72
  end
71
73
  add_message "google.cloud.documentai.v1.Document.Page.Dimension" do
@@ -142,6 +144,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
142
144
  repeated :header_rows, :message, 2, "google.cloud.documentai.v1.Document.Page.Table.TableRow"
143
145
  repeated :body_rows, :message, 3, "google.cloud.documentai.v1.Document.Page.Table.TableRow"
144
146
  repeated :detected_languages, :message, 4, "google.cloud.documentai.v1.Document.Page.DetectedLanguage"
147
+ optional :provenance, :message, 5, "google.cloud.documentai.v1.Document.Provenance"
145
148
  end
146
149
  add_message "google.cloud.documentai.v1.Document.Page.Table.TableRow" do
147
150
  repeated :cells, :message, 1, "google.cloud.documentai.v1.Document.Page.Table.TableCell"
@@ -170,6 +173,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
170
173
  optional :language_code, :string, 1
171
174
  optional :confidence, :float, 2
172
175
  end
176
+ add_message "google.cloud.documentai.v1.Document.Page.ImageQualityScores" do
177
+ optional :quality_score, :float, 1
178
+ repeated :detected_defects, :message, 2, "google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect"
179
+ end
180
+ add_message "google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect" do
181
+ optional :type, :string, 1
182
+ optional :confidence, :float, 2
183
+ end
173
184
  add_message "google.cloud.documentai.v1.Document.Entity" do
174
185
  optional :text_anchor, :message, 1, "google.cloud.documentai.v1.Document.TextAnchor"
175
186
  optional :type, :string, 2
@@ -299,6 +310,8 @@ module Google
299
310
  Document::Page::FormField = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.FormField").msgclass
300
311
  Document::Page::DetectedBarcode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.DetectedBarcode").msgclass
301
312
  Document::Page::DetectedLanguage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.DetectedLanguage").msgclass
313
+ Document::Page::ImageQualityScores = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.ImageQualityScores").msgclass
314
+ Document::Page::ImageQualityScores::DetectedDefect = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect").msgclass
302
315
  Document::Entity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Entity").msgclass
303
316
  Document::Entity::NormalizedValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Entity.NormalizedValue").msgclass
304
317
  Document::EntityRelation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.EntityRelation").msgclass
@@ -5,6 +5,7 @@ require 'google/protobuf'
5
5
 
6
6
  require 'google/api/field_behavior_pb'
7
7
  require 'google/api/resource_pb'
8
+ require 'google/cloud/documentai/v1/document_schema_pb'
8
9
  require 'google/protobuf/timestamp_pb'
9
10
 
10
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -12,6 +13,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
12
13
  add_message "google.cloud.documentai.v1.ProcessorVersion" do
13
14
  optional :name, :string, 1
14
15
  optional :display_name, :string, 2
16
+ optional :document_schema, :message, 12, "google.cloud.documentai.v1.DocumentSchema"
15
17
  optional :state, :enum, 6, "google.cloud.documentai.v1.ProcessorVersion.State"
16
18
  optional :create_time, :message, 7, "google.protobuf.Timestamp"
17
19
  optional :kms_key_name, :string, 9
@@ -0,0 +1,318 @@
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 Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Api
22
22
  # The launch stage as defined by [Google Cloud Platform
23
- # Launch Stages](http://cloud.google.com/terms/launch-stages).
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
24
  module LaunchStage
25
25
  # Do not use this default value.
26
26
  LAUNCH_STAGE_UNSPECIFIED = 0
@@ -42,7 +42,7 @@ module Google
42
42
  # for widespread use. By Alpha, all significant design issues are resolved
43
43
  # and we are in the process of verifying functionality. Alpha customers
44
44
  # need to apply for access, agree to applicable terms, and have their
45
- # projects allowlisted. Alpha releases dont have to be feature complete,
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
46
  # no SLAs are provided, and there are no technical support obligations, but
47
47
  # they will be far enough along that customers can actually use them in
48
48
  # test environments or for limited-use tests -- just like they would in
@@ -61,7 +61,7 @@ module Google
61
61
  GA = 4
62
62
 
63
63
  # Deprecated features are scheduled to be shut down and removed. For more
64
- # information, see the Deprecation Policy section of our [Terms of
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
65
  # Service](https://cloud.google.com/terms/)
66
66
  # and the [Google Cloud Platform Subject to the Deprecation
67
67
  # Policy](https://cloud.google.com/terms/deprecation) documentation.
@@ -26,41 +26,43 @@ module Google
26
26
  # @return [::String]
27
27
  # Format of a barcode.
28
28
  # The supported formats are:
29
- # CODE_128: Code 128 type.
30
- # CODE_39: Code 39 type.
31
- # CODE_93: Code 93 type.
32
- # CODABAR: Codabar type.
33
- # DATA_MATRIX: 2D Data Matrix type.
34
- # ITF: ITF type.
35
- # EAN_13: EAN-13 type.
36
- # EAN_8: EAN-8 type.
37
- # QR_CODE: 2D QR code type.
38
- # UPC_A: UPC-A type.
39
- # UPC_E: UPC-E type.
40
- # PDF417: PDF417 type.
41
- # AZTEC: 2D Aztec code type.
42
- # DATABAR: GS1 DataBar code type.
29
+ #
30
+ # - `CODE_128`: Code 128 type.
31
+ # - `CODE_39`: Code 39 type.
32
+ # - `CODE_93`: Code 93 type.
33
+ # - `CODABAR`: Codabar type.
34
+ # - `DATA_MATRIX`: 2D Data Matrix type.
35
+ # - `ITF`: ITF type.
36
+ # - `EAN_13`: EAN-13 type.
37
+ # - `EAN_8`: EAN-8 type.
38
+ # - `QR_CODE`: 2D QR code type.
39
+ # - `UPC_A`: UPC-A type.
40
+ # - `UPC_E`: UPC-E type.
41
+ # - `PDF417`: PDF417 type.
42
+ # - `AZTEC`: 2D Aztec code type.
43
+ # - `DATABAR`: GS1 DataBar code type.
43
44
  # @!attribute [rw] value_format
44
45
  # @return [::String]
45
46
  # Value format describes the format of the value that a barcode
46
47
  # encodes.
47
48
  # The supported formats are:
48
- # CONTACT_INFO: Contact information.
49
- # EMAIL: Email address.
50
- # ISBN: ISBN identifier.
51
- # PHONE: Phone number.
52
- # PRODUCT: Product.
53
- # SMS: SMS message.
54
- # TEXT: Text string.
55
- # URL: URL address.
56
- # WIFI: Wifi information.
57
- # GEO: Geo-localization.
58
- # CALENDAR_EVENT: Calendar event.
59
- # DRIVER_LICENSE: Driver's license.
49
+ #
50
+ # - `CONTACT_INFO`: Contact information.
51
+ # - `EMAIL`: Email address.
52
+ # - `ISBN`: ISBN identifier.
53
+ # - `PHONE`: Phone number.
54
+ # - `PRODUCT`: Product.
55
+ # - `SMS`: SMS message.
56
+ # - `TEXT`: Text string.
57
+ # - `URL`: URL address.
58
+ # - `WIFI`: Wifi information.
59
+ # - `GEO`: Geo-localization.
60
+ # - `CALENDAR_EVENT`: Calendar event.
61
+ # - `DRIVER_LICENSE`: Driver's license.
60
62
  # @!attribute [rw] raw_value
61
63
  # @return [::String]
62
64
  # Raw value encoded in the barcode.
63
- # For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.
65
+ # For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
64
66
  class Barcode
65
67
  include ::Google::Protobuf::MessageExts
66
68
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -60,9 +60,9 @@ module Google
60
60
  # Placeholder. Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
61
61
  # @!attribute [rw] text_changes
62
62
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>]
63
- # Placeholder. A list of text corrections made to [Document.text]. This is
64
- # usually used for annotating corrections to OCR mistakes. Text changes for
65
- # a given revision may not overlap with each other.
63
+ # Placeholder. A list of text corrections made to {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. This
64
+ # is usually used for annotating corrections to OCR mistakes. Text changes
65
+ # for a given revision may not overlap with each other.
66
66
  # @!attribute [rw] shard_info
67
67
  # @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo]
68
68
  # Information about the sharding if this document is sharded part of a larger
@@ -122,6 +122,10 @@ module Google
122
122
  # @!attribute [rw] font_size
123
123
  # @return [::Google::Cloud::DocumentAI::V1::Document::Style::FontSize]
124
124
  # Font size.
125
+ # @!attribute [rw] font_family
126
+ # @return [::String]
127
+ # Font family such as `Arial`, `Times New Roman`.
128
+ # https://www.w3schools.com/cssref/pr_font_font-family.asp
125
129
  class Style
126
130
  include ::Google::Protobuf::MessageExts
127
131
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -195,6 +199,9 @@ module Google
195
199
  # @!attribute [rw] detected_barcodes
196
200
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>]
197
201
  # A list of detected barcodes.
202
+ # @!attribute [rw] image_quality_scores
203
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores]
204
+ # Image Quality Scores.
198
205
  # @!attribute [rw] provenance
199
206
  # @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
200
207
  # The history of this page.
@@ -265,7 +272,7 @@ module Google
265
272
  # @return [::Float]
266
273
  # Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within context of the object this
267
274
  # layout is for. e.g. confidence can be for a single token, a table,
268
- # a visual element, etc. depending on context. Range [0, 1].
275
+ # a visual element, etc. depending on context. Range `[0, 1]`.
269
276
  # @!attribute [rw] bounding_poly
270
277
  # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
271
278
  # The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
@@ -357,7 +364,7 @@ module Google
357
364
  # A list of detected languages together with confidence.
358
365
  # @!attribute [rw] provenance
359
366
  # @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
360
- # The history of this annotation.
367
+ # The history of this annotation.
361
368
  class Token
362
369
  include ::Google::Protobuf::MessageExts
363
370
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -428,6 +435,9 @@ module Google
428
435
  # @!attribute [rw] detected_languages
429
436
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
430
437
  # A list of detected languages together with confidence.
438
+ # @!attribute [rw] provenance
439
+ # @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
440
+ # The history of this table.
431
441
  class Table
432
442
  include ::Google::Protobuf::MessageExts
433
443
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -514,16 +524,50 @@ module Google
514
524
  # Detected language for a structural component.
515
525
  # @!attribute [rw] language_code
516
526
  # @return [::String]
517
- # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
527
+ # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
518
528
  # information, see
519
529
  # https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
520
530
  # @!attribute [rw] confidence
521
531
  # @return [::Float]
522
- # Confidence of detected language. Range [0, 1].
532
+ # Confidence of detected language. Range `[0, 1]`.
523
533
  class DetectedLanguage
524
534
  include ::Google::Protobuf::MessageExts
525
535
  extend ::Google::Protobuf::MessageExts::ClassMethods
526
536
  end
537
+
538
+ # Image Quality Scores for the page image
539
+ # @!attribute [rw] quality_score
540
+ # @return [::Float]
541
+ # The overall quality score. Range `[0, 1]` where 1 is perfect quality.
542
+ # @!attribute [rw] detected_defects
543
+ # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores::DetectedDefect>]
544
+ # A list of detected defects.
545
+ class ImageQualityScores
546
+ include ::Google::Protobuf::MessageExts
547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
+
549
+ # Image Quality Defects
550
+ # @!attribute [rw] type
551
+ # @return [::String]
552
+ # Name of the defect type. Supported values are:
553
+ #
554
+ # - `quality/defect_blurry`
555
+ # - `quality/defect_noisy`
556
+ # - `quality/defect_dark`
557
+ # - `quality/defect_faint`
558
+ # - `quality/defect_text_too_small`
559
+ # - `quality/defect_document_cutoff`
560
+ # - `quality/defect_text_cutoff`
561
+ # - `quality/defect_glare`
562
+ # @!attribute [rw] confidence
563
+ # @return [::Float]
564
+ # Confidence of detected defect. Range `[0, 1]` where 1 indicates
565
+ # strong confidence of that the defect exists.
566
+ class DetectedDefect
567
+ include ::Google::Protobuf::MessageExts
568
+ extend ::Google::Protobuf::MessageExts::ClassMethods
569
+ end
570
+ end
527
571
  end
528
572
 
529
573
  # An entity that could be a phrase in the text or a property that belongs to
@@ -538,14 +582,13 @@ module Google
538
582
  # Required. Entity type from a schema e.g. `Address`.
539
583
  # @!attribute [rw] mention_text
540
584
  # @return [::String]
541
- # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity
542
- # is not present in the document, this field will be empty.
585
+ # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
543
586
  # @!attribute [rw] mention_id
544
587
  # @return [::String]
545
588
  # Optional. Deprecated. Use `id` field instead.
546
589
  # @!attribute [rw] confidence
547
590
  # @return [::Float]
548
- # Optional. Confidence of detected Schema entity. Range [0, 1].
591
+ # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
549
592
  # @!attribute [rw] page_anchor
550
593
  # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor]
551
594
  # Optional. Represents the provenance of this entity wrt. the location on the
@@ -610,6 +653,7 @@ module Google
610
653
  # or int normalized text by default.
611
654
  #
612
655
  # Below are sample formats mapped to structured values.
656
+ #
613
657
  # - Money/Currency type (`money_value`) is in the ISO 4217 text format.
614
658
  # - Date type (`date_value`) is in the ISO 8601 text format.
615
659
  # - Datetime type (`datetime_value`) is in the ISO 8601 text format.
@@ -691,7 +735,7 @@ module Google
691
735
  # Optional. Identifies the bounding polygon of a layout element on the page.
692
736
  # @!attribute [rw] confidence
693
737
  # @return [::Float]
694
- # Optional. Confidence of detected page element, if applicable. Range [0, 1].
738
+ # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
695
739
  class PageRef
696
740
  include ::Google::Protobuf::MessageExts
697
741
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,7 +28,7 @@ module Google
28
28
  # @!attribute [rw] mime_type
29
29
  # @return [::String]
30
30
  # An IANA MIME type (RFC6838) indicating the nature and format of the
31
- # [content].
31
+ # {::Google::Cloud::DocumentAI::V1::RawDocument#content content}.
32
32
  class RawDocument
33
33
  include ::Google::Protobuf::MessageExts
34
34
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -67,7 +67,7 @@ module Google
67
67
  # The common config to specify a set of documents used as input.
68
68
  # @!attribute [rw] gcs_prefix
69
69
  # @return [::Google::Cloud::DocumentAI::V1::GcsPrefix]
70
- # The set of documents that match the specified Cloud Storage [gcs_prefix].
70
+ # The set of documents that match the specified Cloud Storage `gcs_prefix`.
71
71
  # @!attribute [rw] gcs_documents
72
72
  # @return [::Google::Cloud::DocumentAI::V1::GcsDocuments]
73
73
  # The set of documents individually specified on Cloud Storage.
@@ -89,9 +89,29 @@ module Google
89
89
  # @!attribute [rw] gcs_uri
90
90
  # @return [::String]
91
91
  # The Cloud Storage uri (a directory) of the output.
92
+ # @!attribute [rw] field_mask
93
+ # @return [::Google::Protobuf::FieldMask]
94
+ # Specifies which fields to include in the output documents.
95
+ # Only supports top level document and pages field so it must be in the
96
+ # form of `{document_field_name}` or `pages.{page_field_name}`.
97
+ # @!attribute [rw] sharding_config
98
+ # @return [::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig::ShardingConfig]
99
+ # Specifies the sharding config for the output document.
92
100
  class GcsOutputConfig
93
101
  include ::Google::Protobuf::MessageExts
94
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
103
+
104
+ # The sharding config for the output document.
105
+ # @!attribute [rw] pages_per_shard
106
+ # @return [::Integer]
107
+ # The number of pages per shard.
108
+ # @!attribute [rw] pages_overlap
109
+ # @return [::Integer]
110
+ # The number of overlapping pages between consecutive shards.
111
+ class ShardingConfig
112
+ include ::Google::Protobuf::MessageExts
113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
114
+ end
95
115
  end
96
116
  end
97
117
  end
@@ -43,6 +43,8 @@ module Google
43
43
  # @!attribute [rw] field_mask
44
44
  # @return [::Google::Protobuf::FieldMask]
45
45
  # Specifies which fields to include in ProcessResponse's document.
46
+ # Only supports top level document and pages field so it must be in the form
47
+ # of `{document_field_name}` or `pages.{page_field_name}`.
46
48
  class ProcessRequest
47
49
  include ::Google::Protobuf::MessageExts
48
50
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -56,15 +56,16 @@ module Google
56
56
  # Name of the type. It must be unique within the schema file and
57
57
  # cannot be a 'Common Type'. Besides that we use the following naming
58
58
  # conventions:
59
- # - *use snake_casing*
59
+ #
60
+ # - *use `snake_casing`*
60
61
  # - name matching is case-insensitive
61
62
  # - Maximum 64 characters.
62
63
  # - Must start with a letter.
63
64
  # - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
64
65
  # compatibility internal infrastructure and tooling can handle any ascii
65
66
  # character)
66
- # - The '/' is sometimes used to denote a property of a type. For example
67
- # line_item/amount. This convention is deprecated, but will still be
67
+ # - The `/` is sometimes used to denote a property of a type. For example
68
+ # `line_item/amount`. This convention is deprecated, but will still be
68
69
  # honored for backward compatibility.
69
70
  # @!attribute [rw] base_types
70
71
  # @return [::Array<::String>]
@@ -34,6 +34,9 @@ module Google
34
34
  # @!attribute [rw] display_name
35
35
  # @return [::String]
36
36
  # The display name of the processor version.
37
+ # @!attribute [rw] document_schema
38
+ # @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
39
+ # The schema of the processor version. Describes the output.
37
40
  # @!attribute [rw] state
38
41
  # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::State]
39
42
  # The state of the processor version.
@@ -104,7 +107,7 @@ module Google
104
107
  # Format: `projects/{project}/locations/{location}/processors/{processor}`
105
108
  # @!attribute [rw] type
106
109
  # @return [::String]
107
- # The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
110
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
108
111
  # To get a list of processors types, see
109
112
  # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
110
113
  # @!attribute [rw] display_name
@@ -143,14 +146,14 @@ module Google
143
146
  # The processor is disabled.
144
147
  DISABLED = 2
145
148
 
146
- # The processor is being enabled, will become ENABLED if successful.
149
+ # The processor is being enabled, will become `ENABLED` if successful.
147
150
  ENABLING = 3
148
151
 
149
- # The processor is being disabled, will become DISABLED if successful.
152
+ # The processor is being disabled, will become `DISABLED` if successful.
150
153
  DISABLING = 4
151
154
 
152
- # The processor is being created, will become either ENABLED (for
153
- # successful creation) or FAILED (for failed ones).
155
+ # The processor is being created, will become either `ENABLED` (for
156
+ # successful creation) or `FAILED` (for failed ones).
154
157
  # Once a processor is in this state, it can then be used for document
155
158
  # processing, but the feature dependencies of the processor might not be
156
159
  # fully created yet.
@@ -26,10 +26,10 @@ module Google
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
28
  # The resource name of the processor type.
29
- # Format: projects/\\{project}/processorTypes/\\{processor_type}
29
+ # Format: `projects/{project}/processorTypes/{processor_type}`
30
30
  # @!attribute [rw] type
31
31
  # @return [::String]
32
- # The type of the processor, e.g., "invoice_parsing".
32
+ # The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
33
33
  # @!attribute [rw] category
34
34
  # @return [::String]
35
35
  # The processor category, used by UI to group processor types.
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
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.5.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: 2022-08-11 00:00:00.000000000 Z
11
+ date: 2022-12-14 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.10'
19
+ version: '0.12'
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.10'
29
+ version: '0.12'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -209,6 +209,7 @@ files:
209
209
  - lib/google/cloud/documentai/v1/processor_pb.rb
210
210
  - lib/google/cloud/documentai/v1/processor_type_pb.rb
211
211
  - proto_docs/README.md
212
+ - proto_docs/google/api/client.rb
212
213
  - proto_docs/google/api/field_behavior.rb
213
214
  - proto_docs/google/api/launch_stage.rb
214
215
  - proto_docs/google/api/resource.rb