google-cloud-document_ai-v1 0.6.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 90b5a3c9e7d05297c9a6f2d2c351ce1bb121f1e92ff77ada6042883859350795
4
- data.tar.gz: bf0fd6fd65d030fe8c0e77465651a585d9d5c1007e3b97c26535614a0a01c7c3
3
+ metadata.gz: b8c3c90fc9bf3fb3c6b0a2252176c63bec1080bde39eea07102d89ee66746a5c
4
+ data.tar.gz: f7f87f6d86f565e97b4734d3771d5d16588cca9ecff224271e7f8e6d2d6be04c
5
5
  SHA512:
6
- metadata.gz: a57b551259eb706e50343c7d5c29e9d1281e96a57d0b21e1557c93e19e2c6b93cb446bb542cdfecb6a95d16d27ee4cfa45d7f568673303fe6948476ee0f7e479
7
- data.tar.gz: ebe7406306f10d17d25abf459bb0949e8babc59b2075dcf5ba88e1267003b2ffec71921d065f6a24dc49e8904d162af3f1561d796dc71d385da6cafd1055e7b5
6
+ metadata.gz: 4b82b1044029db75a4b6c56eff682f9d9da80a981422499f50af37acb4cfd96806d6a9c4075a9244f708d77b3ede18fb2e2adf16f75b21006cfa223ebba79c92
7
+ data.tar.gz: 5450e7716991efc9eba9faf7dd0a7726671020da2d527e62cb0661c55709a33f37619bff16c98b276eec2f5b498f0c4e6359a83a24652a9e12c388ad261de28f
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.
@@ -212,11 +212,15 @@ module Google
212
212
  # @param raw_document [::Google::Cloud::DocumentAI::V1::RawDocument, ::Hash]
213
213
  # A raw document content (bytes).
214
214
  # @param name [::String]
