google-cloud-document_ai-v1beta3 0.12.0 → 0.14.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/AUTHENTICATION.md +1 -1
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +1407 -153
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb +44 -0
- data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
- data/lib/google/cloud/documentai/v1beta3/barcode_pb.rb +24 -0
- data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +2 -1
- data/lib/google/cloud/documentai/v1beta3/document_pb.rb +25 -1
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +142 -0
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +32 -1
- data/lib/google/cloud/documentai/v1beta3/document_schema_pb.rb +60 -0
- data/lib/google/cloud/documentai/v1beta3/evaluation_pb.rb +72 -0
- data/lib/google/cloud/documentai/v1beta3/geometry_pb.rb +0 -2
- data/lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb +1 -1
- data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +29 -2
- data/lib/google/cloud/documentai/v1beta3/processor_type_pb.rb +2 -1
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/documentai/v1beta3/barcode.rb +73 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document.rb +162 -145
- data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +7 -2
- data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +382 -10
- data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +155 -0
- data/proto_docs/google/cloud/documentai/v1beta3/evaluation.rb +181 -0
- data/proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb +3 -0
- data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +97 -9
- data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +9 -6
- data/proto_docs/google/protobuf/empty.rb +0 -2
- metadata +32 -4
@@ -0,0 +1,155 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DocumentAI
|
23
|
+
module V1beta3
|
24
|
+
# The schema defines the output of the processed document by a processor.
|
25
|
+
# @!attribute [rw] display_name
|
26
|
+
# @return [::String]
|
27
|
+
# Display name to show to users.
|
28
|
+
# @!attribute [rw] description
|
29
|
+
# @return [::String]
|
30
|
+
# Description of the schema.
|
31
|
+
# @!attribute [rw] entity_types
|
32
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType>]
|
33
|
+
# Entity types of the schema.
|
34
|
+
# @!attribute [rw] metadata
|
35
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::Metadata]
|
36
|
+
# Metadata of the schema.
|
37
|
+
class DocumentSchema
|
38
|
+
include ::Google::Protobuf::MessageExts
|
39
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
40
|
+
|
41
|
+
# EntityType is the wrapper of a label of the corresponding model with
|
42
|
+
# detailed attributes and limitations for entity-based processors. Multiple
|
43
|
+
# types can also compose a dependency tree to represent nested types.
|
44
|
+
# @!attribute [rw] enum_values
|
45
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::EnumValues]
|
46
|
+
# If specified, lists all the possible values for this entity. This
|
47
|
+
# should not be more than a handful of values. If the number of values
|
48
|
+
# is >10 or could change frequently use the `EntityType.value_ontology`
|
49
|
+
# field and specify a list of all possible values in a value ontology
|
50
|
+
# file.
|
51
|
+
# @!attribute [rw] display_name
|
52
|
+
# @return [::String]
|
53
|
+
# User defined name for the type.
|
54
|
+
# @!attribute [rw] name
|
55
|
+
# @return [::String]
|
56
|
+
# Name of the type. It must be unique within the schema file and
|
57
|
+
# cannot be a 'Common Type'. Besides that we use the following naming
|
58
|
+
# conventions:
|
59
|
+
#
|
60
|
+
# - *use `snake_casing`*
|
61
|
+
# - name matching is case-insensitive
|
62
|
+
# - Maximum 64 characters.
|
63
|
+
# - Must start with a letter.
|
64
|
+
# - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
|
65
|
+
# compatibility internal infrastructure and tooling can handle any ascii
|
66
|
+
# character)
|
67
|
+
# - The `/` is sometimes used to denote a property of a type. For example
|
68
|
+
# `line_item/amount`. This convention is deprecated, but will still be
|
69
|
+
# honored for backward compatibility.
|
70
|
+
# @!attribute [rw] base_types
|
71
|
+
# @return [::Array<::String>]
|
72
|
+
# The entity type that this type is derived from. For now, one and only
|
73
|
+
# one should be set.
|
74
|
+
# @!attribute [rw] properties
|
75
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property>]
|
76
|
+
# Describing the nested structure, or composition of an entity.
|
77
|
+
class EntityType
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
|
81
|
+
# Defines the a list of enum values.
|
82
|
+
# @!attribute [rw] values
|
83
|
+
# @return [::Array<::String>]
|
84
|
+
# The individual values that this enum values type can include.
|
85
|
+
class EnumValues
|
86
|
+
include ::Google::Protobuf::MessageExts
|
87
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
88
|
+
end
|
89
|
+
|
90
|
+
# Defines properties that can be part of the entity type.
|
91
|
+
# @!attribute [rw] name
|
92
|
+
# @return [::String]
|
93
|
+
# The name of the property. Follows the same guidelines as the
|
94
|
+
# EntityType name.
|
95
|
+
# @!attribute [rw] value_type
|
96
|
+
# @return [::String]
|
97
|
+
# A reference to the value type of the property. This type is subject
|
98
|
+
# to the same conventions as the `Entity.base_types` field.
|
99
|
+
# @!attribute [rw] occurrence_type
|
100
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType]
|
101
|
+
# Occurrence type limits the number of instances an entity type appears
|
102
|
+
# in the document.
|
103
|
+
class Property
|
104
|
+
include ::Google::Protobuf::MessageExts
|
105
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
106
|
+
|
107
|
+
# Types of occurrences of the entity type in the document. Note: this
|
108
|
+
# represents the number of instances of an entity types, not number of
|
109
|
+
# mentions of a given entity instance.
|
110
|
+
module OccurrenceType
|
111
|
+
# Unspecified occurrence type.
|
112
|
+
OCCURRENCE_TYPE_UNSPECIFIED = 0
|
113
|
+
|
114
|
+
# There will be zero or one instance of this entity type.
|
115
|
+
OPTIONAL_ONCE = 1
|
116
|
+
|
117
|
+
# The entity type will appear zero or multiple times.
|
118
|
+
OPTIONAL_MULTIPLE = 2
|
119
|
+
|
120
|
+
# The entity type will only appear exactly once.
|
121
|
+
REQUIRED_ONCE = 3
|
122
|
+
|
123
|
+
# The entity type will appear once or more times.
|
124
|
+
REQUIRED_MULTIPLE = 4
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
# Metadata for global schema behavior.
|
130
|
+
# @!attribute [rw] document_splitter
|
131
|
+
# @return [::Boolean]
|
132
|
+
# If true, a `document` entity type can be applied to subdocument (
|
133
|
+
# splitting). Otherwise, it can only be applied to the entire document
|
134
|
+
# (classification).
|
135
|
+
# @!attribute [rw] document_allow_multiple_labels
|
136
|
+
# @return [::Boolean]
|
137
|
+
# If true, on a given page, there can be multiple `document` annotations
|
138
|
+
# covering it.
|
139
|
+
# @!attribute [rw] prefixed_naming_on_properties
|
140
|
+
# @return [::Boolean]
|
141
|
+
# If set, all the nested entities must be prefixed with the parents.
|
142
|
+
# @!attribute [rw] skip_naming_validation
|
143
|
+
# @return [::Boolean]
|
144
|
+
# If set, we will skip the naming format validation in the schema. So the
|
145
|
+
# string values in `DocumentSchema.EntityType.name` and
|
146
|
+
# `DocumentSchema.EntityType.Property.name` will not be checked.
|
147
|
+
class Metadata
|
148
|
+
include ::Google::Protobuf::MessageExts
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
|
+
end
|
151
|
+
end
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|
@@ -0,0 +1,181 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DocumentAI
|
23
|
+
module V1beta3
|
24
|
+
# An evaluation of a ProcessorVersion's performance.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# The resource name of the evaluation.
|
28
|
+
# Format:
|
29
|
+
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
|
30
|
+
# @!attribute [rw] create_time
|
31
|
+
# @return [::Google::Protobuf::Timestamp]
|
32
|
+
# The time that the evaluation was created.
|
33
|
+
# @!attribute [rw] document_counters
|
34
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Counters]
|
35
|
+
# Counters for the documents used in the evaluation.
|
36
|
+
# @!attribute [rw] all_entities_metrics
|
37
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
|
38
|
+
# Metrics for all the entities in aggregate.
|
39
|
+
# @!attribute [rw] entity_metrics
|
40
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics}]
|
41
|
+
# Metrics across confidence levels, for different entities.
|
42
|
+
# @!attribute [rw] kms_key_name
|
43
|
+
# @return [::String]
|
44
|
+
# The KMS key name used for encryption.
|
45
|
+
# @!attribute [rw] kms_key_version_name
|
46
|
+
# @return [::String]
|
47
|
+
# The KMS key version with which data is encrypted.
|
48
|
+
class Evaluation
|
49
|
+
include ::Google::Protobuf::MessageExts
|
50
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
51
|
+
|
52
|
+
# Evaluation counters for the documents that were used.
|
53
|
+
# @!attribute [rw] input_documents_count
|
54
|
+
# @return [::Integer]
|
55
|
+
# How many documents were sent for evaluation.
|
56
|
+
# @!attribute [rw] invalid_documents_count
|
57
|
+
# @return [::Integer]
|
58
|
+
# How many documents were not included in the evaluation as they didn't
|
59
|
+
# pass validation.
|
60
|
+
# @!attribute [rw] failed_documents_count
|
61
|
+
# @return [::Integer]
|
62
|
+
# How many documents were not included in the evaluation as Document AI
|
63
|
+
# failed to process them.
|
64
|
+
# @!attribute [rw] evaluated_documents_count
|
65
|
+
# @return [::Integer]
|
66
|
+
# How many documents were used in the evaluation.
|
67
|
+
class Counters
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
72
|
+
# Evaluation metrics, either in aggregate or about a specific entity.
|
73
|
+
# @!attribute [rw] precision
|
74
|
+
# @return [::Float]
|
75
|
+
# The calculated precision.
|
76
|
+
# @!attribute [rw] recall
|
77
|
+
# @return [::Float]
|
78
|
+
# The calculated recall.
|
79
|
+
# @!attribute [rw] f1_score
|
80
|
+
# @return [::Float]
|
81
|
+
# The calculated f1 score.
|
82
|
+
# @!attribute [rw] predicted_occurrences_count
|
83
|
+
# @return [::Integer]
|
84
|
+
# The amount of occurrences in predicted documents.
|
85
|
+
# @!attribute [rw] ground_truth_occurrences_count
|
86
|
+
# @return [::Integer]
|
87
|
+
# The amount of occurrences in ground truth documents.
|
88
|
+
# @!attribute [rw] predicted_document_count
|
89
|
+
# @return [::Integer]
|
90
|
+
# The amount of documents with a predicted occurrence.
|
91
|
+
# @!attribute [rw] ground_truth_document_count
|
92
|
+
# @return [::Integer]
|
93
|
+
# The amount of documents with a ground truth occurrence.
|
94
|
+
# @!attribute [rw] true_positives_count
|
95
|
+
# @return [::Integer]
|
96
|
+
# The amount of true positives.
|
97
|
+
# @!attribute [rw] false_positives_count
|
98
|
+
# @return [::Integer]
|
99
|
+
# The amount of false positives.
|
100
|
+
# @!attribute [rw] false_negatives_count
|
101
|
+
# @return [::Integer]
|
102
|
+
# The amount of false negatives.
|
103
|
+
# @!attribute [rw] total_documents_count
|
104
|
+
# @return [::Integer]
|
105
|
+
# The amount of documents that had an occurrence of this label.
|
106
|
+
class Metrics
|
107
|
+
include ::Google::Protobuf::MessageExts
|
108
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
109
|
+
end
|
110
|
+
|
111
|
+
# Evaluations metrics, at a specific confidence level.
|
112
|
+
# @!attribute [rw] confidence_level
|
113
|
+
# @return [::Float]
|
114
|
+
# The confidence level.
|
115
|
+
# @!attribute [rw] metrics
|
116
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::Metrics]
|
117
|
+
# The metrics at the specific confidence level.
|
118
|
+
class ConfidenceLevelMetrics
|
119
|
+
include ::Google::Protobuf::MessageExts
|
120
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
121
|
+
end
|
122
|
+
|
123
|
+
# Metrics across multiple confidence levels.
|
124
|
+
# @!attribute [rw] confidence_level_metrics
|
125
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
|
126
|
+
# Metrics across confidence levels with fuzzy matching enabled.
|
127
|
+
# @!attribute [rw] confidence_level_metrics_exact
|
128
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>]
|
129
|
+
# Metrics across confidence levels with only exact matching.
|
130
|
+
# @!attribute [rw] auprc
|
131
|
+
# @return [::Float]
|
132
|
+
# The calculated area under the precision recall curve (AUPRC), computed by
|
133
|
+
# integrating over all confidence thresholds.
|
134
|
+
# @!attribute [rw] estimated_calibration_error
|
135
|
+
# @return [::Float]
|
136
|
+
# The Estimated Calibration Error (ECE) of the confidence of the predicted
|
137
|
+
# entities.
|
138
|
+
# @!attribute [rw] auprc_exact
|
139
|
+
# @return [::Float]
|
140
|
+
# The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
|
141
|
+
# only.
|
142
|
+
# @!attribute [rw] estimated_calibration_error_exact
|
143
|
+
# @return [::Float]
|
144
|
+
# The ECE for the predicted entities with fuzzy matching disabled, i.e.,
|
145
|
+
# exact matching only.
|
146
|
+
# @!attribute [rw] metrics_type
|
147
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType]
|
148
|
+
# The metrics type for the label.
|
149
|
+
class MultiConfidenceMetrics
|
150
|
+
include ::Google::Protobuf::MessageExts
|
151
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
152
|
+
|
153
|
+
# A type that determines how metrics should be interpreted.
|
154
|
+
module MetricsType
|
155
|
+
# The metrics type is unspecified. By default, metrics without a
|
156
|
+
# particular specification are for leaf entity types (i.e., top-level
|
157
|
+
# entity types without child types, or child types which are not
|
158
|
+
# parent types themselves).
|
159
|
+
METRICS_TYPE_UNSPECIFIED = 0
|
160
|
+
|
161
|
+
# Indicates whether metrics for this particular label type represent an
|
162
|
+
# aggregate of metrics for other types instead of being based on actual
|
163
|
+
# TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
|
164
|
+
# entity types are an aggregate of metrics for their children.
|
165
|
+
AGGREGATE = 1
|
166
|
+
end
|
167
|
+
end
|
168
|
+
|
169
|
+
# @!attribute [rw] key
|
170
|
+
# @return [::String]
|
171
|
+
# @!attribute [rw] value
|
172
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics]
|
173
|
+
class EntityMetricsEntry
|
174
|
+
include ::Google::Protobuf::MessageExts
|
175
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
@@ -28,6 +28,9 @@ module Google
|
|
28
28
|
# @!attribute [rw] state_message
|
29
29
|
# @return [::String]
|
30
30
|
# A message providing more details about the current state of processing.
|
31
|
+
# @!attribute [rw] resource
|
32
|
+
# @return [::String]
|
33
|
+
# A related resource to this operation.
|
31
34
|
# @!attribute [rw] create_time
|
32
35
|
# @return [::Google::Protobuf::Timestamp]
|
33
36
|
# The creation time of the operation.
|
@@ -21,15 +21,95 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module DocumentAI
|
23
23
|
module V1beta3
|
24
|
-
#
|
25
|
-
#
|
24
|
+
# A processor version is an implementation of a processor. Each processor
|
25
|
+
# can have multiple versions, pre-trained by Google internally or up-trained
|
26
|
+
# by the customer. At a time, a processor can only have one default version
|
27
|
+
# version. So the processor's behavior (when processing documents) is defined
|
28
|
+
# by a default version
|
29
|
+
# @!attribute [rw] name
|
30
|
+
# @return [::String]
|
31
|
+
# The resource name of the processor version.
|
32
|
+
# Format:
|
33
|
+
# `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
|
34
|
+
# @!attribute [rw] display_name
|
35
|
+
# @return [::String]
|
36
|
+
# The display name of the processor version.
|
37
|
+
# @!attribute [rw] document_schema
|
38
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
|
39
|
+
# The schema of the processor version. Describes the output.
|
40
|
+
# @!attribute [rw] state
|
41
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::State]
|
42
|
+
# The state of the processor version.
|
43
|
+
# @!attribute [rw] create_time
|
44
|
+
# @return [::Google::Protobuf::Timestamp]
|
45
|
+
# The time the processor version was created.
|
46
|
+
# @!attribute [rw] kms_key_name
|
47
|
+
# @return [::String]
|
48
|
+
# The KMS key name used for encryption.
|
49
|
+
# @!attribute [rw] kms_key_version_name
|
50
|
+
# @return [::String]
|
51
|
+
# The KMS key version with which data is encrypted.
|
52
|
+
# @!attribute [rw] google_managed
|
53
|
+
# @return [::Boolean]
|
54
|
+
# Denotes that this ProcessorVersion is managed by google.
|
55
|
+
# @!attribute [rw] deprecation_info
|
56
|
+
# @return [::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::DeprecationInfo]
|
57
|
+
# If set, information about the eventual deprecation of this version.
|
58
|
+
class ProcessorVersion
|
59
|
+
include ::Google::Protobuf::MessageExts
|
60
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
61
|
+
|
62
|
+
# Information about the upcoming deprecation of this processor version.
|
63
|
+
# @!attribute [rw] deprecation_time
|
64
|
+
# @return [::Google::Protobuf::Timestamp]
|
65
|
+
# The time at which this processor version will be deprecated.
|
66
|
+
# @!attribute [rw] replacement_processor_version
|
67
|
+
# @return [::String]
|
68
|
+
# If set, the processor version that will be used as a replacement.
|
69
|
+
class DeprecationInfo
|
70
|
+
include ::Google::Protobuf::MessageExts
|
71
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
72
|
+
end
|
73
|
+
|
74
|
+
# The possible states of the processor version.
|
75
|
+
module State
|
76
|
+
# The processor version is in an unspecified state.
|
77
|
+
STATE_UNSPECIFIED = 0
|
78
|
+
|
79
|
+
# The processor version is deployed and can be used for processing.
|
80
|
+
DEPLOYED = 1
|
81
|
+
|
82
|
+
# The processor version is being deployed.
|
83
|
+
DEPLOYING = 2
|
84
|
+
|
85
|
+
# The processor version is not deployed and cannot be used for processing.
|
86
|
+
UNDEPLOYED = 3
|
87
|
+
|
88
|
+
# The processor version is being undeployed.
|
89
|
+
UNDEPLOYING = 4
|
90
|
+
|
91
|
+
# The processor version is being created.
|
92
|
+
CREATING = 5
|
93
|
+
|
94
|
+
# The processor version is being deleted.
|
95
|
+
DELETING = 6
|
96
|
+
|
97
|
+
# The processor version failed and is in an indeterminate state.
|
98
|
+
FAILED = 7
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
# The first-class citizen for Document AI. Each processor defines how to
|
103
|
+
# extract structural information from a document.
|
26
104
|
# @!attribute [r] name
|
27
105
|
# @return [::String]
|
28
106
|
# Output only. Immutable. The resource name of the processor.
|
29
|
-
# Format: projects
|
107
|
+
# Format: `projects/{project}/locations/{location}/processors/{processor}`
|
30
108
|
# @!attribute [rw] type
|
31
109
|
# @return [::String]
|
32
|
-
# The processor type.
|
110
|
+
# The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
|
111
|
+
# To get a list of processors types, see
|
112
|
+
# {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
|
33
113
|
# @!attribute [rw] display_name
|
34
114
|
# @return [::String]
|
35
115
|
# The display name of the processor.
|
@@ -58,22 +138,30 @@ module Google
|
|
58
138
|
# The processor is in an unspecified state.
|
59
139
|
STATE_UNSPECIFIED = 0
|
60
140
|
|
61
|
-
# The processor is enabled.
|
141
|
+
# The processor is enabled, i.e., has an enabled version which can
|
142
|
+
# currently serve processing requests and all the feature dependencies have
|
143
|
+
# been successfully initialized.
|
62
144
|
ENABLED = 1
|
63
145
|
|
64
146
|
# The processor is disabled.
|
65
147
|
DISABLED = 2
|
66
148
|
|
67
|
-
# The processor is being enabled, will become ENABLED if successful.
|
149
|
+
# The processor is being enabled, will become `ENABLED` if successful.
|
68
150
|
ENABLING = 3
|
69
151
|
|
70
|
-
# The processor is being disabled, will become DISABLED if successful.
|
152
|
+
# The processor is being disabled, will become `DISABLED` if successful.
|
71
153
|
DISABLING = 4
|
72
154
|
|
73
|
-
# The processor is being created
|
155
|
+
# The processor is being created, will become either `ENABLED` (for
|
156
|
+
# successful creation) or `FAILED` (for failed ones).
|
157
|
+
# Once a processor is in this state, it can then be used for document
|
158
|
+
# processing, but the feature dependencies of the processor might not be
|
159
|
+
# fully created yet.
|
74
160
|
CREATING = 5
|
75
161
|
|
76
|
-
# The processor failed during creation
|
162
|
+
# The processor failed during creation or initialization of feature
|
163
|
+
# dependencies. The user should delete the processor and recreate one as
|
164
|
+
# all the functionalities of the processor are disabled.
|
77
165
|
FAILED = 6
|
78
166
|
|
79
167
|
# The processor is being deleted, will be removed if successful.
|
@@ -26,20 +26,23 @@ module Google
|
|
26
26
|
# @!attribute [rw] name
|
27
27
|
# @return [::String]
|
28
28
|
# The resource name of the processor type.
|
29
|
+
# Format: `projects/{project}/processorTypes/{processor_type}`
|
29
30
|
# @!attribute [rw] type
|
30
31
|
# @return [::String]
|
31
|
-
# The type
|
32
|
+
# The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
|
32
33
|
# @!attribute [rw] category
|
33
34
|
# @return [::String]
|
34
|
-
# The processor category.
|
35
|
+
# The processor category, used by UI to group processor types.
|
35
36
|
# @!attribute [rw] available_locations
|
36
37
|
# @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType::LocationInfo>]
|
37
38
|
# The locations in which this processor is available.
|
38
39
|
# @!attribute [rw] allow_creation
|
39
40
|
# @return [::Boolean]
|
40
|
-
# Whether the processor type allows creation. If
|
41
|
-
# processor of this processor type. Otherwise,
|
42
|
-
#
|
41
|
+
# Whether the processor type allows creation. If true, users can create a
|
42
|
+
# processor of this processor type. Otherwise, users need to request access.
|
43
|
+
# @!attribute [rw] launch_stage
|
44
|
+
# @return [::Google::Api::LaunchStage]
|
45
|
+
# Launch stage of the processor type
|
43
46
|
class ProcessorType
|
44
47
|
include ::Google::Protobuf::MessageExts
|
45
48
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -47,7 +50,7 @@ module Google
|
|
47
50
|
# The location information about where the processor is available.
|
48
51
|
# @!attribute [rw] location_id
|
49
52
|
# @return [::String]
|
50
|
-
# The location id.
|
53
|
+
# The location id, currently must be one of [us, eu].
|
51
54
|
class LocationInfo
|
52
55
|
include ::Google::Protobuf::MessageExts
|
53
56
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -26,8 +26,6 @@ module Google
|
|
26
26
|
# service Foo {
|
27
27
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
28
|
# }
|
29
|
-
#
|
30
|
-
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
29
|
class Empty
|
32
30
|
include ::Google::Protobuf::MessageExts
|
33
31
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
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.14.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-11-16 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.12'
|
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.12'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -44,6 +44,26 @@ dependencies:
|
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
46
|
version: '1.0'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: google-cloud-location
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0.0'
|
54
|
+
- - "<"
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: 2.a
|
57
|
+
type: :runtime
|
58
|
+
prerelease: false
|
59
|
+
version_requirements: !ruby/object:Gem::Requirement
|
60
|
+
requirements:
|
61
|
+
- - ">="
|
62
|
+
- !ruby/object:Gem::Version
|
63
|
+
version: '0.0'
|
64
|
+
- - "<"
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 2.a
|
47
67
|
- !ruby/object:Gem::Dependency
|
48
68
|
name: google-style
|
49
69
|
requirement: !ruby/object:Gem::Requirement
|
@@ -178,20 +198,28 @@ files:
|
|
178
198
|
- lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb
|
179
199
|
- lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb
|
180
200
|
- lib/google/cloud/document_ai/v1beta3/version.rb
|
201
|
+
- lib/google/cloud/documentai/v1beta3/barcode_pb.rb
|
181
202
|
- lib/google/cloud/documentai/v1beta3/document_io_pb.rb
|
182
203
|
- lib/google/cloud/documentai/v1beta3/document_pb.rb
|
183
204
|
- lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb
|
184
205
|
- lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb
|
206
|
+
- lib/google/cloud/documentai/v1beta3/document_schema_pb.rb
|
207
|
+
- lib/google/cloud/documentai/v1beta3/evaluation_pb.rb
|
185
208
|
- lib/google/cloud/documentai/v1beta3/geometry_pb.rb
|
186
209
|
- lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb
|
187
210
|
- lib/google/cloud/documentai/v1beta3/processor_pb.rb
|
188
211
|
- lib/google/cloud/documentai/v1beta3/processor_type_pb.rb
|
189
212
|
- proto_docs/README.md
|
213
|
+
- proto_docs/google/api/client.rb
|
190
214
|
- proto_docs/google/api/field_behavior.rb
|
215
|
+
- proto_docs/google/api/launch_stage.rb
|
191
216
|
- proto_docs/google/api/resource.rb
|
217
|
+
- proto_docs/google/cloud/documentai/v1beta3/barcode.rb
|
192
218
|
- proto_docs/google/cloud/documentai/v1beta3/document.rb
|
193
219
|
- proto_docs/google/cloud/documentai/v1beta3/document_io.rb
|
194
220
|
- proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
|
221
|
+
- proto_docs/google/cloud/documentai/v1beta3/document_schema.rb
|
222
|
+
- proto_docs/google/cloud/documentai/v1beta3/evaluation.rb
|
195
223
|
- proto_docs/google/cloud/documentai/v1beta3/geometry.rb
|
196
224
|
- proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb
|
197
225
|
- proto_docs/google/cloud/documentai/v1beta3/processor.rb
|