google-apis-documentai_v1 0.22.0 → 0.23.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/CHANGELOG.md +5 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/documentai_v1/classes.rb +23 -37
- data/lib/google/apis/documentai_v1/gem_version.rb +2 -2
- data/lib/google/apis/documentai_v1/service.rb +21 -20
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 358880430803ef26497a94317660017acfd74fc45e1f8be76ff8f80d3c109087
|
4
|
+
data.tar.gz: 2dba20e265eca1fe053474f2fdc0fd88f65c770e6ac4956c0f0fb822b33e1fba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fbb1519a16624d805c1cc7406f50b3d7d5e3dea8a519cb7ff54f3470fd8dac2ad24dffb4530ea808bd9e48ab140a1285d13e4765a1c2b5e52ab13efadcc81146
|
7
|
+
data.tar.gz: dbd2850c50b28459d14384ec4194213ee795d1408cd6178333d4e1e7a30462d9dc5d9785d4dd28aa9adeca995375d7458e5e78ff99f73952dd754e246c217a03
|
data/CHANGELOG.md
CHANGED
data/OVERVIEW.md
CHANGED
@@ -51,7 +51,7 @@ require "google/apis/documentai_v1"
|
|
51
51
|
client = Google::Apis::DocumentaiV1::DocumentService.new
|
52
52
|
|
53
53
|
# Authenticate calls
|
54
|
-
client.
|
54
|
+
client.authorization = # ... use the googleauth gem to create credentials
|
55
55
|
```
|
56
56
|
|
57
57
|
See the class reference docs for information on the methods you can call from a client.
|
@@ -881,7 +881,7 @@ module Google
|
|
881
881
|
# @return [String]
|
882
882
|
attr_accessor :input_gcs_source
|
883
883
|
|
884
|
-
# The output_gcs_destination (in the request as
|
884
|
+
# The output_gcs_destination (in the request as `output_gcs_destination`) of the
|
885
885
|
# processed document if it was successful, otherwise empty.
|
886
886
|
# Corresponds to the JSON property `outputGcsDestination`
|
887
887
|
# @return [String]
|
@@ -1259,7 +1259,7 @@ module Google
|
|
1259
1259
|
end
|
1260
1260
|
end
|
1261
1261
|
|
1262
|
-
# An entity that could be a phrase in the text or a property belongs to the
|
1262
|
+
# An entity that could be a phrase in the text or a property that belongs to the
|
1263
1263
|
# document. It is a known entity type, such as a person, an organization, or
|
1264
1264
|
# location.
|
1265
1265
|
class GoogleCloudDocumentaiV1DocumentEntity
|
@@ -1417,8 +1417,8 @@ module Google
|
|
1417
1417
|
attr_accessor :money_value
|
1418
1418
|
|
1419
1419
|
# Optional. An optional field to store a normalized string. For some entity
|
1420
|
-
# types, one of respective
|
1421
|
-
# not all the types of
|
1420
|
+
# types, one of respective `structured_value` fields may also be populated. Also
|
1421
|
+
# not all the types of `structured_value` will be normalized. For example, some
|
1422
1422
|
# processors may not generate float or int normalized text by default. Below are
|
1423
1423
|
# sample formats mapped to structured values. - Money/Currency type (`
|
1424
1424
|
# money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
|
@@ -2259,7 +2259,7 @@ module Google
|
|
2259
2259
|
attr_accessor :id
|
2260
2260
|
|
2261
2261
|
# The index of the parent item in the corresponding item list (eg. list of
|
2262
|
-
# entities, properties within entities, etc.)
|
2262
|
+
# entities, properties within entities, etc.) in the parent revision.
|
2263
2263
|
# Corresponds to the JSON property `index`
|
2264
2264
|
# @return [Fixnum]
|
2265
2265
|
attr_accessor :index
|
@@ -2958,7 +2958,7 @@ module Google
|
|
2958
2958
|
end
|
2959
2959
|
end
|
2960
2960
|
|
2961
|
-
# The first-class citizen for
|
2961
|
+
# The first-class citizen for Document AI. Each processor defines how to extract
|
2962
2962
|
# structural information from a document.
|
2963
2963
|
class GoogleCloudDocumentaiV1Processor
|
2964
2964
|
include Google::Apis::Core::Hashable
|
@@ -2984,8 +2984,8 @@ module Google
|
|
2984
2984
|
# @return [String]
|
2985
2985
|
attr_accessor :kms_key_name
|
2986
2986
|
|
2987
|
-
# Output only. Immutable. The resource name of the processor. Format: projects/`
|
2988
|
-
# project`/locations/`location`/processors/`processor
|
2987
|
+
# Output only. Immutable. The resource name of the processor. Format: `projects/`
|
2988
|
+
# project`/locations/`location`/processors/`processor``
|
2989
2989
|
# Corresponds to the JSON property `name`
|
2990
2990
|
# @return [String]
|
2991
2991
|
attr_accessor :name
|
@@ -3024,26 +3024,12 @@ module Google
|
|
3024
3024
|
end
|
3025
3025
|
|
3026
3026
|
# A processor type is responsible for performing a certain document
|
3027
|
-
# understanding task on a certain type of document.
|
3028
|
-
# created by the documentai service internally. User will only list all
|
3029
|
-
# available processor types via UI. For different users (projects), the
|
3030
|
-
# available processor types may be different since we'll expose the access of
|
3031
|
-
# some types via EAP whitelisting. We make the ProcessorType a resource under
|
3032
|
-
# location so we have a unified API and keep the possibility that UI will load
|
3033
|
-
# different available processor types from different regions. But for alpha the
|
3034
|
-
# behavior is that the user will always get the union of all available processor
|
3035
|
-
# types among all regions no matter which regionalized endpoint is called, and
|
3036
|
-
# then we use the 'available_locations' field to show under which regions a
|
3037
|
-
# processor type is available. For example, users can call either the 'US' or '
|
3038
|
-
# EU' endpoint to feach processor types. In the return, we will have an 'invoice
|
3039
|
-
# parsing' processor with 'available_locations' field only containing 'US'. So
|
3040
|
-
# the user can try to create an 'invoice parsing' processor under the location '
|
3041
|
-
# US'. Such attempt of creating under the location 'EU' will fail. Next ID: 9.
|
3027
|
+
# understanding task on a certain type of document.
|
3042
3028
|
class GoogleCloudDocumentaiV1ProcessorType
|
3043
3029
|
include Google::Apis::Core::Hashable
|
3044
3030
|
|
3045
|
-
# Whether the processor type allows creation. If
|
3046
|
-
# processor of this processor type. Otherwise,
|
3031
|
+
# Whether the processor type allows creation. If true, users can create a
|
3032
|
+
# processor of this processor type. Otherwise, users need to request access.
|
3047
3033
|
# Corresponds to the JSON property `allowCreation`
|
3048
3034
|
# @return [Boolean]
|
3049
3035
|
attr_accessor :allow_creation
|
@@ -3127,9 +3113,9 @@ module Google
|
|
3127
3113
|
# @return [String]
|
3128
3114
|
attr_accessor :display_name
|
3129
3115
|
|
3130
|
-
# The resource name of the processor version. Format: projects/`project`/
|
3116
|
+
# The resource name of the processor version. Format: `projects/`project`/
|
3131
3117
|
# locations/`location`/processors/`processor`/processorVersions/`
|
3132
|
-
# processor_version
|
3118
|
+
# processor_version``
|
3133
3119
|
# Corresponds to the JSON property `name`
|
3134
3120
|
# @return [String]
|
3135
3121
|
attr_accessor :name
|
@@ -3197,7 +3183,7 @@ module Google
|
|
3197
3183
|
end
|
3198
3184
|
end
|
3199
3185
|
|
3200
|
-
# Request message for review document method.
|
3186
|
+
# Request message for review document method.
|
3201
3187
|
class GoogleCloudDocumentaiV1ReviewDocumentRequest
|
3202
3188
|
include Google::Apis::Core::Hashable
|
3203
3189
|
|
@@ -3523,7 +3509,7 @@ module Google
|
|
3523
3509
|
end
|
3524
3510
|
end
|
3525
3511
|
|
3526
|
-
# An entity that could be a phrase in the text or a property belongs to the
|
3512
|
+
# An entity that could be a phrase in the text or a property that belongs to the
|
3527
3513
|
# document. It is a known entity type, such as a person, an organization, or
|
3528
3514
|
# location.
|
3529
3515
|
class GoogleCloudDocumentaiV1beta1DocumentEntity
|
@@ -3681,8 +3667,8 @@ module Google
|
|
3681
3667
|
attr_accessor :money_value
|
3682
3668
|
|
3683
3669
|
# Optional. An optional field to store a normalized string. For some entity
|
3684
|
-
# types, one of respective
|
3685
|
-
# not all the types of
|
3670
|
+
# types, one of respective `structured_value` fields may also be populated. Also
|
3671
|
+
# not all the types of `structured_value` will be normalized. For example, some
|
3686
3672
|
# processors may not generate float or int normalized text by default. Below are
|
3687
3673
|
# sample formats mapped to structured values. - Money/Currency type (`
|
3688
3674
|
# money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
|
@@ -4484,7 +4470,7 @@ module Google
|
|
4484
4470
|
attr_accessor :id
|
4485
4471
|
|
4486
4472
|
# The index of the parent item in the corresponding item list (eg. list of
|
4487
|
-
# entities, properties within entities, etc.)
|
4473
|
+
# entities, properties within entities, etc.) in the parent revision.
|
4488
4474
|
# Corresponds to the JSON property `index`
|
4489
4475
|
# @return [Fixnum]
|
4490
4476
|
attr_accessor :index
|
@@ -5250,7 +5236,7 @@ module Google
|
|
5250
5236
|
end
|
5251
5237
|
end
|
5252
5238
|
|
5253
|
-
# An entity that could be a phrase in the text or a property belongs to the
|
5239
|
+
# An entity that could be a phrase in the text or a property that belongs to the
|
5254
5240
|
# document. It is a known entity type, such as a person, an organization, or
|
5255
5241
|
# location.
|
5256
5242
|
class GoogleCloudDocumentaiV1beta2DocumentEntity
|
@@ -5408,8 +5394,8 @@ module Google
|
|
5408
5394
|
attr_accessor :money_value
|
5409
5395
|
|
5410
5396
|
# Optional. An optional field to store a normalized string. For some entity
|
5411
|
-
# types, one of respective
|
5412
|
-
# not all the types of
|
5397
|
+
# types, one of respective `structured_value` fields may also be populated. Also
|
5398
|
+
# not all the types of `structured_value` will be normalized. For example, some
|
5413
5399
|
# processors may not generate float or int normalized text by default. Below are
|
5414
5400
|
# sample formats mapped to structured values. - Money/Currency type (`
|
5415
5401
|
# money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
|
@@ -6248,7 +6234,7 @@ module Google
|
|
6248
6234
|
attr_accessor :id
|
6249
6235
|
|
6250
6236
|
# The index of the parent item in the corresponding item list (eg. list of
|
6251
|
-
# entities, properties within entities, etc.)
|
6237
|
+
# entities, properties within entities, etc.) in the parent revision.
|
6252
6238
|
# Corresponds to the JSON property `index`
|
6253
6239
|
# @return [Fixnum]
|
6254
6240
|
attr_accessor :index
|
@@ -6937,7 +6923,7 @@ module Google
|
|
6937
6923
|
# @return [String]
|
6938
6924
|
attr_accessor :input_gcs_source
|
6939
6925
|
|
6940
|
-
# The output_gcs_destination (in the request as
|
6926
|
+
# The output_gcs_destination (in the request as `output_gcs_destination`) of the
|
6941
6927
|
# processed document if it was successful, otherwise empty.
|
6942
6928
|
# Corresponds to the JSON property `outputGcsDestination`
|
6943
6929
|
# @return [String]
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DocumentaiV1
|
18
18
|
# Version of the google-apis-documentai_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.23.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20211230"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -84,11 +84,12 @@ module Google
|
|
84
84
|
execute_or_queue_command(command, &block)
|
85
85
|
end
|
86
86
|
|
87
|
-
# Fetches processor types.
|
87
|
+
# Fetches processor types. Note that we do not use ListProcessorTypes here
|
88
|
+
# because it is not paginated.
|
88
89
|
# @param [String] parent
|
89
90
|
# Required. The project of processor type to list. The available processor types
|
90
|
-
# may depend on the
|
91
|
-
# locations/`location
|
91
|
+
# may depend on the allow-listing on projects. Format: `projects/`project`/
|
92
|
+
# locations/`location``
|
92
93
|
# @param [String] fields
|
93
94
|
# Selector specifying which fields to include in a partial response.
|
94
95
|
# @param [String] quota_user
|
@@ -306,10 +307,10 @@ module Google
|
|
306
307
|
# LRO endpoint to batch process many documents. The output is written to Cloud
|
307
308
|
# Storage as JSON in the [Document] format.
|
308
309
|
# @param [String] name
|
309
|
-
# Required. The resource name of Processor or ProcessorVersion. Format:
|
310
|
-
#
|
311
|
-
# locations/`location`/processors/`processor`/processorVersions/`
|
312
|
-
# processorVersion
|
310
|
+
# Required. The resource name of Processor or ProcessorVersion. Format: `
|
311
|
+
# projects/`project`/locations/`location`/processors/`processor``, or `projects/`
|
312
|
+
# project`/locations/`location`/processors/`processor`/processorVersions/`
|
313
|
+
# processorVersion``
|
313
314
|
# @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchProcessRequest] google_cloud_documentai_v1_batch_process_request_object
|
314
315
|
# @param [String] fields
|
315
316
|
# Selector specifying which fields to include in a partial response.
|
@@ -344,7 +345,7 @@ module Google
|
|
344
345
|
# will be at "ENABLED" state by default after its creation.
|
345
346
|
# @param [String] parent
|
346
347
|
# Required. The parent (project and location) under which to create the
|
347
|
-
# processor. Format: projects/`project`/locations/`location
|
348
|
+
# processor. Format: `projects/`project`/locations/`location``
|
348
349
|
# @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Processor] google_cloud_documentai_v1_processor_object
|
349
350
|
# @param [String] fields
|
350
351
|
# Selector specifying which fields to include in a partial response.
|
@@ -505,7 +506,7 @@ module Google
|
|
505
506
|
# Lists all processors which belong to this project.
|
506
507
|
# @param [String] parent
|
507
508
|
# Required. The parent (project and location) which owns this collection of
|
508
|
-
# Processors. Format: projects/`project`/locations/`location
|
509
|
+
# Processors. Format: `projects/`project`/locations/`location``
|
509
510
|
# @param [Fixnum] page_size
|
510
511
|
# The maximum number of processors to return. If unspecified, at most 50
|
511
512
|
# processors will be returned. The maximum value is 100; values above 100 will
|
@@ -546,9 +547,9 @@ module Google
|
|
546
547
|
# @param [String] name
|
547
548
|
# Required. The resource name of the Processor or ProcessorVersion to use for
|
548
549
|
# processing. If a Processor is specified, the server will use its default
|
549
|
-
# version. Format: projects/`project`/locations/`location`/processors/`
|
550
|
-
#
|
551
|
-
# processorVersions/`processorVersion
|
550
|
+
# version. Format: `projects/`project`/locations/`location`/processors/`
|
551
|
+
# processor``, or `projects/`project`/locations/`location`/processors/`processor`
|
552
|
+
# /processorVersions/`processorVersion``
|
552
553
|
# @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessRequest] google_cloud_documentai_v1_process_request_object
|
553
554
|
# @param [String] fields
|
554
555
|
# Selector specifying which fields to include in a partial response.
|
@@ -651,10 +652,10 @@ module Google
|
|
651
652
|
# LRO endpoint to batch process many documents. The output is written to Cloud
|
652
653
|
# Storage as JSON in the [Document] format.
|
653
654
|
# @param [String] name
|
654
|
-
# Required. The resource name of Processor or ProcessorVersion. Format:
|
655
|
-
#
|
656
|
-
# locations/`location`/processors/`processor`/processorVersions/`
|
657
|
-
# processorVersion
|
655
|
+
# Required. The resource name of Processor or ProcessorVersion. Format: `
|
656
|
+
# projects/`project`/locations/`location`/processors/`processor``, or `projects/`
|
657
|
+
# project`/locations/`location`/processors/`processor`/processorVersions/`
|
658
|
+
# processorVersion``
|
658
659
|
# @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchProcessRequest] google_cloud_documentai_v1_batch_process_request_object
|
659
660
|
# @param [String] fields
|
660
661
|
# Selector specifying which fields to include in a partial response.
|
@@ -782,7 +783,7 @@ module Google
|
|
782
783
|
# Lists all versions of a processor.
|
783
784
|
# @param [String] parent
|
784
785
|
# Required. The parent (project, location and processor) to list all versions.
|
785
|
-
# Format: projects/`project`/locations/`location`/processors/`processor
|
786
|
+
# Format: `projects/`project`/locations/`location`/processors/`processor``
|
786
787
|
# @param [Fixnum] page_size
|
787
788
|
# The maximum number of processor versions to return. If unspecified, at most 10
|
788
789
|
# processor versions will be returned. The maximum value is 20; values above 20
|
@@ -823,9 +824,9 @@ module Google
|
|
823
824
|
# @param [String] name
|
824
825
|
# Required. The resource name of the Processor or ProcessorVersion to use for
|
825
826
|
# processing. If a Processor is specified, the server will use its default
|
826
|
-
# version. Format: projects/`project`/locations/`location`/processors/`
|
827
|
-
#
|
828
|
-
# processorVersions/`processorVersion
|
827
|
+
# version. Format: `projects/`project`/locations/`location`/processors/`
|
828
|
+
# processor``, or `projects/`project`/locations/`location`/processors/`processor`
|
829
|
+
# /processorVersions/`processorVersion``
|
829
830
|
# @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessRequest] google_cloud_documentai_v1_process_request_object
|
830
831
|
# @param [String] fields
|
831
832
|
# Selector specifying which fields to include in a partial response.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-documentai_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.23.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:
|
11
|
+
date: 2022-01-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.23.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
- !ruby/object:Gem::Version
|
76
76
|
version: '0'
|
77
77
|
requirements: []
|
78
|
-
rubygems_version: 3.
|
78
|
+
rubygems_version: 3.3.4
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Cloud Document AI API V1
|