google-cloud-document_ai-v1 0.16.0 → 0.17.1
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/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +39 -14
- data/lib/google/cloud/document_ai/v1/document_processor_service/operations.rb +28 -6
- data/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb +37 -9
- data/lib/google/cloud/document_ai/v1/document_processor_service/rest/operations.rb +33 -8
- data/lib/google/cloud/document_ai/v1/document_processor_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/document_ai/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/documentai/v1/document.rb +13 -0
- data/proto_docs/google/cloud/documentai/v1/document_io.rb +4 -3
- data/proto_docs/google/cloud/documentai/v1/document_schema.rb +8 -8
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c1d6af0080664d96d5902715661e34f209e19fefc2dd1c3835c6027856b3e9de
|
4
|
+
data.tar.gz: 5a165955338653309e3297b2179c3d49eda86955694d80dcd9a16c90d55a2bd1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: acf22d9cbebfd371495d2f616d551184e5908d2df2a8a987e518c20d60ed13fcd4e0cea1490c24192da662c1722dff9cb371c53b244b66cad8f7b50dfa48f295
|
7
|
+
data.tar.gz: d69515fe369a3107a8ba46c83f023b4168da99f9641270127639c0edfce6429dd26d0f34fa0ceda9245e04f4f0debb9a3fc0bdc235d4411e5b91343b95ab3bc9
|
data/AUTHENTICATION.md
CHANGED
@@ -1,151 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-cloud-document_ai-v1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-document_ai-v1 library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-cloud-document_ai-v1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
74
41
|
|
75
|
-
|
76
|
-
require "google/cloud/document_ai/v1"
|
77
|
-
|
78
|
-
ENV["DOCUMENT_AI_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
79
43
|
|
80
|
-
client
|
81
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
82
49
|
|
83
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
84
53
|
|
85
|
-
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
87
55
|
|
88
56
|
```ruby
|
89
57
|
require "google/cloud/document_ai/v1"
|
90
58
|
|
91
59
|
client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
|
92
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
93
61
|
end
|
94
62
|
```
|
95
63
|
|
96
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
97
65
|
|
98
66
|
```ruby
|
99
67
|
require "google/cloud/document_ai/v1"
|
100
68
|
|
101
69
|
::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
|
102
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
103
71
|
end
|
104
72
|
|
105
73
|
client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
|
106
74
|
```
|
107
75
|
|
108
|
-
###
|
76
|
+
### Environment Variables
|
109
77
|
|
110
|
-
|
111
|
-
|
112
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
113
82
|
|
114
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
115
87
|
|
116
|
-
|
117
|
-
|
118
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-document_ai-v1
|
93
|
+
checks for credentials are:
|
119
94
|
|
120
|
-
|
121
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
122
97
|
|
123
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/document_ai/v1"
|
124
100
|
|
125
|
-
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
127
|
-
connect to most services with google-cloud-document_ai-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
128
102
|
|
129
|
-
|
130
|
-
|
131
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
|
104
|
+
```
|
132
105
|
|
133
|
-
|
134
|
-
2. Create a new project or click on an existing project.
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
136
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
137
107
|
|
138
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
139
111
|
|
140
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
141
113
|
|
142
|
-
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
144
115
|
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
149
120
|
|
150
|
-
|
151
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -34,6 +34,9 @@ module Google
|
|
34
34
|
# structured information from unstructured or semi-structured documents.
|
35
35
|
#
|
36
36
|
class Client
|
37
|
+
# @private
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
|
39
|
+
|
37
40
|
include Paths
|
38
41
|
|
39
42
|
# @private
|
@@ -109,6 +112,15 @@ module Google
|
|
109
112
|
@config
|
110
113
|
end
|
111
114
|
|
115
|
+
##
|
116
|
+
# The effective universe domain
|
117
|
+
#
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
def universe_domain
|
121
|
+
@document_processor_service_stub.universe_domain
|
122
|
+
end
|
123
|
+
|
112
124
|
##
|
113
125
|
# Create a new DocumentProcessorService client object.
|
114
126
|
#
|
@@ -142,8 +154,9 @@ module Google
|
|
142
154
|
credentials = @config.credentials
|
143
155
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
144
156
|
# but only if the default endpoint does not have a region prefix.
|
145
|
-
enable_self_signed_jwt = @config.endpoint
|
146
|
-
|
157
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
158
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
159
|
+
!@config.endpoint.split(".").first.include?("-"))
|
147
160
|
credentials ||= Credentials.default scope: @config.scope,
|
148
161
|
enable_self_signed_jwt: enable_self_signed_jwt
|
149
162
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -156,22 +169,26 @@ module Google
|
|
156
169
|
config.credentials = credentials
|
157
170
|
config.quota_project = @quota_project_id
|
158
171
|
config.endpoint = @config.endpoint
|
159
|
-
|
160
|
-
|
161
|
-
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
162
|
-
config.credentials = credentials
|
163
|
-
config.quota_project = @quota_project_id
|
164
|
-
config.endpoint = @config.endpoint
|
172
|
+
config.universe_domain = @config.universe_domain
|
165
173
|
end
|
166
174
|
|
167
175
|
@document_processor_service_stub = ::Gapic::ServiceStub.new(
|
168
176
|
::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Stub,
|
169
|
-
credentials:
|
170
|
-
endpoint:
|
177
|
+
credentials: credentials,
|
178
|
+
endpoint: @config.endpoint,
|
179
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
180
|
+
universe_domain: @config.universe_domain,
|
171
181
|
channel_args: @config.channel_args,
|
172
182
|
interceptors: @config.interceptors,
|
173
183
|
channel_pool_config: @config.channel_pool
|
174
184
|
)
|
185
|
+
|
186
|
+
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
187
|
+
config.credentials = credentials
|
188
|
+
config.quota_project = @quota_project_id
|
189
|
+
config.endpoint = @document_processor_service_stub.endpoint
|
190
|
+
config.universe_domain = @document_processor_service_stub.universe_domain
|
191
|
+
end
|
175
192
|
end
|
176
193
|
|
177
194
|
##
|
@@ -2338,9 +2355,9 @@ module Google
|
|
2338
2355
|
# end
|
2339
2356
|
#
|
2340
2357
|
# @!attribute [rw] endpoint
|
2341
|
-
#
|
2342
|
-
#
|
2343
|
-
# @return [::String]
|
2358
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
2359
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
2360
|
+
# @return [::String,nil]
|
2344
2361
|
# @!attribute [rw] credentials
|
2345
2362
|
# Credentials to send with calls. You may provide any of the following types:
|
2346
2363
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -2386,13 +2403,20 @@ module Google
|
|
2386
2403
|
# @!attribute [rw] quota_project
|
2387
2404
|
# A separate project against which to charge quota.
|
2388
2405
|
# @return [::String]
|
2406
|
+
# @!attribute [rw] universe_domain
|
2407
|
+
# The universe domain within which to make requests. This determines the
|
2408
|
+
# default endpoint URL. The default value of nil uses the environment
|
2409
|
+
# universe (usually the default "googleapis.com" universe).
|
2410
|
+
# @return [::String,nil]
|
2389
2411
|
#
|
2390
2412
|
class Configuration
|
2391
2413
|
extend ::Gapic::Config
|
2392
2414
|
|
2415
|
+
# @private
|
2416
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
2393
2417
|
DEFAULT_ENDPOINT = "documentai.googleapis.com"
|
2394
2418
|
|
2395
|
-
config_attr :endpoint,
|
2419
|
+
config_attr :endpoint, nil, ::String, nil
|
2396
2420
|
config_attr :credentials, nil do |value|
|
2397
2421
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2398
2422
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -2407,6 +2431,7 @@ module Google
|
|
2407
2431
|
config_attr :metadata, nil, ::Hash, nil
|
2408
2432
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2409
2433
|
config_attr :quota_project, nil, ::String, nil
|
2434
|
+
config_attr :universe_domain, nil, ::String, nil
|
2410
2435
|
|
2411
2436
|
# @private
|
2412
2437
|
def initialize parent_config = nil
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module DocumentProcessorService
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
|
31
|
+
|
29
32
|
# @private
|
30
33
|
attr_reader :operations_stub
|
31
34
|
|
@@ -60,6 +63,15 @@ module Google
|
|
60
63
|
@config
|
61
64
|
end
|
62
65
|
|
66
|
+
##
|
67
|
+
# The effective universe domain
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
def universe_domain
|
72
|
+
@operations_stub.universe_domain
|
73
|
+
end
|
74
|
+
|
63
75
|
##
|
64
76
|
# Create a new Operations client object.
|
65
77
|
#
|
@@ -90,8 +102,10 @@ module Google
|
|
90
102
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
93
|
-
credentials:
|
94
|
-
endpoint:
|
105
|
+
credentials: credentials,
|
106
|
+
endpoint: @config.endpoint,
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
108
|
+
universe_domain: @config.universe_domain,
|
95
109
|
channel_args: @config.channel_args,
|
96
110
|
interceptors: @config.interceptors,
|
97
111
|
channel_pool_config: @config.channel_pool
|
@@ -613,9 +627,9 @@ module Google
|
|
613
627
|
# end
|
614
628
|
#
|
615
629
|
# @!attribute [rw] endpoint
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# @return [::String]
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
632
|
+
# @return [::String,nil]
|
619
633
|
# @!attribute [rw] credentials
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -661,13 +675,20 @@ module Google
|
|
661
675
|
# @!attribute [rw] quota_project
|
662
676
|
# A separate project against which to charge quota.
|
663
677
|
# @return [::String]
|
678
|
+
# @!attribute [rw] universe_domain
|
679
|
+
# The universe domain within which to make requests. This determines the
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
682
|
+
# @return [::String,nil]
|
664
683
|
#
|
665
684
|
class Configuration
|
666
685
|
extend ::Gapic::Config
|
667
686
|
|
687
|
+
# @private
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
668
689
|
DEFAULT_ENDPOINT = "documentai.googleapis.com"
|
669
690
|
|
670
|
-
config_attr :endpoint,
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
671
692
|
config_attr :credentials, nil do |value|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -682,6 +703,7 @@ module Google
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
685
707
|
|
686
708
|
# @private
|
687
709
|
def initialize parent_config = nil
|
@@ -36,6 +36,9 @@ module Google
|
|
36
36
|
# structured information from unstructured or semi-structured documents.
|
37
37
|
#
|
38
38
|
class Client
|
39
|
+
# @private
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
|
41
|
+
|
39
42
|
include Paths
|
40
43
|
|
41
44
|
# @private
|
@@ -111,6 +114,15 @@ module Google
|
|
111
114
|
@config
|
112
115
|
end
|
113
116
|
|
117
|
+
##
|
118
|
+
# The effective universe domain
|
119
|
+
#
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
def universe_domain
|
123
|
+
@document_processor_service_stub.universe_domain
|
124
|
+
end
|
125
|
+
|
114
126
|
##
|
115
127
|
# Create a new DocumentProcessorService REST client object.
|
116
128
|
#
|
@@ -138,8 +150,9 @@ module Google
|
|
138
150
|
credentials = @config.credentials
|
139
151
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
140
152
|
# but only if the default endpoint does not have a region prefix.
|
141
|
-
enable_self_signed_jwt = @config.endpoint
|
142
|
-
|
153
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
154
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
155
|
+
!@config.endpoint.split(".").first.include?("-"))
|
143
156
|
credentials ||= Credentials.default scope: @config.scope,
|
144
157
|
enable_self_signed_jwt: enable_self_signed_jwt
|
145
158
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -153,16 +166,23 @@ module Google
|
|
153
166
|
config.credentials = credentials
|
154
167
|
config.quota_project = @quota_project_id
|
155
168
|
config.endpoint = @config.endpoint
|
169
|
+
config.universe_domain = @config.universe_domain
|
156
170
|
end
|
157
171
|
|
172
|
+
@document_processor_service_stub = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::ServiceStub.new(
|
173
|
+
endpoint: @config.endpoint,
|
174
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
175
|
+
universe_domain: @config.universe_domain,
|
176
|
+
credentials: credentials
|
177
|
+
)
|
178
|
+
|
158
179
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
159
180
|
config.credentials = credentials
|
160
181
|
config.quota_project = @quota_project_id
|
161
|
-
config.endpoint = @
|
182
|
+
config.endpoint = @document_processor_service_stub.endpoint
|
183
|
+
config.universe_domain = @document_processor_service_stub.universe_domain
|
162
184
|
config.bindings_override = @config.bindings_override
|
163
185
|
end
|
164
|
-
|
165
|
-
@document_processor_service_stub = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
|
166
186
|
end
|
167
187
|
|
168
188
|
##
|
@@ -2175,9 +2195,9 @@ module Google
|
|
2175
2195
|
# end
|
2176
2196
|
#
|
2177
2197
|
# @!attribute [rw] endpoint
|
2178
|
-
#
|
2179
|
-
#
|
2180
|
-
# @return [::String]
|
2198
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
2199
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
2200
|
+
# @return [::String,nil]
|
2181
2201
|
# @!attribute [rw] credentials
|
2182
2202
|
# Credentials to send with calls. You may provide any of the following types:
|
2183
2203
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -2214,13 +2234,20 @@ module Google
|
|
2214
2234
|
# @!attribute [rw] quota_project
|
2215
2235
|
# A separate project against which to charge quota.
|
2216
2236
|
# @return [::String]
|
2237
|
+
# @!attribute [rw] universe_domain
|
2238
|
+
# The universe domain within which to make requests. This determines the
|
2239
|
+
# default endpoint URL. The default value of nil uses the environment
|
2240
|
+
# universe (usually the default "googleapis.com" universe).
|
2241
|
+
# @return [::String,nil]
|
2217
2242
|
#
|
2218
2243
|
class Configuration
|
2219
2244
|
extend ::Gapic::Config
|
2220
2245
|
|
2246
|
+
# @private
|
2247
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
2221
2248
|
DEFAULT_ENDPOINT = "documentai.googleapis.com"
|
2222
2249
|
|
2223
|
-
config_attr :endpoint,
|
2250
|
+
config_attr :endpoint, nil, ::String, nil
|
2224
2251
|
config_attr :credentials, nil do |value|
|
2225
2252
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2226
2253
|
allowed.any? { |klass| klass === value }
|
@@ -2232,6 +2259,7 @@ module Google
|
|
2232
2259
|
config_attr :metadata, nil, ::Hash, nil
|
2233
2260
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2234
2261
|
config_attr :quota_project, nil, ::String, nil
|
2262
|
+
config_attr :universe_domain, nil, ::String, nil
|
2235
2263
|
|
2236
2264
|
# @private
|
2237
2265
|
# Overrides for http bindings for the RPCs of this service
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module Rest
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
|
31
|
+
|
29
32
|
# @private
|
30
33
|
attr_reader :operations_stub
|
31
34
|
|
@@ -60,6 +63,15 @@ module Google
|
|
60
63
|
@config
|
61
64
|
end
|
62
65
|
|
66
|
+
##
|
67
|
+
# The effective universe domain
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
def universe_domain
|
72
|
+
@operations_stub.universe_domain
|
73
|
+
end
|
74
|
+
|
63
75
|
##
|
64
76
|
# Create a new Operations client object.
|
65
77
|
#
|
@@ -84,8 +96,10 @@ module Google
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
85
97
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
87
|
-
endpoint:
|
88
|
-
|
99
|
+
endpoint: @config.endpoint,
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
101
|
+
universe_domain: @config.universe_domain,
|
102
|
+
credentials: credentials
|
89
103
|
)
|
90
104
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
@@ -478,9 +492,9 @@ module Google
|
|
478
492
|
# end
|
479
493
|
#
|
480
494
|
# @!attribute [rw] endpoint
|
481
|
-
#
|
482
|
-
#
|
483
|
-
# @return [::String]
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
497
|
+
# @return [::String,nil]
|
484
498
|
# @!attribute [rw] credentials
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -517,13 +531,20 @@ module Google
|
|
517
531
|
# @!attribute [rw] quota_project
|
518
532
|
# A separate project against which to charge quota.
|
519
533
|
# @return [::String]
|
534
|
+
# @!attribute [rw] universe_domain
|
535
|
+
# The universe domain within which to make requests. This determines the
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
538
|
+
# @return [::String,nil]
|
520
539
|
#
|
521
540
|
class Configuration
|
522
541
|
extend ::Gapic::Config
|
523
542
|
|
543
|
+
# @private
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
524
545
|
DEFAULT_ENDPOINT = "documentai.googleapis.com"
|
525
546
|
|
526
|
-
config_attr :endpoint,
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
527
548
|
config_attr :credentials, nil do |value|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
529
550
|
allowed.any? { |klass| klass === value }
|
@@ -535,6 +556,7 @@ module Google
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
538
560
|
|
539
561
|
# @private
|
540
562
|
def initialize parent_config = nil
|
@@ -617,12 +639,15 @@ module Google
|
|
617
639
|
# Service stub contains baseline method implementations
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
619
641
|
class OperationsServiceStub
|
620
|
-
def initialize endpoint:, credentials:
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
621
643
|
# These require statements are intentionally placed here to initialize
|
622
644
|
# the REST modules only when it's required.
|
623
645
|
require "gapic/rest"
|
624
646
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
648
|
+
endpoint_template: endpoint_template,
|
649
|
+
universe_domain: universe_domain,
|
650
|
+
credentials: credentials
|
626
651
|
end
|
627
652
|
|
628
653
|
##
|
@@ -30,16 +30,37 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
55
|
+
##
|
56
|
+
# The effective endpoint
|
57
|
+
#
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
def endpoint
|
61
|
+
@client_stub.endpoint
|
62
|
+
end
|
63
|
+
|
43
64
|
##
|
44
65
|
# Baseline implementation for the process_document REST call
|
45
66
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -44,6 +44,7 @@ module Google
|
|
44
44
|
# @return [::String]
|
45
45
|
# Optional. UTF-8 encoded text in reading order from the document.
|
46
46
|
# @!attribute [rw] text_styles
|
47
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
47
48
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Style>]
|
48
49
|
# Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
|
49
50
|
# @!attribute [rw] pages
|
@@ -210,6 +211,7 @@ module Google
|
|
210
211
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores]
|
211
212
|
# Image quality scores.
|
212
213
|
# @!attribute [rw] provenance
|
214
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
213
215
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
214
216
|
# The history of this page.
|
215
217
|
class Page
|
@@ -329,6 +331,7 @@ module Google
|
|
329
331
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
|
330
332
|
# A list of detected languages together with confidence.
|
331
333
|
# @!attribute [rw] provenance
|
334
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
332
335
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
333
336
|
# The history of this annotation.
|
334
337
|
class Block
|
@@ -345,6 +348,7 @@ module Google
|
|
345
348
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
|
346
349
|
# A list of detected languages together with confidence.
|
347
350
|
# @!attribute [rw] provenance
|
351
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
348
352
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
349
353
|
# The history of this annotation.
|
350
354
|
class Paragraph
|
@@ -362,6 +366,7 @@ module Google
|
|
362
366
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
|
363
367
|
# A list of detected languages together with confidence.
|
364
368
|
# @!attribute [rw] provenance
|
369
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
365
370
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
366
371
|
# The history of this annotation.
|
367
372
|
class Line
|
@@ -382,6 +387,7 @@ module Google
|
|
382
387
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
|
383
388
|
# A list of detected languages together with confidence.
|
384
389
|
# @!attribute [rw] provenance
|
390
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
385
391
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
386
392
|
# The history of this annotation.
|
387
393
|
# @!attribute [rw] style_info
|
@@ -519,6 +525,7 @@ module Google
|
|
519
525
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
|
520
526
|
# A list of detected languages together with confidence.
|
521
527
|
# @!attribute [rw] provenance
|
528
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
522
529
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
523
530
|
# The history of this table.
|
524
531
|
class Table
|
@@ -831,6 +838,7 @@ module Google
|
|
831
838
|
# Optional. The type of the layout element that is being referenced if
|
832
839
|
# any.
|
833
840
|
# @!attribute [rw] layout_id
|
841
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
834
842
|
# @return [::String]
|
835
843
|
# Optional. Deprecated. Use
|
836
844
|
# {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
|
@@ -892,9 +900,11 @@ module Google
|
|
892
900
|
# Structure to identify provenance relationships between annotations in
|
893
901
|
# different revisions.
|
894
902
|
# @!attribute [rw] revision
|
903
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
895
904
|
# @return [::Integer]
|
896
905
|
# The index of the revision that produced this element.
|
897
906
|
# @!attribute [rw] id
|
907
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
898
908
|
# @return [::Integer]
|
899
909
|
# The Id of this operation. Needs to be unique within the scope of the
|
900
910
|
# revision.
|
@@ -918,6 +928,7 @@ module Google
|
|
918
928
|
# The index of the parent item in the corresponding item list (eg. list
|
919
929
|
# of entities, properties within entities, etc.) in the parent revision.
|
920
930
|
# @!attribute [rw] id
|
931
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
921
932
|
# @return [::Integer]
|
922
933
|
# The id of the parent provenance.
|
923
934
|
class Parent
|
@@ -973,6 +984,7 @@ module Google
|
|
973
984
|
# Id of the revision, internally generated by doc proto storage.
|
974
985
|
# Unique within the context of the document.
|
975
986
|
# @!attribute [rw] parent
|
987
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
976
988
|
# @return [::Array<::Integer>]
|
977
989
|
# The revisions that this revision is based on. This can include one or
|
978
990
|
# more parent (when documents are merged.) This field represents the
|
@@ -1020,6 +1032,7 @@ module Google
|
|
1020
1032
|
# @return [::String]
|
1021
1033
|
# The text that replaces the text identified in the `text_anchor`.
|
1022
1034
|
# @!attribute [rw] provenance
|
1035
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
1023
1036
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Provenance>]
|
1024
1037
|
# The history of this annotation.
|
1025
1038
|
class TextChange
|
@@ -148,6 +148,7 @@ module Google
|
|
148
148
|
# @return [::Boolean]
|
149
149
|
# Includes symbol level OCR information if set to true.
|
150
150
|
# @!attribute [rw] compute_style_info
|
151
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
151
152
|
# @return [::Boolean]
|
152
153
|
# Turn on font identification model and return font style information.
|
153
154
|
# Deprecated, use
|
@@ -156,7 +157,7 @@ module Google
|
|
156
157
|
# @!attribute [rw] disable_character_boxes_detection
|
157
158
|
# @return [::Boolean]
|
158
159
|
# Turn off character box detector in OCR engine. Character box detection is
|
159
|
-
# enabled by default in OCR 2.0
|
160
|
+
# enabled by default in OCR 2.0 (and later) processors.
|
160
161
|
# @!attribute [rw] premium_features
|
161
162
|
# @return [::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures]
|
162
163
|
# Configurations for premium OCR features.
|
@@ -181,8 +182,8 @@ module Google
|
|
181
182
|
# Configurations for premium OCR features.
|
182
183
|
# @!attribute [rw] enable_selection_mark_detection
|
183
184
|
# @return [::Boolean]
|
184
|
-
# Turn on selection mark detector in OCR engine. Only available in OCR 2.0
|
185
|
-
# processors.
|
185
|
+
# Turn on selection mark detector in OCR engine. Only available in OCR 2.0
|
186
|
+
# (and later) processors.
|
186
187
|
# @!attribute [rw] compute_style_info
|
187
188
|
# @return [::Boolean]
|
188
189
|
# Turn on font identification model and return font style information.
|
@@ -104,14 +104,14 @@ module Google
|
|
104
104
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
105
105
|
|
106
106
|
# Types of occurrences of the entity type in the document. This
|
107
|
-
# represents the number of instances of
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
107
|
+
# represents the number of instances of an entity, not number of mentions
|
108
|
+
# of an entity. For example, a bank statement may only have one
|
109
|
+
# `account_number`, but this account number may be mentioned in several
|
110
|
+
# places on the document. In this case the 'account_number' would be
|
111
|
+
# considered a `REQUIRED_ONCE` entity type. If, on the other hand, we
|
112
|
+
# expect a bank statement to contain the status of multiple different
|
113
|
+
# accounts for the customers, the occurrence type will be set to
|
114
|
+
# `REQUIRED_MULTIPLE`.
|
115
115
|
module OccurrenceType
|
116
116
|
# Unspecified occurrence type.
|
117
117
|
OCCURRENCE_TYPE_UNSPECIFIED = 0
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-document_ai-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.17.1
|
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: 2024-01-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,7 +50,7 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - ">="
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: '0.
|
53
|
+
version: '0.7'
|
54
54
|
- - "<"
|
55
55
|
- !ruby/object:Gem::Version
|
56
56
|
version: 2.a
|
@@ -60,7 +60,7 @@ dependencies:
|
|
60
60
|
requirements:
|
61
61
|
- - ">="
|
62
62
|
- !ruby/object:Gem::Version
|
63
|
-
version: '0.
|
63
|
+
version: '0.7'
|
64
64
|
- - "<"
|
65
65
|
- !ruby/object:Gem::Version
|
66
66
|
version: 2.a
|
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
262
262
|
- !ruby/object:Gem::Version
|
263
263
|
version: '0'
|
264
264
|
requirements: []
|
265
|
-
rubygems_version: 3.
|
265
|
+
rubygems_version: 3.5.3
|
266
266
|
signing_key:
|
267
267
|
specification_version: 4
|
268
268
|
summary: Service to parse structured information from unstructured or semi-structured
|