google-cloud-document_ai-v1 0.8.0 → 0.10.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/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +562 -54
- data/lib/google/cloud/document_ai/v1/document_processor_service/operations.rb +12 -14
- data/lib/google/cloud/document_ai/v1/document_processor_service/paths.rb +42 -0
- data/lib/google/cloud/document_ai/v1/document_processor_service.rb +1 -1
- data/lib/google/cloud/document_ai/v1/version.rb +1 -1
- data/lib/google/cloud/document_ai/v1.rb +2 -2
- data/lib/google/cloud/documentai/v1/document_pb.rb +1 -0
- data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb +64 -0
- data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +13 -0
- data/lib/google/cloud/documentai/v1/evaluation_pb.rb +79 -0
- data/lib/google/cloud/documentai/v1/processor_pb.rb +2 -0
- data/proto_docs/google/cloud/documentai/v1/document.rb +16 -7
- data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +172 -0
- data/proto_docs/google/cloud/documentai/v1/document_schema.rb +14 -6
- data/proto_docs/google/cloud/documentai/v1/evaluation.rb +199 -0
- data/proto_docs/google/cloud/documentai/v1/processor.rb +3 -0
- metadata +11 -9
|
@@ -73,7 +73,7 @@ module Google
|
|
|
73
73
|
# one should be set.
|
|
74
74
|
# @!attribute [rw] properties
|
|
75
75
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::Property>]
|
|
76
|
-
#
|
|
76
|
+
# Description the nested structure, or composition of an entity.
|
|
77
77
|
class EntityType
|
|
78
78
|
include ::Google::Protobuf::MessageExts
|
|
79
79
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -104,20 +104,28 @@ module Google
|
|
|
104
104
|
include ::Google::Protobuf::MessageExts
|
|
105
105
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
106
106
|
|
|
107
|
-
# Types of occurrences of the entity type in the document.
|
|
108
|
-
# represents the number of instances of an entity
|
|
109
|
-
# mentions of a
|
|
107
|
+
# Types of occurrences of the entity type in the document. This
|
|
108
|
+
# represents the number of instances of instances of an entity, not
|
|
109
|
+
# number of mentions of an entity. For example, a bank statement may
|
|
110
|
+
# only have one `account_number`, but this account number may be
|
|
111
|
+
# mentioned in several places on the document. In this case the
|
|
112
|
+
# 'account_number' would be considered a `REQUIRED_ONCE` entity type. If,
|
|
113
|
+
# on the other hand, we expect a bank statement to contain the status of
|
|
114
|
+
# multiple different accounts for the customers, the occurrence type will
|
|
115
|
+
# be set to `REQUIRED_MULTIPLE`.
|
|
110
116
|
module OccurrenceType
|
|
111
117
|
# Unspecified occurrence type.
|
|
112
118
|
OCCURRENCE_TYPE_UNSPECIFIED = 0
|
|
113
119
|
|
|
114
|
-
# There will be zero or one instance of this entity type.
|
|
120
|
+
# There will be zero or one instance of this entity type. The same
|
|
121
|
+
# entity instance may be mentioned multiple times.
|
|
115
122
|
OPTIONAL_ONCE = 1
|
|
116
123
|
|
|
117
124
|
# The entity type will appear zero or multiple times.
|
|
118
125
|
OPTIONAL_MULTIPLE = 2
|
|
119
126
|
|
|
120
|
-
# The entity type will only appear exactly once.
|
|
127
|
+
# The entity type will only appear exactly once. The same
|
|
128
|
+
# entity instance may be mentioned multiple times.
|
|
121
129
|
REQUIRED_ONCE = 3
|
|
122
130
|
|
|
123
131
|
# The entity type will appear once or more times.
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2023 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module DocumentAI
|
|
23
|
+
module V1
|
|
24
|
+
# Gives a short summary of an evaluation, and links to the evaluation itself.
|
|
25
|
+
# @!attribute [rw] operation
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# The resource name of the Long Running Operation for the evaluation.
|
|
28
|
+
# @!attribute [rw] evaluation
|
|
29
|
+
# @return [::String]
|
|
30
|
+
# The resource name of the evaluation.
|
|
31
|
+
# @!attribute [rw] aggregate_metrics
|
|
32
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::Metrics]
|
|
33
|
+
# An aggregate of the statistics for the evaluation with fuzzy matching on.
|
|
34
|
+
# @!attribute [rw] aggregate_metrics_exact
|
|
35
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::Metrics]
|
|
36
|
+
# An aggregate of the statistics for the evaluation with fuzzy matching off.
|
|
37
|
+
class EvaluationReference
|
|
38
|
+
include ::Google::Protobuf::MessageExts
|
|
39
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# An evaluation of a ProcessorVersion's performance.
|
|
43
|
+
# @!attribute [rw] name
|
|
44
|
+
# @return [::String]
|
|
45
|
+
# The resource name of the evaluation.
|
|
46
|
+
# Format:
|
|
47
|
+
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
|
|
48
|
+
# @!attribute [rw] create_time
|
|
49
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
50
|
+
# The time that the evaluation was created.
|
|
51
|
+
# @!attribute [rw] document_counters
|
|
52
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::Counters]
|
|
53
|
+
# Counters for the documents used in the evaluation.
|
|
54
|
+
# @!attribute [rw] all_entities_metrics
|
|
55
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics]
|
|
56
|
+
# Metrics for all the entities in aggregate.
|
|
57
|
+
# @!attribute [rw] entity_metrics
|
|
58
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}]
|
|
59
|
+
# Metrics across confidence levels, for different entities.
|
|
60
|
+
# @!attribute [rw] kms_key_name
|
|
61
|
+
# @return [::String]
|
|
62
|
+
# The KMS key name used for encryption.
|
|
63
|
+
# @!attribute [rw] kms_key_version_name
|
|
64
|
+
# @return [::String]
|
|
65
|
+
# The KMS key version with which data is encrypted.
|
|
66
|
+
class Evaluation
|
|
67
|
+
include ::Google::Protobuf::MessageExts
|
|
68
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
69
|
+
|
|
70
|
+
# Evaluation counters for the documents that were used.
|
|
71
|
+
# @!attribute [rw] input_documents_count
|
|
72
|
+
# @return [::Integer]
|
|
73
|
+
# How many documents were sent for evaluation.
|
|
74
|
+
# @!attribute [rw] invalid_documents_count
|
|
75
|
+
# @return [::Integer]
|
|
76
|
+
# How many documents were not included in the evaluation as they didn't
|
|
77
|
+
# pass validation.
|
|
78
|
+
# @!attribute [rw] failed_documents_count
|
|
79
|
+
# @return [::Integer]
|
|
80
|
+
# How many documents were not included in the evaluation as Document AI
|
|
81
|
+
# failed to process them.
|
|
82
|
+
# @!attribute [rw] evaluated_documents_count
|
|
83
|
+
# @return [::Integer]
|
|
84
|
+
# How many documents were used in the evaluation.
|
|
85
|
+
class Counters
|
|
86
|
+
include ::Google::Protobuf::MessageExts
|
|
87
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Evaluation metrics, either in aggregate or about a specific entity.
|
|
91
|
+
# @!attribute [rw] precision
|
|
92
|
+
# @return [::Float]
|
|
93
|
+
# The calculated precision.
|
|
94
|
+
# @!attribute [rw] recall
|
|
95
|
+
# @return [::Float]
|
|
96
|
+
# The calculated recall.
|
|
97
|
+
# @!attribute [rw] f1_score
|
|
98
|
+
# @return [::Float]
|
|
99
|
+
# The calculated f1 score.
|
|
100
|
+
# @!attribute [rw] predicted_occurrences_count
|
|
101
|
+
# @return [::Integer]
|
|
102
|
+
# The amount of occurrences in predicted documents.
|
|
103
|
+
# @!attribute [rw] ground_truth_occurrences_count
|
|
104
|
+
# @return [::Integer]
|
|
105
|
+
# The amount of occurrences in ground truth documents.
|
|
106
|
+
# @!attribute [rw] predicted_document_count
|
|
107
|
+
# @return [::Integer]
|
|
108
|
+
# The amount of documents with a predicted occurrence.
|
|
109
|
+
# @!attribute [rw] ground_truth_document_count
|
|
110
|
+
# @return [::Integer]
|
|
111
|
+
# The amount of documents with a ground truth occurrence.
|
|
112
|
+
# @!attribute [rw] true_positives_count
|
|
113
|
+
# @return [::Integer]
|
|
114
|
+
# The amount of true positives.
|
|
115
|
+
# @!attribute [rw] false_positives_count
|
|
116
|
+
# @return [::Integer]
|
|
117
|
+
# The amount of false positives.
|
|
118
|
+
# @!attribute [rw] false_negatives_count
|
|
119
|
+
# @return [::Integer]
|
|
120
|
+
# The amount of false negatives.
|
|
121
|
+
# @!attribute [rw] total_documents_count
|
|
122
|
+
# @return [::Integer]
|
|
123
|
+
# The amount of documents that had an occurrence of this label.
|
|
124
|
+
class Metrics
|
|
125
|
+
include ::Google::Protobuf::MessageExts
|
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# Evaluations metrics, at a specific confidence level.
|
|
130
|
+
# @!attribute [rw] confidence_level
|
|
131
|
+
# @return [::Float]
|
|
132
|
+
# The confidence level.
|
|
133
|
+
# @!attribute [rw] metrics
|
|
134
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::Metrics]
|
|
135
|
+
# The metrics at the specific confidence level.
|
|
136
|
+
class ConfidenceLevelMetrics
|
|
137
|
+
include ::Google::Protobuf::MessageExts
|
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Metrics across multiple confidence levels.
|
|
142
|
+
# @!attribute [rw] confidence_level_metrics
|
|
143
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1::Evaluation::ConfidenceLevelMetrics>]
|
|
144
|
+
# Metrics across confidence levels with fuzzy matching enabled.
|
|
145
|
+
# @!attribute [rw] confidence_level_metrics_exact
|
|
146
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1::Evaluation::ConfidenceLevelMetrics>]
|
|
147
|
+
# Metrics across confidence levels with only exact matching.
|
|
148
|
+
# @!attribute [rw] auprc
|
|
149
|
+
# @return [::Float]
|
|
150
|
+
# The calculated area under the precision recall curve (AUPRC), computed by
|
|
151
|
+
# integrating over all confidence thresholds.
|
|
152
|
+
# @!attribute [rw] estimated_calibration_error
|
|
153
|
+
# @return [::Float]
|
|
154
|
+
# The Estimated Calibration Error (ECE) of the confidence of the predicted
|
|
155
|
+
# entities.
|
|
156
|
+
# @!attribute [rw] auprc_exact
|
|
157
|
+
# @return [::Float]
|
|
158
|
+
# The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
|
|
159
|
+
# only.
|
|
160
|
+
# @!attribute [rw] estimated_calibration_error_exact
|
|
161
|
+
# @return [::Float]
|
|
162
|
+
# The ECE for the predicted entities with fuzzy matching disabled, i.e.,
|
|
163
|
+
# exact matching only.
|
|
164
|
+
# @!attribute [rw] metrics_type
|
|
165
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics::MetricsType]
|
|
166
|
+
# The metrics type for the label.
|
|
167
|
+
class MultiConfidenceMetrics
|
|
168
|
+
include ::Google::Protobuf::MessageExts
|
|
169
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
170
|
+
|
|
171
|
+
# A type that determines how metrics should be interpreted.
|
|
172
|
+
module MetricsType
|
|
173
|
+
# The metrics type is unspecified. By default, metrics without a
|
|
174
|
+
# particular specification are for leaf entity types (i.e., top-level
|
|
175
|
+
# entity types without child types, or child types which are not
|
|
176
|
+
# parent types themselves).
|
|
177
|
+
METRICS_TYPE_UNSPECIFIED = 0
|
|
178
|
+
|
|
179
|
+
# Indicates whether metrics for this particular label type represent an
|
|
180
|
+
# aggregate of metrics for other types instead of being based on actual
|
|
181
|
+
# TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
|
|
182
|
+
# entity types are an aggregate of metrics for their children.
|
|
183
|
+
AGGREGATE = 1
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# @!attribute [rw] key
|
|
188
|
+
# @return [::String]
|
|
189
|
+
# @!attribute [rw] value
|
|
190
|
+
# @return [::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics]
|
|
191
|
+
class EntityMetricsEntry
|
|
192
|
+
include ::Google::Protobuf::MessageExts
|
|
193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
194
|
+
end
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
end
|
|
199
|
+
end
|
|
@@ -43,6 +43,9 @@ module Google
|
|
|
43
43
|
# @!attribute [rw] create_time
|
|
44
44
|
# @return [::Google::Protobuf::Timestamp]
|
|
45
45
|
# The time the processor version was created.
|
|
46
|
+
# @!attribute [rw] latest_evaluation
|
|
47
|
+
# @return [::Google::Cloud::DocumentAI::V1::EvaluationReference]
|
|
48
|
+
# The most recently invoked evaluation for the processor version.
|
|
46
49
|
# @!attribute [rw] kms_key_name
|
|
47
50
|
# @return [::String]
|
|
48
51
|
# The KMS key name used for encryption.
|
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.10.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: 2023-02-23 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:
|
|
19
|
+
version: 0.17.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:
|
|
29
|
+
version: 0.17.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.4'
|
|
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.4'
|
|
64
64
|
- - "<"
|
|
65
65
|
- !ruby/object:Gem::Version
|
|
66
66
|
version: 2.a
|
|
@@ -70,14 +70,14 @@ dependencies:
|
|
|
70
70
|
requirements:
|
|
71
71
|
- - "~>"
|
|
72
72
|
- !ruby/object:Gem::Version
|
|
73
|
-
version: 1.26.
|
|
73
|
+
version: 1.26.3
|
|
74
74
|
type: :development
|
|
75
75
|
prerelease: false
|
|
76
76
|
version_requirements: !ruby/object:Gem::Requirement
|
|
77
77
|
requirements:
|
|
78
78
|
- - "~>"
|
|
79
79
|
- !ruby/object:Gem::Version
|
|
80
|
-
version: 1.26.
|
|
80
|
+
version: 1.26.3
|
|
81
81
|
- !ruby/object:Gem::Dependency
|
|
82
82
|
name: minitest
|
|
83
83
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -204,6 +204,7 @@ files:
|
|
|
204
204
|
- lib/google/cloud/documentai/v1/document_processor_service_pb.rb
|
|
205
205
|
- lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb
|
|
206
206
|
- lib/google/cloud/documentai/v1/document_schema_pb.rb
|
|
207
|
+
- lib/google/cloud/documentai/v1/evaluation_pb.rb
|
|
207
208
|
- lib/google/cloud/documentai/v1/geometry_pb.rb
|
|
208
209
|
- lib/google/cloud/documentai/v1/operation_metadata_pb.rb
|
|
209
210
|
- lib/google/cloud/documentai/v1/processor_pb.rb
|
|
@@ -218,6 +219,7 @@ files:
|
|
|
218
219
|
- proto_docs/google/cloud/documentai/v1/document_io.rb
|
|
219
220
|
- proto_docs/google/cloud/documentai/v1/document_processor_service.rb
|
|
220
221
|
- proto_docs/google/cloud/documentai/v1/document_schema.rb
|
|
222
|
+
- proto_docs/google/cloud/documentai/v1/evaluation.rb
|
|
221
223
|
- proto_docs/google/cloud/documentai/v1/geometry.rb
|
|
222
224
|
- proto_docs/google/cloud/documentai/v1/operation_metadata.rb
|
|
223
225
|
- proto_docs/google/cloud/documentai/v1/processor.rb
|
|
@@ -254,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
254
256
|
- !ruby/object:Gem::Version
|
|
255
257
|
version: '0'
|
|
256
258
|
requirements: []
|
|
257
|
-
rubygems_version: 3.
|
|
259
|
+
rubygems_version: 3.4.2
|
|
258
260
|
signing_key:
|
|
259
261
|
specification_version: 4
|
|
260
262
|
summary: API Client library for the Document AI V1 API
|