215
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
215
+ # Required. The resource name of the
216
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
216
217
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}
217
- # to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use
218
- # its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format:
219
- # `projects/{project}/locations/{location}/processors/{processor}`, or
218
+ # to use for processing. If a
219
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server
220
+ # will use its [default
221
+ # version][google.cloud.documentai.v1.Processor.default_processor_version].
222
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`,
223
+ # or
220
224
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
221
225
  # @param skip_human_review [::Boolean]
222
226
  # Whether Human Review feature should be skipped for this request. Default to
@@ -310,7 +314,8 @@ module Google
310
314
  # the default parameter values, pass an empty Hash as a request object (see above).
311
315
  #
312
316
  # @param name [::String]
313
- # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
317
+ # Required. The resource name of
318
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
314
319
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
315
320
  # Format: `projects/{project}/locations/{location}/processors/{processor}`,
316
321
  # or
@@ -602,8 +607,8 @@ module Google
602
607
  # the default parameter values, pass an empty Hash as a request object (see above).
603
608
  #
604
609
  # @param parent [::String]
605
- # Required. The parent (project and location) which owns this collection of Processors.
606
- # Format: `projects/{project}/locations/{location}`
610
+ # Required. The parent (project and location) which owns this collection of
611
+ # Processors. Format: `projects/{project}/locations/{location}`
607
612
  # @param page_size [::Integer]
608
613
  # The maximum number of processors to return.
609
614
  # If unspecified, at most 50 processors will be returned.
@@ -872,8 +877,9 @@ module Google
872
877
  # the default parameter values, pass an empty Hash as a request object (see above).
873
878
  #
874
879
  # @param parent [::String]
875
- # Required. The parent (project, location and processor) to list all versions.
876
- # Format: `projects/{project}/locations/{location}/processors/{processor}`
880
+ # Required. The parent (project, location and processor) to list all
881
+ # versions. Format:
882
+ # `projects/{project}/locations/{location}/processors/{processor}`
877
883
  # @param page_size [::Integer]
878
884
  # The maximum number of processor versions to return.
879
885
  # If unspecified, at most 10 processor versions will be returned.
@@ -1253,11 +1259,12 @@ module Google
1253
1259
  # the default parameter values, pass an empty Hash as a request object (see above).
1254
1260
  #
1255
1261
  # @param parent [::String]
1256
- # Required. The parent (project and location) under which to create the processor.
1257
- # Format: `projects/{project}/locations/{location}`
1262
+ # Required. The parent (project and location) under which to create the
1263
+ # processor. Format: `projects/{project}/locations/{location}`
1258
1264
  # @param processor [::Google::Cloud::DocumentAI::V1::Processor, ::Hash]
1259
- # Required. The processor to be created, requires [processor_type] and [display_name]
1260
- # to be set. Also, the processor is under CMEK if CMEK fields are set.
1265
+ # Required. The processor to be created, requires [processor_type] and
1266
+ # [display_name] to be set. Also, the processor is under CMEK if CMEK fields
1267
+ # are set.
1261
1268
  #
1262
1269
  # @yield [response, operation] Access the result along with the RPC operation
1263
1270
  # @yieldparam response [::Google::Cloud::DocumentAI::V1::Processor]
@@ -1604,8 +1611,10 @@ module Google
1604
1611
  end
1605
1612
 
1606
1613
  ##
1607
- # Set the default (active) version of a {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in
1608
- # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} and
1614
+ # Set the default (active) version of a
1615
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in
1616
+ # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument}
1617
+ # and
1609
1618
  # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
1610
1619
  #
1611
1620
  # @overload set_default_processor_version(request, options = nil)
@@ -1624,10 +1633,13 @@ module Google
1624
1633
  # the default parameter values, pass an empty Hash as a request object (see above).
1625
1634
  #
1626
1635
  # @param processor [::String]
1627
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version.
1636
+ # Required. The resource name of the
1637
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default
1638
+ # version.
1628
1639
  # @param default_processor_version [::String]
1629
- # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default.
1630
- # Format:
1640
+ # Required. The resource name of child
1641
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as
1642
+ # default. Format:
1631
1643
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
1632
1644
  #
1633
1645
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1724,8 +1736,8 @@ module Google
1724
1736
  # @param inline_document [::Google::Cloud::DocumentAI::V1::Document, ::Hash]
1725
1737
  # An inline document proto.
1726
1738
  # @param human_review_config [::String]
1727
- # Required. The resource name of the HumanReviewConfig that the document will be
1728
- # reviewed with.
1739
+ # Required. The resource name of the HumanReviewConfig that the document will
1740
+ # be reviewed with.
1729
1741
  # @param enable_schema_validation [::Boolean]
1730
1742
  # Whether the validation should be performed on the ad-hoc review request.
1731
1743
  # @param priority [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1
24
- VERSION = "0.6.0"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
@@ -35,6 +35,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
35
35
  add_message "google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig" do
36
36
  optional :gcs_uri, :string, 1
37
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
38
43
  end
39
44
  end
40
45
  end
@@ -50,6 +55,7 @@ module Google
50
55
  BatchDocumentsInputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.BatchDocumentsInputConfig").msgclass
51
56
  DocumentOutputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.DocumentOutputConfig").msgclass
52
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
53
59
  end
54
60
  end
55
61
  end
@@ -71,8 +71,10 @@ module Google
71
71
  rpc :EnableProcessor, ::Google::Cloud::DocumentAI::V1::EnableProcessorRequest, ::Google::Longrunning::Operation
72
72
  # Disables a processor
73
73
  rpc :DisableProcessor, ::Google::Cloud::DocumentAI::V1::DisableProcessorRequest, ::Google::Longrunning::Operation
74
- # Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in
75
- # [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and
74
+ # Set the default (active) version of a
75
+ # [Processor][google.cloud.documentai.v1.Processor] that will be used in
76
+ # [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
77
+ # and
76
78
  # [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
77
79
  rpc :SetDefaultProcessorVersion, ::Google::Cloud::DocumentAI::V1::SetDefaultProcessorVersionRequest, ::Google::Longrunning::Operation
78
80
  # Send a document for Human Review. The input document should be processed by
@@ -15,6 +15,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
15
15
  repeated :available_locations, :message, 4, "google.cloud.documentai.v1.ProcessorType.LocationInfo"
16
16
  optional :allow_creation, :bool, 6
17
17
  optional :launch_stage, :enum, 8, "google.api.LaunchStage"
18
+ repeated :sample_document_uris, :string, 9
18
19
  end
19
20
  add_message "google.cloud.documentai.v1.ProcessorType.LocationInfo" do
20
21
  optional :location_id, :string, 1
@@ -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.
@@ -47,22 +47,25 @@ module Google
47
47
  # Optional. UTF-8 encoded text in reading order from the document.
48
48
  # @!attribute [rw] text_styles
49
49
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Style>]
50
- # Placeholder. Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
50
+ # Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
51
51
  # @!attribute [rw] pages
52
52
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page>]
53
53
  # Visual page layout for the {::Google::Cloud::DocumentAI::V1::Document Document}.
54
54
  # @!attribute [rw] entities
55
55
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
56
- # A list of entities detected on {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document shards,
57
- # entities in this list may cross shard boundaries.
56
+ # A list of entities detected on
57
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document
58
+ # shards, entities in this list may cross shard boundaries.
58
59
  # @!attribute [rw] entity_relations
59
60
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::EntityRelation>]
60
- # Placeholder. Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
61
+ # Placeholder. Relationship among
62
+ # {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
61
63
  # @!attribute [rw] text_changes
62
64
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>]
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.
65
+ # Placeholder. A list of text corrections made to
66
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. This is usually
67
+ # used for annotating corrections to OCR mistakes. Text changes for a given
68
+ # revision may not overlap with each other.
66
69
  # @!attribute [rw] shard_info
67
70
  # @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo]
68
71
  # Information about the sharding if this document is sharded part of a larger
@@ -88,7 +91,8 @@ module Google
88
91
  # Total number of shards.
89
92
  # @!attribute [rw] text_offset
90
93
  # @return [::Integer]
91
- # The index of the first character in {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
94
+ # The index of the first character in
95
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
92
96
  # document global text.
93
97
  class ShardInfo
94
98
  include ::Google::Protobuf::MessageExts
@@ -99,7 +103,8 @@ module Google
99
103
  # conventions as much as possible.
100
104
  # @!attribute [rw] text_anchor
101
105
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
102
- # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
106
+ # Text anchor indexing into the
107
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
103
108
  # @!attribute [rw] color
104
109
  # @return [::Google::Type::Color]
105
110
  # Text color.
@@ -146,9 +151,11 @@ module Google
146
151
  # A page in a {::Google::Cloud::DocumentAI::V1::Document Document}.
147
152
  # @!attribute [rw] page_number
148
153
  # @return [::Integer]
149
- # 1-based index for current {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent {::Google::Cloud::DocumentAI::V1::Document Document}.
150
- # Useful when a page is taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for individual
151
- # processing.
154
+ # 1-based index for current
155
+ # {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent
156
+ # {::Google::Cloud::DocumentAI::V1::Document Document}. Useful when a page is
157
+ # taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for
158
+ # individual processing.
152
159
  # @!attribute [rw] image
153
160
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Image]
154
161
  # Rendered image for this page. This image is preprocessed to remove any
@@ -267,18 +274,23 @@ module Google
267
274
  # Visual element describing a layout unit on a page.
268
275
  # @!attribute [rw] text_anchor
269
276
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
270
- # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
277
+ # Text anchor indexing into the
278
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
271
279
  # @!attribute [rw] confidence
272
280
  # @return [::Float]
273
- # Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within context of the object this
274
- # layout is for. e.g. confidence can be for a single token, a table,
275
- # a visual element, etc. depending on context. Range `[0, 1]`.
281
+ # Confidence of the current
282
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within
283
+ # context of the object this layout is for. e.g. confidence can be for a
284
+ # single token, a table, a visual element, etc. depending on context.
285
+ # Range `[0, 1]`.
276
286
  # @!attribute [rw] bounding_poly
277
287
  # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
278
- # The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
288
+ # The bounding polygon for the
289
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
279
290
  # @!attribute [rw] orientation
280
291
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout::Orientation]
281
- # Detected orientation for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
292
+ # Detected orientation for the
293
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
282
294
  class Layout
283
295
  include ::Google::Protobuf::MessageExts
284
296
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -309,7 +321,8 @@ module Google
309
321
  # common line-spacing and orientation.
310
322
  # @!attribute [rw] layout
311
323
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
312
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
324
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
325
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
313
326
  # @!attribute [rw] detected_languages
314
327
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
315
328
  # A list of detected languages together with confidence.
@@ -324,7 +337,8 @@ module Google
324
337
  # A collection of lines that a human would perceive as a paragraph.
325
338
  # @!attribute [rw] layout
326
339
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
327
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
340
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
341
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
328
342
  # @!attribute [rw] detected_languages
329
343
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
330
344
  # A list of detected languages together with confidence.
@@ -340,7 +354,8 @@ module Google
340
354
  # Does not cross column boundaries, can be horizontal, vertical, etc.
341
355
  # @!attribute [rw] layout
342
356
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
343
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
357
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
358
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
344
359
  # @!attribute [rw] detected_languages
345
360
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
346
361
  # A list of detected languages together with confidence.
@@ -355,10 +370,12 @@ module Google
355
370
  # A detected token.
356
371
  # @!attribute [rw] layout
357
372
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
358
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
373
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
374
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
359
375
  # @!attribute [rw] detected_break
360
376
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak]
361
- # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
377
+ # Detected break at the end of a
378
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
362
379
  # @!attribute [rw] detected_languages
363
380
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
364
381
  # A list of detected languages together with confidence.
@@ -369,7 +386,8 @@ module Google
369
386
  include ::Google::Protobuf::MessageExts
370
387
  extend ::Google::Protobuf::MessageExts::ClassMethods
371
388
 
372
- # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
389
+ # Detected break at the end of a
390
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
373
391
  # @!attribute [rw] type
374
392
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak::Type]
375
393
  # Detected break type.
@@ -397,7 +415,8 @@ module Google
397
415
  # A detected symbol.
398
416
  # @!attribute [rw] layout
399
417
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
400
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
418
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
419
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
401
420
  # @!attribute [rw] detected_languages
402
421
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
403
422
  # A list of detected languages together with confidence.
@@ -410,10 +429,12 @@ module Google
410
429
  # page.
411
430
  # @!attribute [rw] layout
412
431
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
413
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
432
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
433
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
414
434
  # @!attribute [rw] type
415
435
  # @return [::String]
416
- # Type of the {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
436
+ # Type of the
437
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
417
438
  # @!attribute [rw] detected_languages
418
439
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
419
440
  # A list of detected languages together with confidence.
@@ -425,7 +446,8 @@ module Google
425
446
  # A table representation similar to HTML table structure.
426
447
  # @!attribute [rw] layout
427
448
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
428
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
449
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
450
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
429
451
  # @!attribute [rw] header_rows
430
452
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableRow>]
431
453
  # Header rows of the table.
@@ -454,7 +476,8 @@ module Google
454
476
  # A cell representation inside the table.
455
477
  # @!attribute [rw] layout
456
478
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
457
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
479
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
480
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
458
481
  # @!attribute [rw] row_span
459
482
  # @return [::Integer]
460
483
  # How many rows this cell spans.
@@ -473,11 +496,13 @@ module Google
473
496
  # A form field detected on the page.
474
497
  # @!attribute [rw] field_name
475
498
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
476
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name. e.g. `Address`, `Email`,
477
- # `Grand total`, `Phone number`, etc.
499
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
500
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name.
501
+ # e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
478
502
  # @!attribute [rw] field_value
479
503
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
480
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
504
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
505
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
481
506
  # @!attribute [rw] name_detected_languages
482
507
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
483
508
  # A list of detected languages for name together with confidence.
@@ -488,9 +513,10 @@ module Google
488
513
  # @return [::String]
489
514
  # If the value is non-textual, this field represents the type. Current
490
515
  # valid values are:
491
- # - blank (this indicates the field_value is normal text)
492
- # - "unfilled_checkbox"
493
- # - "filled_checkbox"
516
+ #
517
+ # - blank (this indicates the `field_value` is normal text)
518
+ # - `unfilled_checkbox`
519
+ # - `filled_checkbox`
494
520
  # @!attribute [rw] corrected_key_text
495
521
  # @return [::String]
496
522
  # Created for Labeling UI to export key text.
@@ -512,10 +538,12 @@ module Google
512
538
  # A detected barcode.
513
539
  # @!attribute [rw] layout
514
540
  # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
515
- # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
541
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
542
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
516
543
  # @!attribute [rw] barcode
517
544
  # @return [::Google::Cloud::DocumentAI::V1::Barcode]
518
- # Detailed barcode information of the {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
545
+ # Detailed barcode information of the
546
+ # {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
519
547
  class DetectedBarcode
520
548
  include ::Google::Protobuf::MessageExts
521
549
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -576,7 +604,8 @@ module Google
576
604
  # @!attribute [rw] text_anchor
577
605
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
578
606
  # Optional. Provenance of the entity.
579
- # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
607
+ # Text anchor indexing into the
608
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
580
609
  # @!attribute [rw] type
581
610
  # @return [::String]
582
611
  # Required. Entity type from a schema e.g. `Address`.
@@ -591,28 +620,29 @@ module Google
591
620
  # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
592
621
  # @!attribute [rw] page_anchor
593
622
  # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor]
594
- # Optional. Represents the provenance of this entity wrt. the location on the
595
- # page where it was found.
623
+ # Optional. Represents the provenance of this entity wrt. the location on
624
+ # the page where it was found.
596
625
  # @!attribute [rw] id
597
626
  # @return [::String]
598
627
  # Optional. Canonical id. This will be a unique value in the entity list
599
628
  # for this document.
600
629
  # @!attribute [rw] normalized_value
601
630
  # @return [::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue]
602
- # Optional. Normalized entity value. Absent if the extracted value could not be
603
- # converted or the type (e.g. address) is not supported for certain
631
+ # Optional. Normalized entity value. Absent if the extracted value could
632
+ # not be converted or the type (e.g. address) is not supported for certain
604
633
  # parsers. This field is also only populated for certain supported document
605
634
  # types.
606
635
  # @!attribute [rw] properties
607
636
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
608
- # Optional. Entities can be nested to form a hierarchical data structure representing
609
- # the content in the document.
637
+ # Optional. Entities can be nested to form a hierarchical data structure
638
+ # representing the content in the document.
610
639
  # @!attribute [rw] provenance
611
640
  # @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
612
641
  # Optional. The history of this annotation.
613
642
  # @!attribute [rw] redacted
614
643
  # @return [::Boolean]
615
- # Optional. Whether the entity will be redacted for de-identification purposes.
644
+ # Optional. Whether the entity will be redacted for de-identification
645
+ # purposes.
616
646
  class Entity
617
647
  include ::Google::Protobuf::MessageExts
618
648
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -649,8 +679,8 @@ module Google
649
679
  # Optional. An optional field to store a normalized string.
650
680
  # For some entity types, one of respective `structured_value` fields may
651
681
  # also be populated. Also not all the types of `structured_value` will be
652
- # normalized. For example, some processors may not generate float
653
- # or int normalized text by default.
682
+ # normalized. For example, some processors may not generate `float`
683
+ # or `integer` normalized text by default.
654
684
  #
655
685
  # Below are sample formats mapped to structured values.
656
686
  #
@@ -663,7 +693,8 @@ module Google
663
693
  end
664
694
  end
665
695
 
666
- # Relationship between {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
696
+ # Relationship between
697
+ # {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
667
698
  # @!attribute [rw] subject_id
668
699
  # @return [::String]
669
700
  # Subject entity id.
@@ -678,10 +709,12 @@ module Google
678
709
  extend ::Google::Protobuf::MessageExts::ClassMethods
679
710
  end
680
711
 
681
- # Text reference indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
712
+ # Text reference indexing into the
713
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
682
714
  # @!attribute [rw] text_segments
683
715
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment>]
684
- # The text segments from the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
716
+ # The text segments from the
717
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
685
718
  # @!attribute [rw] content
686
719
  # @return [::String]
687
720
  # Contains the content of the text span so that users do
@@ -691,15 +724,20 @@ module Google
691
724
  include ::Google::Protobuf::MessageExts
692
725
  extend ::Google::Protobuf::MessageExts::ClassMethods
693
726
 
694
- # A text segment in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices may be out of bounds
695
- # which indicate that the text extends into another document shard for
696
- # large sharded documents. See {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
727
+ # A text segment in the
728
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices
729
+ # may be out of bounds which indicate that the text extends into another
730
+ # document shard for large sharded documents. See
731
+ # {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
697
732
  # @!attribute [rw] start_index
698
733
  # @return [::Integer]
699
- # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} start UTF-8 char index in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
734
+ # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
735
+ # start UTF-8 char index in the
736
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
700
737
  # @!attribute [rw] end_index
701
738
  # @return [::Integer]
702
- # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} half open end UTF-8 char index in the
739
+ # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
740
+ # half open end UTF-8 char index in the
703
741
  # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
704
742
  class TextSegment
705
743
  include ::Google::Protobuf::MessageExts
@@ -707,9 +745,10 @@ module Google
707
745
  end
708
746
  end
709
747
 
710
- # Referencing the visual context of the entity in the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}.
711
- # Page anchors can be cross-page, consist of multiple bounding polygons and
712
- # optionally reference specific layout element types.
748
+ # Referencing the visual context of the entity in the
749
+ # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}. Page anchors
750
+ # can be cross-page, consist of multiple bounding polygons and optionally
751
+ # reference specific layout element types.
713
752
  # @!attribute [rw] page_refs
714
753
  # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef>]
715
754
  # One or more references to visual page elements
@@ -720,22 +759,29 @@ module Google
720
759
  # Represents a weak reference to a page element within a document.
721
760
  # @!attribute [rw] page
722
761
  # @return [::Integer]
723
- # Required. Index into the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element, for example using
724
- # [Document.pages][page_refs.page] to locate the related page element.
725
- # This field is skipped when its value is the default 0. See
762
+ # Required. Index into the
763
+ # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element,
764
+ # for example using
765
+ # `[Document.pages][page_refs.page]` to locate the related page element.
766
+ # This field is skipped when its value is the default `0`. See
726
767
  # https://developers.google.com/protocol-buffers/docs/proto3#json.
727
768
  # @!attribute [rw] layout_type
728
769
  # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType]
729
- # Optional. The type of the layout element that is being referenced if any.
770
+ # Optional. The type of the layout element that is being referenced if
771
+ # any.
730
772
  # @!attribute [rw] layout_id
731
773
  # @return [::String]
732
- # Optional. Deprecated. Use {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead.
774
+ # Optional. Deprecated. Use
775
+ # {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
776
+ # instead.
733
777
  # @!attribute [rw] bounding_poly
734
778
  # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
735
- # Optional. Identifies the bounding polygon of a layout element on the page.
779
+ # Optional. Identifies the bounding polygon of a layout element on the
780
+ # page.
736
781
  # @!attribute [rw] confidence
737
782
  # @return [::Float]
738
- # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
783
+ # Optional. Confidence of detected page element, if applicable. Range
784
+ # `[0, 1]`.
739
785
  class PageRef
740
786
  include ::Google::Protobuf::MessageExts
741
787
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -745,25 +791,38 @@ module Google
745
791
  # Layout Unspecified.
746
792
  LAYOUT_TYPE_UNSPECIFIED = 0
747
793
 
748
- # References a {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks} element.
794
+ # References a
795
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks}
796
+ # element.
749
797
  BLOCK = 1
750
798
 
751
- # References a {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs} element.
799
+ # References a
800
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
801
+ # element.
752
802
  PARAGRAPH = 2
753
803
 
754
- # References a {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
804
+ # References a
805
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
755
806
  LINE = 3
756
807
 
757
- # References a {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens} element.
808
+ # References a
809
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
810
+ # element.
758
811
  TOKEN = 4
759
812
 
760
- # References a {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements} element.
813
+ # References a
814
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
815
+ # element.
761
816
  VISUAL_ELEMENT = 5
762
817
 
763
- # Refrrences a {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables} element.
818
+ # Refrrences a
819
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
820
+ # element.
764
821
  TABLE = 6
765
822
 
766
- # References a {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields} element.
823
+ # References a
824
+ # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
825
+ # element.
767
826
  FORM_FIELD = 7
768
827
  end
769
828
  end
@@ -882,8 +941,9 @@ module Google
882
941
  # @!attribute [rw] text_anchor
883
942
  # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
884
943
  # Provenance of the correction.
885
- # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. There can only be a
886
- # single `TextAnchor.text_segments` element. If the start and
944
+ # Text anchor indexing into the
945
+ # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. There can
946
+ # only be a single `TextAnchor.text_segments` element. If the start and
887
947
  # end index of the text segment are the same, the text change is inserted
888
948
  # before that index.
889
949
  # @!attribute [rw] changed_text
@@ -94,9 +94,24 @@ module Google
94
94
  # Specifies which fields to include in the output documents.
95
95
  # Only supports top level document and pages field so it must be in the
96
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.
97
100
  class GcsOutputConfig
98
101
  include ::Google::Protobuf::MessageExts
99
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
100
115
  end
101
116
  end
102
117
  end
@@ -30,11 +30,15 @@ module Google
30
30
  # A raw document content (bytes).
31
31
  # @!attribute [rw] name
32
32
  # @return [::String]
33
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
33
+ # Required. The resource name of the
34
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
34
35
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}
35
- # to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use
36
- # its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format:
37
- # `projects/{project}/locations/{location}/processors/{processor}`, or
36
+ # to use for processing. If a
37
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server
38
+ # will use its [default
39
+ # version][google.cloud.documentai.v1.Processor.default_processor_version].
40
+ # Format: `projects/{project}/locations/{location}/processors/{processor}`,
41
+ # or
38
42
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
39
43
  # @!attribute [rw] skip_human_review
40
44
  # @return [::Boolean]
@@ -105,7 +109,8 @@ module Google
105
109
  # Request message for batch process document method.
106
110
  # @!attribute [rw] name
107
111
  # @return [::String]
108
- # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
112
+ # Required. The resource name of
113
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} or
109
114
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
110
115
  # Format: `projects/{project}/locations/{location}/processors/{processor}`,
111
116
  # or
@@ -253,8 +258,8 @@ module Google
253
258
  # Request message for list all processors belongs to a project.
254
259
  # @!attribute [rw] parent
255
260
  # @return [::String]
256
- # Required. The parent (project and location) which owns this collection of Processors.
257
- # Format: `projects/{project}/locations/{location}`
261
+ # Required. The parent (project and location) which owns this collection of
262
+ # Processors. Format: `projects/{project}/locations/{location}`
258
263
  # @!attribute [rw] page_size
259
264
  # @return [::Integer]
260
265
  # The maximum number of processors to return.
@@ -302,8 +307,9 @@ module Google
302
307
  # Request message for list all processor versions belongs to a processor.
303
308
  # @!attribute [rw] parent
304
309
  # @return [::String]
305
- # Required. The parent (project, location and processor) to list all versions.
306
- # Format: `projects/{project}/locations/{location}/processors/{processor}`
310
+ # Required. The parent (project, location and processor) to list all
311
+ # versions. Format:
312
+ # `projects/{project}/locations/{location}/processors/{processor}`
307
313
  # @!attribute [rw] page_size
308
314
  # @return [::Integer]
309
315
  # The maximum number of processor versions to return.
@@ -402,12 +408,13 @@ module Google
402
408
  # on that region, the creation will fail.
403
409
  # @!attribute [rw] parent
404
410
  # @return [::String]
405
- # Required. The parent (project and location) under which to create the processor.
406
- # Format: `projects/{project}/locations/{location}`
411
+ # Required. The parent (project and location) under which to create the
412
+ # processor. Format: `projects/{project}/locations/{location}`
407
413
  # @!attribute [rw] processor
408
414
  # @return [::Google::Cloud::DocumentAI::V1::Processor]
409
- # Required. The processor to be created, requires [processor_type] and [display_name]
410
- # to be set. Also, the processor is under CMEK if CMEK fields are set.
415
+ # Required. The processor to be created, requires [processor_type] and
416
+ # [display_name] to be set. Also, the processor is under CMEK if CMEK fields
417
+ # are set.
411
418
  class CreateProcessorRequest
412
419
  include ::Google::Protobuf::MessageExts
413
420
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -484,11 +491,14 @@ module Google
484
491
  # Request message for the set default processor version method.
485
492
  # @!attribute [rw] processor
486
493
  # @return [::String]
487
- # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version.
494
+ # Required. The resource name of the
495
+ # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default
496
+ # version.
488
497
  # @!attribute [rw] default_processor_version
489
498
  # @return [::String]
490
- # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default.
491
- # Format:
499
+ # Required. The resource name of child
500
+ # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as
501
+ # default. Format:
492
502
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
493
503
  class SetDefaultProcessorVersionRequest
494
504
  include ::Google::Protobuf::MessageExts
@@ -517,8 +527,8 @@ module Google
517
527
  # An inline document proto.
518
528
  # @!attribute [rw] human_review_config
519
529
  # @return [::String]
520
- # Required. The resource name of the HumanReviewConfig that the document will be
521
- # reviewed with.
530
+ # Required. The resource name of the HumanReviewConfig that the document will
531
+ # be reviewed with.
522
532
  # @!attribute [rw] enable_schema_validation
523
533
  # @return [::Boolean]
524
534
  # Whether the validation should be performed on the ad-hoc review request.
@@ -58,7 +58,7 @@ module Google
58
58
  # conventions:
59
59
  #
60
60
  # - *use `snake_casing`*
61
- # - name matching is case-insensitive
61
+ # - name matching is case-sensitive
62
62
  # - Maximum 64 characters.
63
63
  # - Must start with a letter.
64
64
  # - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
@@ -121,7 +121,8 @@ module Google
121
121
  # The default processor version.
122
122
  # @!attribute [r] process_endpoint
123
123
  # @return [::String]
124
- # Output only. Immutable. The http endpoint that can be called to invoke processing.
124
+ # Output only. Immutable. The http endpoint that can be called to invoke
125
+ # processing.
125
126
  # @!attribute [rw] create_time
126
127
  # @return [::Google::Protobuf::Timestamp]
127
128
  # The time the processor was created.
@@ -43,6 +43,9 @@ module Google
43
43
  # @!attribute [rw] launch_stage
44
44
  # @return [::Google::Api::LaunchStage]
45
45
  # Launch stage of the processor type
46
+ # @!attribute [rw] sample_document_uris
47
+ # @return [::Array<::String>]
48
+ # A set of Cloud Storage URIs of sample documents for this processor.
46
49
  class ProcessorType
47
50
  include ::Google::Protobuf::MessageExts
48
51
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -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.6.0
4
+ version: 0.8.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-11-10 00:00:00.000000000 Z
11
+ date: 2022-12-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -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