google-cloud-document_ai-v1beta3 0.38.0 → 0.39.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 +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +21 -0
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb +7 -0
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb +21 -0
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/operations.rb +7 -0
- data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb +7 -0
- data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb +7 -0
- data/lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb +7 -0
- data/lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb +7 -0
- data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
- data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb +14 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document.rb +34 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +4 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +20 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_service.rb +4 -0
- data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +4 -0
- data/proto_docs/google/longrunning/operations.rb +4 -0
- data/proto_docs/google/type/datetime.rb +4 -0
- metadata +6 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d50a6a5de154cf67eca2835276279b8eafe835162d0c7809a18d77aad96d0cef
|
4
|
+
data.tar.gz: 1dd31929ec95c5f08cdc29caef3a2f672d5459a574e43fb49484c1525c97c167
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d20752d8d076782f6dd1cc94b2c9c7646484499c3c03eb10389e7d3baec48f654fc166605e7fd8f38a1ce020f7495e7b500ad4f3e06b52873aecbf79a20d131b
|
7
|
+
data.tar.gz: ebddd9d2a06be7723ace550a4ff82d2d8b076e4c06b17680fe40590e610c2de4230ea1962b7d4e7598d6934eb8424db87b0fb74cf35d6a4b537358bb19a68694
|
data/README.md
CHANGED
@@ -86,7 +86,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
|
|
86
86
|
|
87
87
|
## Supported Ruby Versions
|
88
88
|
|
89
|
-
This library is supported on Ruby
|
89
|
+
This library is supported on Ruby 3.0+.
|
90
90
|
|
91
91
|
Google provides official support for Ruby versions that are actively supported
|
92
92
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
@@ -251,10 +251,16 @@ module Google
|
|
251
251
|
#
|
252
252
|
# @param inline_document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
|
253
253
|
# An inline document proto.
|
254
|
+
#
|
255
|
+
# Note: The following fields are mutually exclusive: `inline_document`, `raw_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
254
256
|
# @param raw_document [::Google::Cloud::DocumentAI::V1beta3::RawDocument, ::Hash]
|
255
257
|
# A raw document content (bytes).
|
258
|
+
#
|
259
|
+
# Note: The following fields are mutually exclusive: `raw_document`, `inline_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
256
260
|
# @param gcs_document [::Google::Cloud::DocumentAI::V1beta3::GcsDocument, ::Hash]
|
257
261
|
# A raw document on Google Cloud Storage.
|
262
|
+
#
|
263
|
+
# Note: The following fields are mutually exclusive: `gcs_document`, `inline_document`, `raw_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
258
264
|
# @param name [::String]
|
259
265
|
# Required. The resource name of the
|
260
266
|
# {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
|
@@ -956,8 +962,12 @@ module Google
|
|
956
962
|
#
|
957
963
|
# @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
|
958
964
|
# Options to control Custom Document Extraction (CDE) Processor.
|
965
|
+
#
|
966
|
+
# Note: The following fields are mutually exclusive: `custom_document_extraction_options`, `foundation_model_tuning_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
959
967
|
# @param foundation_model_tuning_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions, ::Hash]
|
960
968
|
# Options to control foundation model tuning of a processor.
|
969
|
+
#
|
970
|
+
# Note: The following fields are mutually exclusive: `foundation_model_tuning_options`, `custom_document_extraction_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
961
971
|
# @param parent [::String]
|
962
972
|
# Required. The parent (project, location and processor) to create the new
|
963
973
|
# version for. Format:
|
@@ -2421,9 +2431,13 @@ module Google
|
|
2421
2431
|
# and destination processor need to be in the same environment and region.
|
2422
2432
|
# Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not
|
2423
2433
|
# supported.
|
2434
|
+
#
|
2435
|
+
# Note: The following fields are mutually exclusive: `processor_version_source`, `external_processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
2424
2436
|
# @param external_processor_version_source [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource, ::Hash]
|
2425
2437
|
# The source processor version to import from. It can be from a different
|
2426
2438
|
# environment and region than the destination processor.
|
2439
|
+
#
|
2440
|
+
# Note: The following fields are mutually exclusive: `external_processor_version_source`, `processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
2427
2441
|
# @param parent [::String]
|
2428
2442
|
# Required. The destination processor name to create the processor version
|
2429
2443
|
# in. Format:
|
@@ -2546,6 +2560,13 @@ module Google
|
|
2546
2560
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
2547
2561
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
2548
2562
|
# * (`nil`) indicating no credentials
|
2563
|
+
#
|
2564
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
2565
|
+
# external source for authentication to Google Cloud, you must validate it before
|
2566
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
2567
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
2568
|
+
# For more information, refer to [Validate credential configurations from external
|
2569
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
2549
2570
|
# @return [::Object]
|
2550
2571
|
# @!attribute [rw] scope
|
2551
2572
|
# The OAuth scopes
|
@@ -640,6 +640,13 @@ module Google
|
|
640
640
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
641
641
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
642
642
|
# * (`nil`) indicating no credentials
|
643
|
+
#
|
644
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
645
|
+
# external source for authentication to Google Cloud, you must validate it before
|
646
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
647
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
648
|
+
# For more information, refer to [Validate credential configurations from external
|
649
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
643
650
|
# @return [::Object]
|
644
651
|
# @!attribute [rw] scope
|
645
652
|
# The OAuth scopes
|
@@ -245,10 +245,16 @@ module Google
|
|
245
245
|
#
|
246
246
|
# @param inline_document [::Google::Cloud::DocumentAI::V1beta3::Document, ::Hash]
|
247
247
|
# An inline document proto.
|
248
|
+
#
|
249
|
+
# Note: The following fields are mutually exclusive: `inline_document`, `raw_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
248
250
|
# @param raw_document [::Google::Cloud::DocumentAI::V1beta3::RawDocument, ::Hash]
|
249
251
|
# A raw document content (bytes).
|
252
|
+
#
|
253
|
+
# Note: The following fields are mutually exclusive: `raw_document`, `inline_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
250
254
|
# @param gcs_document [::Google::Cloud::DocumentAI::V1beta3::GcsDocument, ::Hash]
|
251
255
|
# A raw document on Google Cloud Storage.
|
256
|
+
#
|
257
|
+
# Note: The following fields are mutually exclusive: `gcs_document`, `inline_document`, `raw_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
252
258
|
# @param name [::String]
|
253
259
|
# Required. The resource name of the
|
254
260
|
# {::Google::Cloud::DocumentAI::V1beta3::Processor Processor} or
|
@@ -901,8 +907,12 @@ module Google
|
|
901
907
|
#
|
902
908
|
# @param custom_document_extraction_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions, ::Hash]
|
903
909
|
# Options to control Custom Document Extraction (CDE) Processor.
|
910
|
+
#
|
911
|
+
# Note: The following fields are mutually exclusive: `custom_document_extraction_options`, `foundation_model_tuning_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
904
912
|
# @param foundation_model_tuning_options [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions, ::Hash]
|
905
913
|
# Options to control foundation model tuning of a processor.
|
914
|
+
#
|
915
|
+
# Note: The following fields are mutually exclusive: `foundation_model_tuning_options`, `custom_document_extraction_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
906
916
|
# @param parent [::String]
|
907
917
|
# Required. The parent (project, location and processor) to create the new
|
908
918
|
# version for. Format:
|
@@ -2261,9 +2271,13 @@ module Google
|
|
2261
2271
|
# and destination processor need to be in the same environment and region.
|
2262
2272
|
# Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not
|
2263
2273
|
# supported.
|
2274
|
+
#
|
2275
|
+
# Note: The following fields are mutually exclusive: `processor_version_source`, `external_processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
2264
2276
|
# @param external_processor_version_source [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource, ::Hash]
|
2265
2277
|
# The source processor version to import from. It can be from a different
|
2266
2278
|
# environment and region than the destination processor.
|
2279
|
+
#
|
2280
|
+
# Note: The following fields are mutually exclusive: `external_processor_version_source`, `processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
2267
2281
|
# @param parent [::String]
|
2268
2282
|
# Required. The destination processor name to create the processor version
|
2269
2283
|
# in. Format:
|
@@ -2377,6 +2391,13 @@ module Google
|
|
2377
2391
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
2378
2392
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
2379
2393
|
# * (`nil`) indicating no credentials
|
2394
|
+
#
|
2395
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
2396
|
+
# external source for authentication to Google Cloud, you must validate it before
|
2397
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
2398
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
2399
|
+
# For more information, refer to [Validate credential configurations from external
|
2400
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
2380
2401
|
# @return [::Object]
|
2381
2402
|
# @!attribute [rw] scope
|
2382
2403
|
# The OAuth scopes
|
@@ -502,6 +502,13 @@ module Google
|
|
502
502
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
503
503
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
504
504
|
# * (`nil`) indicating no credentials
|
505
|
+
#
|
506
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
507
|
+
# external source for authentication to Google Cloud, you must validate it before
|
508
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
509
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
510
|
+
# For more information, refer to [Validate credential configurations from external
|
511
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
505
512
|
# @return [::Object]
|
506
513
|
# @!attribute [rw] scope
|
507
514
|
# The OAuth scopes
|
@@ -971,6 +971,13 @@ module Google
|
|
971
971
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
972
972
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
973
973
|
# * (`nil`) indicating no credentials
|
974
|
+
#
|
975
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
976
|
+
# external source for authentication to Google Cloud, you must validate it before
|
977
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
978
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
979
|
+
# For more information, refer to [Validate credential configurations from external
|
980
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
974
981
|
# @return [::Object]
|
975
982
|
# @!attribute [rw] scope
|
976
983
|
# The OAuth scopes
|
@@ -640,6 +640,13 @@ module Google
|
|
640
640
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
641
641
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
642
642
|
# * (`nil`) indicating no credentials
|
643
|
+
#
|
644
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
645
|
+
# external source for authentication to Google Cloud, you must validate it before
|
646
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
647
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
648
|
+
# For more information, refer to [Validate credential configurations from external
|
649
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
643
650
|
# @return [::Object]
|
644
651
|
# @!attribute [rw] scope
|
645
652
|
# The OAuth scopes
|
@@ -914,6 +914,13 @@ module Google
|
|
914
914
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
915
915
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
916
916
|
# * (`nil`) indicating no credentials
|
917
|
+
#
|
918
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
919
|
+
# external source for authentication to Google Cloud, you must validate it before
|
920
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
921
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
922
|
+
# For more information, refer to [Validate credential configurations from external
|
923
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
917
924
|
# @return [::Object]
|
918
925
|
# @!attribute [rw] scope
|
919
926
|
# The OAuth scopes
|
@@ -502,6 +502,13 @@ module Google
|
|
502
502
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
503
503
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
504
504
|
# * (`nil`) indicating no credentials
|
505
|
+
#
|
506
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
507
|
+
# external source for authentication to Google Cloud, you must validate it before
|
508
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
509
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
510
|
+
# For more information, refer to [Validate credential configurations from external
|
511
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
505
512
|
# @return [::Object]
|
506
513
|
# @!attribute [rw] scope
|
507
514
|
# The OAuth scopes
|
@@ -29,16 +29,22 @@ module Google
|
|
29
29
|
# Optional. User-managed Cloud Storage dataset configuration. Use this
|
30
30
|
# configuration if the dataset documents are stored under a user-managed
|
31
31
|
# Cloud Storage location.
|
32
|
+
#
|
33
|
+
# Note: The following fields are mutually exclusive: `gcs_managed_config`, `document_warehouse_config`, `unmanaged_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
32
34
|
# @!attribute [rw] document_warehouse_config
|
33
35
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
34
36
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Dataset::DocumentWarehouseConfig]
|
35
37
|
# Optional. Deprecated. Warehouse-based dataset configuration is not
|
36
38
|
# supported.
|
39
|
+
#
|
40
|
+
# Note: The following fields are mutually exclusive: `document_warehouse_config`, `gcs_managed_config`, `unmanaged_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
37
41
|
# @!attribute [rw] unmanaged_dataset_config
|
38
42
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Dataset::UnmanagedDatasetConfig]
|
39
43
|
# Optional. Unmanaged dataset configuration. Use this configuration if the
|
40
44
|
# dataset documents are managed by the document service internally (not
|
41
45
|
# user-managed).
|
46
|
+
#
|
47
|
+
# Note: The following fields are mutually exclusive: `unmanaged_dataset_config`, `gcs_managed_config`, `document_warehouse_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
42
48
|
# @!attribute [rw] spanner_indexing_config
|
43
49
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Dataset::SpannerIndexingConfig]
|
44
50
|
# Optional. A lightweight indexing source with low latency and high
|
@@ -118,9 +124,13 @@ module Google
|
|
118
124
|
# @!attribute [rw] gcs_managed_doc_id
|
119
125
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId::GCSManagedDocumentId]
|
120
126
|
# A document id within user-managed Cloud Storage.
|
127
|
+
#
|
128
|
+
# Note: The following fields are mutually exclusive: `gcs_managed_doc_id`, `unmanaged_doc_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
121
129
|
# @!attribute [rw] unmanaged_doc_id
|
122
130
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId::UnmanagedDocumentId]
|
123
131
|
# A document id within unmanaged dataset.
|
132
|
+
#
|
133
|
+
# Note: The following fields are mutually exclusive: `unmanaged_doc_id`, `gcs_managed_doc_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
124
134
|
# @!attribute [rw] revision_ref
|
125
135
|
# @return [::Google::Cloud::DocumentAI::V1beta3::RevisionRef]
|
126
136
|
# Points to a specific revision of the document if set.
|
@@ -177,11 +187,15 @@ module Google
|
|
177
187
|
# @!attribute [rw] individual_document_ids
|
178
188
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments::IndividualDocumentIds]
|
179
189
|
# Document identifiers.
|
190
|
+
#
|
191
|
+
# Note: The following fields are mutually exclusive: `individual_document_ids`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
180
192
|
# @!attribute [rw] filter
|
181
193
|
# @return [::String]
|
182
194
|
# A filter matching the documents.
|
183
195
|
# Follows the same format and restriction as
|
184
196
|
# [google.cloud.documentai.master.ListDocumentsRequest.filter].
|
197
|
+
#
|
198
|
+
# Note: The following fields are mutually exclusive: `filter`, `individual_document_ids`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
185
199
|
class BatchDatasetDocuments
|
186
200
|
include ::Google::Protobuf::MessageExts
|
187
201
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -31,11 +31,15 @@ module Google
|
|
31
31
|
# `gs://bucket_name/object_name`. Object versioning is not supported.
|
32
32
|
# For more information, refer to [Google Cloud Storage Request
|
33
33
|
# URIs](https://cloud.google.com/storage/docs/reference-uris).
|
34
|
+
#
|
35
|
+
# Note: The following fields are mutually exclusive: `uri`, `content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
34
36
|
# @!attribute [rw] content
|
35
37
|
# @return [::String]
|
36
38
|
# Optional. Inline document content, represented as a stream of bytes.
|
37
39
|
# Note: As with all `bytes` fields, protobuffers use a pure binary
|
38
40
|
# representation, whereas JSON representations use base64.
|
41
|
+
#
|
42
|
+
# Note: The following fields are mutually exclusive: `content`, `uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
39
43
|
# @!attribute [rw] mime_type
|
40
44
|
# @return [::String]
|
41
45
|
# An IANA published [media type (MIME
|
@@ -731,28 +735,42 @@ module Google
|
|
731
735
|
# @return [::Google::Type::Money]
|
732
736
|
# Money value. See also:
|
733
737
|
# https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
|
738
|
+
#
|
739
|
+
# Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
734
740
|
# @!attribute [rw] date_value
|
735
741
|
# @return [::Google::Type::Date]
|
736
742
|
# Date value. Includes year, month, day. See also:
|
737
743
|
# https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
|
744
|
+
#
|
745
|
+
# Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
738
746
|
# @!attribute [rw] datetime_value
|
739
747
|
# @return [::Google::Type::DateTime]
|
740
748
|
# DateTime value. Includes date, time, and timezone. See also:
|
741
749
|
# https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
|
750
|
+
#
|
751
|
+
# Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
742
752
|
# @!attribute [rw] address_value
|
743
753
|
# @return [::Google::Type::PostalAddress]
|
744
754
|
# Postal address. See also:
|
745
755
|
# https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
|
756
|
+
#
|
757
|
+
# Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
746
758
|
# @!attribute [rw] boolean_value
|
747
759
|
# @return [::Boolean]
|
748
760
|
# Boolean value. Can be used for entities with binary values, or for
|
749
761
|
# checkboxes.
|
762
|
+
#
|
763
|
+
# Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
750
764
|
# @!attribute [rw] integer_value
|
751
765
|
# @return [::Integer]
|
752
766
|
# Integer value.
|
767
|
+
#
|
768
|
+
# Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
753
769
|
# @!attribute [rw] float_value
|
754
770
|
# @return [::Float]
|
755
771
|
# Float value.
|
772
|
+
#
|
773
|
+
# Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
756
774
|
# @!attribute [rw] text
|
757
775
|
# @return [::String]
|
758
776
|
# Optional. An optional field to store a normalized string.
|
@@ -988,10 +1006,14 @@ module Google
|
|
988
1006
|
# @return [::String]
|
989
1007
|
# If the change was made by a person specify the name or id of that
|
990
1008
|
# person.
|
1009
|
+
#
|
1010
|
+
# Note: The following fields are mutually exclusive: `agent`, `processor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
991
1011
|
# @!attribute [rw] processor
|
992
1012
|
# @return [::String]
|
993
1013
|
# If the annotation was made by processor identify the processor by its
|
994
1014
|
# resource name.
|
1015
|
+
#
|
1016
|
+
# Note: The following fields are mutually exclusive: `processor`, `agent`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
995
1017
|
# @!attribute [rw] id
|
996
1018
|
# @return [::String]
|
997
1019
|
# Id of the revision, internally generated by doc proto storage.
|
@@ -1067,12 +1089,18 @@ module Google
|
|
1067
1089
|
# @!attribute [rw] text_block
|
1068
1090
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout::DocumentLayoutBlock::LayoutTextBlock]
|
1069
1091
|
# Block consisting of text content.
|
1092
|
+
#
|
1093
|
+
# Note: The following fields are mutually exclusive: `text_block`, `table_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1070
1094
|
# @!attribute [rw] table_block
|
1071
1095
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout::DocumentLayoutBlock::LayoutTableBlock]
|
1072
1096
|
# Block consisting of table content/structure.
|
1097
|
+
#
|
1098
|
+
# Note: The following fields are mutually exclusive: `table_block`, `text_block`, `list_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1073
1099
|
# @!attribute [rw] list_block
|
1074
1100
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout::DocumentLayoutBlock::LayoutListBlock]
|
1075
1101
|
# Block consisting of list content/structure.
|
1102
|
+
#
|
1103
|
+
# Note: The following fields are mutually exclusive: `list_block`, `text_block`, `table_block`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1076
1104
|
# @!attribute [rw] block_id
|
1077
1105
|
# @return [::String]
|
1078
1106
|
# ID of the block.
|
@@ -1252,14 +1280,20 @@ module Google
|
|
1252
1280
|
# @!attribute [rw] revision_case
|
1253
1281
|
# @return [::Google::Cloud::DocumentAI::V1beta3::RevisionRef::RevisionCase]
|
1254
1282
|
# Reads the revision by the predefined case.
|
1283
|
+
#
|
1284
|
+
# Note: The following fields are mutually exclusive: `revision_case`, `revision_id`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1255
1285
|
# @!attribute [rw] revision_id
|
1256
1286
|
# @return [::String]
|
1257
1287
|
# Reads the revision given by the id.
|
1288
|
+
#
|
1289
|
+
# Note: The following fields are mutually exclusive: `revision_id`, `revision_case`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1258
1290
|
# @!attribute [rw] latest_processor_version
|
1259
1291
|
# @return [::String]
|
1260
1292
|
# Reads the revision generated by the processor version.
|
1261
1293
|
# The format takes the full resource name of processor version.
|
1262
1294
|
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
1295
|
+
#
|
1296
|
+
# Note: The following fields are mutually exclusive: `latest_processor_version`, `revision_case`, `revision_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1263
1297
|
class RevisionRef
|
1264
1298
|
include ::Google::Protobuf::MessageExts
|
1265
1299
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -75,9 +75,13 @@ module Google
|
|
75
75
|
# @!attribute [rw] gcs_prefix
|
76
76
|
# @return [::Google::Cloud::DocumentAI::V1beta3::GcsPrefix]
|
77
77
|
# The set of documents that match the specified Cloud Storage `gcs_prefix`.
|
78
|
+
#
|
79
|
+
# Note: The following fields are mutually exclusive: `gcs_prefix`, `gcs_documents`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
78
80
|
# @!attribute [rw] gcs_documents
|
79
81
|
# @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocuments]
|
80
82
|
# The set of documents individually specified on Cloud Storage.
|
83
|
+
#
|
84
|
+
# Note: The following fields are mutually exclusive: `gcs_documents`, `gcs_prefix`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
81
85
|
class BatchDocumentsInputConfig
|
82
86
|
include ::Google::Protobuf::MessageExts
|
83
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -25,13 +25,19 @@ module Google
|
|
25
25
|
# @!attribute [rw] individual_page_selector
|
26
26
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessOptions::IndividualPageSelector]
|
27
27
|
# Which pages to process (1-indexed).
|
28
|
+
#
|
29
|
+
# Note: The following fields are mutually exclusive: `individual_page_selector`, `from_start`, `from_end`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
28
30
|
# @!attribute [rw] from_start
|
29
31
|
# @return [::Integer]
|
30
32
|
# Only process certain pages from the start. Process all if the document
|
31
33
|
# has fewer pages.
|
34
|
+
#
|
35
|
+
# Note: The following fields are mutually exclusive: `from_start`, `individual_page_selector`, `from_end`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
32
36
|
# @!attribute [rw] from_end
|
33
37
|
# @return [::Integer]
|
34
38
|
# Only process certain pages from the end, same as above.
|
39
|
+
#
|
40
|
+
# Note: The following fields are mutually exclusive: `from_end`, `individual_page_selector`, `from_start`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
35
41
|
# @!attribute [rw] ocr_config
|
36
42
|
# @return [::Google::Cloud::DocumentAI::V1beta3::OcrConfig]
|
37
43
|
# Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`.
|
@@ -98,12 +104,18 @@ module Google
|
|
98
104
|
# @!attribute [rw] inline_document
|
99
105
|
# @return [::Google::Cloud::DocumentAI::V1beta3::Document]
|
100
106
|
# An inline document proto.
|
107
|
+
#
|
108
|
+
# Note: The following fields are mutually exclusive: `inline_document`, `raw_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
101
109
|
# @!attribute [rw] raw_document
|
102
110
|
# @return [::Google::Cloud::DocumentAI::V1beta3::RawDocument]
|
103
111
|
# A raw document content (bytes).
|
112
|
+
#
|
113
|
+
# Note: The following fields are mutually exclusive: `raw_document`, `inline_document`, `gcs_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
104
114
|
# @!attribute [rw] gcs_document
|
105
115
|
# @return [::Google::Cloud::DocumentAI::V1beta3::GcsDocument]
|
106
116
|
# A raw document on Google Cloud Storage.
|
117
|
+
#
|
118
|
+
# Note: The following fields are mutually exclusive: `gcs_document`, `inline_document`, `raw_document`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
107
119
|
# @!attribute [rw] name
|
108
120
|
# @return [::String]
|
109
121
|
# Required. The resource name of the
|
@@ -787,9 +799,13 @@ module Google
|
|
787
799
|
# @!attribute [rw] custom_document_extraction_options
|
788
800
|
# @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions]
|
789
801
|
# Options to control Custom Document Extraction (CDE) Processor.
|
802
|
+
#
|
803
|
+
# Note: The following fields are mutually exclusive: `custom_document_extraction_options`, `foundation_model_tuning_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
790
804
|
# @!attribute [rw] foundation_model_tuning_options
|
791
805
|
# @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions]
|
792
806
|
# Options to control foundation model tuning of a processor.
|
807
|
+
#
|
808
|
+
# Note: The following fields are mutually exclusive: `foundation_model_tuning_options`, `custom_document_extraction_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
793
809
|
# @!attribute [rw] parent
|
794
810
|
# @return [::String]
|
795
811
|
# Required. The parent (project, location and processor) to create the new
|
@@ -1137,10 +1153,14 @@ module Google
|
|
1137
1153
|
# and destination processor need to be in the same environment and region.
|
1138
1154
|
# Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not
|
1139
1155
|
# supported.
|
1156
|
+
#
|
1157
|
+
# Note: The following fields are mutually exclusive: `processor_version_source`, `external_processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1140
1158
|
# @!attribute [rw] external_processor_version_source
|
1141
1159
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource]
|
1142
1160
|
# The source processor version to import from. It can be from a different
|
1143
1161
|
# environment and region than the destination processor.
|
1162
|
+
#
|
1163
|
+
# Note: The following fields are mutually exclusive: `external_processor_version_source`, `processor_version_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1144
1164
|
# @!attribute [rw] parent
|
1145
1165
|
# @return [::String]
|
1146
1166
|
# Required. The destination processor name to create the processor version
|
@@ -59,10 +59,14 @@ module Google
|
|
59
59
|
# @!attribute [rw] dataset_split
|
60
60
|
# @return [::Google::Cloud::DocumentAI::V1beta3::DatasetSplitType]
|
61
61
|
# Target dataset split where the documents must be stored.
|
62
|
+
#
|
63
|
+
# Note: The following fields are mutually exclusive: `dataset_split`, `auto_split_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
62
64
|
# @!attribute [rw] auto_split_config
|
63
65
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest::BatchDocumentsImportConfig::AutoSplitConfig]
|
64
66
|
# If set, documents will be automatically split into training and test
|
65
67
|
# split category with the specified ratio.
|
68
|
+
#
|
69
|
+
# Note: The following fields are mutually exclusive: `auto_split_config`, `dataset_split`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
66
70
|
# @!attribute [rw] batch_input_config
|
67
71
|
# @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
|
68
72
|
# The common config to specify a set of documents used as input.
|
@@ -90,9 +90,13 @@ module Google
|
|
90
90
|
# @!attribute [rw] foundation_gen_ai_model_info
|
91
91
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
|
92
92
|
# Information for a pretrained Google-managed foundation model.
|
93
|
+
#
|
94
|
+
# Note: The following fields are mutually exclusive: `foundation_gen_ai_model_info`, `custom_gen_ai_model_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
93
95
|
# @!attribute [rw] custom_gen_ai_model_info
|
94
96
|
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
|
95
97
|
# Information for a custom Generative AI model created by the user.
|
98
|
+
#
|
99
|
+
# Note: The following fields are mutually exclusive: `custom_gen_ai_model_info`, `foundation_gen_ai_model_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
96
100
|
class GenAiModelInfo
|
97
101
|
include ::Google::Protobuf::MessageExts
|
98
102
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -40,6 +40,8 @@ module Google
|
|
40
40
|
# @!attribute [rw] error
|
41
41
|
# @return [::Google::Rpc::Status]
|
42
42
|
# The error result of the operation in case of failure or cancellation.
|
43
|
+
#
|
44
|
+
# Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
43
45
|
# @!attribute [rw] response
|
44
46
|
# @return [::Google::Protobuf::Any]
|
45
47
|
# The normal, successful response of the operation. If the original
|
@@ -50,6 +52,8 @@ module Google
|
|
50
52
|
# is the original method name. For example, if the original method name
|
51
53
|
# is `TakeSnapshot()`, the inferred response type is
|
52
54
|
# `TakeSnapshotResponse`.
|
55
|
+
#
|
56
|
+
# Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
53
57
|
class Operation
|
54
58
|
include ::Google::Protobuf::MessageExts
|
55
59
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -75,9 +75,13 @@ module Google
|
|
75
75
|
# UTC offset. Must be whole seconds, between -18 hours and +18 hours.
|
76
76
|
# For example, a UTC offset of -4:00 would be represented as
|
77
77
|
# { seconds: -14400 }.
|
78
|
+
#
|
79
|
+
# Note: The following fields are mutually exclusive: `utc_offset`, `time_zone`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
78
80
|
# @!attribute [rw] time_zone
|
79
81
|
# @return [::Google::Type::TimeZone]
|
80
82
|
# Time zone.
|
83
|
+
#
|
84
|
+
# Note: The following fields are mutually exclusive: `time_zone`, `utc_offset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
81
85
|
class DateTime
|
82
86
|
include ::Google::Protobuf::MessageExts
|
83
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-document_ai-v1beta3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.39.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-01-29 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: gapic-common
|
@@ -16,7 +15,7 @@ dependencies:
|
|
16
15
|
requirements:
|
17
16
|
- - ">="
|
18
17
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
18
|
+
version: 0.25.0
|
20
19
|
- - "<"
|
21
20
|
- !ruby/object:Gem::Version
|
22
21
|
version: 2.a
|
@@ -26,7 +25,7 @@ dependencies:
|
|
26
25
|
requirements:
|
27
26
|
- - ">="
|
28
27
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
28
|
+
version: 0.25.0
|
30
29
|
- - "<"
|
31
30
|
- !ruby/object:Gem::Version
|
32
31
|
version: 2.a
|
@@ -149,7 +148,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
|
|
149
148
|
licenses:
|
150
149
|
- Apache-2.0
|
151
150
|
metadata: {}
|
152
|
-
post_install_message:
|
153
151
|
rdoc_options: []
|
154
152
|
require_paths:
|
155
153
|
- lib
|
@@ -157,15 +155,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
157
155
|
requirements:
|
158
156
|
- - ">="
|
159
157
|
- !ruby/object:Gem::Version
|
160
|
-
version: '
|
158
|
+
version: '3.0'
|
161
159
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
162
160
|
requirements:
|
163
161
|
- - ">="
|
164
162
|
- !ruby/object:Gem::Version
|
165
163
|
version: '0'
|
166
164
|
requirements: []
|
167
|
-
rubygems_version: 3.
|
168
|
-
signing_key:
|
165
|
+
rubygems_version: 3.6.2
|
169
166
|
specification_version: 4
|
170
167
|
summary: Service to parse structured information from unstructured or semi-structured
|
171
168
|
documents using state-of-the-art Google AI such as natural language, computer vision,
|