google-cloud-document_ai-v1beta3 0.28.0 → 0.30.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.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +34 -9
  4. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb +28 -6
  5. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb +36 -8
  6. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/operations.rb +33 -8
  7. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb +175 -8
  9. data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb +28 -6
  10. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb +170 -7
  11. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb +33 -8
  12. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb +74 -2
  13. data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
  14. data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +1 -1
  15. data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +2 -2
  16. data/lib/google/cloud/documentai/v1beta3/document_schema_pb.rb +5 -1
  17. data/lib/google/cloud/documentai/v1beta3/document_service_pb.rb +5 -1
  18. data/lib/google/cloud/documentai/v1beta3/document_service_services_pb.rb +2 -0
  19. data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +2 -1
  20. data/proto_docs/google/api/client.rb +14 -0
  21. data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb +1 -0
  22. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +14 -1
  23. data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +11 -3
  24. data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +26 -9
  25. data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +51 -0
  26. data/proto_docs/google/cloud/documentai/v1beta3/document_service.rb +115 -7
  27. data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +15 -0
  28. metadata +7 -7
@@ -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::V1beta3::Document::Style>]
48
49
  # Styles for the
49
50
  # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
@@ -214,6 +215,7 @@ module Google
214
215
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::ImageQualityScores]
215
216
  # Image quality scores.
216
217
  # @!attribute [rw] provenance
218
+ # @deprecated This field is deprecated and may be removed in the next major version update.
217
219
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
218
220
  # The history of this page.
219
221
  class Page
@@ -333,6 +335,7 @@ module Google
333
335
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
334
336
  # A list of detected languages together with confidence.
335
337
  # @!attribute [rw] provenance
338
+ # @deprecated This field is deprecated and may be removed in the next major version update.
336
339
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
337
340
  # The history of this annotation.
338
341
  class Block
@@ -349,6 +352,7 @@ module Google
349
352
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
350
353
  # A list of detected languages together with confidence.
351
354
  # @!attribute [rw] provenance
355
+ # @deprecated This field is deprecated and may be removed in the next major version update.
352
356
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
353
357
  # The history of this annotation.
354
358
  class Paragraph
@@ -366,6 +370,7 @@ module Google
366
370
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
367
371
  # A list of detected languages together with confidence.
368
372
  # @!attribute [rw] provenance
373
+ # @deprecated This field is deprecated and may be removed in the next major version update.
369
374
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
370
375
  # The history of this annotation.
371
376
  class Line
@@ -386,6 +391,7 @@ module Google
386
391
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
387
392
  # A list of detected languages together with confidence.
388
393
  # @!attribute [rw] provenance
394
+ # @deprecated This field is deprecated and may be removed in the next major version update.
389
395
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
390
396
  # The history of this annotation.
391
397
  # @!attribute [rw] style_info
@@ -523,6 +529,7 @@ module Google
523
529
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
524
530
  # A list of detected languages together with confidence.
525
531
  # @!attribute [rw] provenance
532
+ # @deprecated This field is deprecated and may be removed in the next major version update.
526
533
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
527
534
  # The history of this table.
528
535
  class Table
@@ -836,6 +843,7 @@ module Google
836
843
  # Optional. The type of the layout element that is being referenced if
837
844
  # any.
838
845
  # @!attribute [rw] layout_id
846
+ # @deprecated This field is deprecated and may be removed in the next major version update.
839
847
  # @return [::String]
840
848
  # Optional. Deprecated. Use
841
849
  # {::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
@@ -898,9 +906,11 @@ module Google
898
906
  # Structure to identify provenance relationships between annotations in
899
907
  # different revisions.
900
908
  # @!attribute [rw] revision
909
+ # @deprecated This field is deprecated and may be removed in the next major version update.
901
910
  # @return [::Integer]
902
911
  # The index of the revision that produced this element.
903
912
  # @!attribute [rw] id
913
+ # @deprecated This field is deprecated and may be removed in the next major version update.
904
914
  # @return [::Integer]
905
915
  # The Id of this operation. Needs to be unique within the scope of the
906
916
  # revision.
@@ -924,6 +934,7 @@ module Google
924
934
  # The index of the parent item in the corresponding item list (eg. list
925
935
  # of entities, properties within entities, etc.) in the parent revision.
926
936
  # @!attribute [rw] id
937
+ # @deprecated This field is deprecated and may be removed in the next major version update.
927
938
  # @return [::Integer]
928
939
  # The id of the parent provenance.
929
940
  class Parent
@@ -979,6 +990,7 @@ module Google
979
990
  # Id of the revision, internally generated by doc proto storage.
980
991
  # Unique within the context of the document.
981
992
  # @!attribute [rw] parent
993
+ # @deprecated This field is deprecated and may be removed in the next major version update.
982
994
  # @return [::Array<::Integer>]
983
995
  # The revisions that this revision is based on. This can include one or
984
996
  # more parent (when documents are merged.) This field represents the
@@ -1026,6 +1038,7 @@ module Google
1026
1038
  # @return [::String]
1027
1039
  # The text that replaces the text identified in the `text_anchor`.
1028
1040
  # @!attribute [rw] provenance
1041
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1029
1042
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance>]
1030
1043
  # The history of this annotation.
1031
1044
  class TextChange
@@ -1052,7 +1065,7 @@ module Google
1052
1065
 
1053
1066
  # Some predefined revision cases.
1054
1067
  module RevisionCase
1055
- # Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.
1068
+ # Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.
1056
1069
  REVISION_CASE_UNSPECIFIED = 0
1057
1070
 
1058
1071
  # The latest revision made by a human.
@@ -29,6 +29,13 @@ module Google
29
29
  # @return [::String]
30
30
  # An IANA MIME type (RFC6838) indicating the nature and format of the
31
31
  # {::Google::Cloud::DocumentAI::V1beta3::RawDocument#content content}.
32
+ # @!attribute [rw] display_name
33
+ # @return [::String]
34
+ # The display name of the document, it supports all Unicode characters except
35
+ # the following:
36
+ # `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, `,`
37
+ # `~`, `=` and `:` are reserved.
38
+ # If not specified, a default ID is generated.
32
39
  class RawDocument
33
40
  include ::Google::Protobuf::MessageExts
34
41
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,6 +148,7 @@ module Google
141
148
  # @return [::Boolean]
142
149
  # Includes symbol level OCR information if set to true.
143
150
  # @!attribute [rw] compute_style_info
151
+ # @deprecated This field is deprecated and may be removed in the next major version update.
144
152
  # @return [::Boolean]
145
153
  # Turn on font identification model and return font style information.
146
154
  # Deprecated, use
@@ -149,7 +157,7 @@ module Google
149
157
  # @!attribute [rw] disable_character_boxes_detection
150
158
  # @return [::Boolean]
151
159
  # Turn off character box detector in OCR engine. Character box detection is
152
- # enabled by default in OCR 2.0+ processors.
160
+ # enabled by default in OCR 2.0 (and later) processors.
153
161
  # @!attribute [rw] premium_features
154
162
  # @return [::Google::Cloud::DocumentAI::V1beta3::OcrConfig::PremiumFeatures]
155
163
  # Configurations for premium OCR features.
@@ -174,8 +182,8 @@ module Google
174
182
  # Configurations for premium OCR features.
175
183
  # @!attribute [rw] enable_selection_mark_detection
176
184
  # @return [::Boolean]
177
- # Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
178
- # processors.
185
+ # Turn on selection mark detector in OCR engine. Only available in OCR 2.0
186
+ # (and later) processors.
179
187
  # @!attribute [rw] compute_style_info
180
188
  # @return [::Boolean]
181
189
  # Turn on font identification model and return font style information.
@@ -27,8 +27,8 @@ module Google
27
27
  # Which pages to process (1-indexed).
28
28
  # @!attribute [rw] from_start
29
29
  # @return [::Integer]
30
- # Only process certain pages from the start, process all if the document
31
- # has less pages.
30
+ # Only process certain pages from the start. Process all if the document
31
+ # has fewer pages.
32
32
  # @!attribute [rw] from_end
33
33
  # @return [::Integer]
34
34
  # Only process certain pages from the end, same as above.
@@ -36,6 +36,13 @@ module Google
36
36
  # @return [::Google::Cloud::DocumentAI::V1beta3::OcrConfig]
37
37
  # Only applicable to `OCR_PROCESSOR`. Returns error if set on other
38
38
  # processor types.
39
+ # @!attribute [rw] schema_override
40
+ # @return [::Google::Cloud::DocumentAI::V1beta3::DocumentSchema]
41
+ # Optional. Override the schema of the
42
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}. Will
43
+ # return an Invalid Argument error if this field is set when the underlying
44
+ # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}
45
+ # doesn't support schema override.
39
46
  class ProcessOptions
40
47
  include ::Google::Protobuf::MessageExts
41
48
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -75,6 +82,7 @@ module Google
75
82
  # or
76
83
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
77
84
  # @!attribute [rw] document
85
+ # @deprecated This field is deprecated and may be removed in the next major version update.
78
86
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document]
79
87
  # The document payload, the
80
88
  # {::Google::Cloud::DocumentAI::V1beta3::Document#content content} and
@@ -148,6 +156,7 @@ module Google
148
156
  # The document payload, will populate fields based on the processor's
149
157
  # behavior.
150
158
  # @!attribute [rw] human_review_operation
159
+ # @deprecated This field is deprecated and may be removed in the next major version update.
151
160
  # @return [::String]
152
161
  # The name of the operation triggered by the processed document. If the human
153
162
  # review process isn't triggered, this field is empty. It has the same
@@ -172,9 +181,11 @@ module Google
172
181
  # or
173
182
  # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
174
183
  # @!attribute [rw] input_configs
184
+ # @deprecated This field is deprecated and may be removed in the next major version update.
175
185
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchInputConfig>]
176
186
  # The input config for each single document in the batch process.
177
187
  # @!attribute [rw] output_config
188
+ # @deprecated This field is deprecated and may be removed in the next major version update.
178
189
  # @return [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig]
179
190
  # The overall output config for batch process.
180
191
  # @!attribute [rw] input_documents
@@ -199,6 +210,7 @@ module Google
199
210
  extend ::Google::Protobuf::MessageExts::ClassMethods
200
211
 
201
212
  # The message for input config in batch process.
213
+ # @deprecated This message is deprecated and may be removed in the next major version update.
202
214
  # @!attribute [rw] gcs_source
203
215
  # @return [::String]
204
216
  # The Cloud Storage location as the source of the document.
@@ -219,6 +231,7 @@ module Google
219
231
  # The output configuration in the
220
232
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}
221
233
  # method.
234
+ # @deprecated This message is deprecated and may be removed in the next major version update.
222
235
  # @!attribute [rw] gcs_destination
223
236
  # @return [::String]
224
237
  # The output Cloud Storage directory to put the processed documents.
@@ -272,6 +285,7 @@ module Google
272
285
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
273
286
  # of the processed document if it was successful, otherwise empty.
274
287
  # @!attribute [rw] human_review_operation
288
+ # @deprecated This field is deprecated and may be removed in the next major version update.
275
289
  # @return [::String]
276
290
  # The name of the operation triggered by the processed document. If the
277
291
  # human review process isn't triggered, this field will be empty. It has
@@ -746,8 +760,8 @@ module Google
746
760
  include ::Google::Protobuf::MessageExts
747
761
  extend ::Google::Protobuf::MessageExts::ClassMethods
748
762
 
749
- # Training Method for CDE. TRAINING_METHOD_UNSPECIFIED will fallback to
750
- # MODEL_BASED.
763
+ # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
764
+ # `MODEL_BASED`.
751
765
  module TrainingMethod
752
766
  TRAINING_METHOD_UNSPECIFIED = 0
753
767
 
@@ -818,6 +832,7 @@ module Google
818
832
  # [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
819
833
  # the document will be reviewed with.
820
834
  # @!attribute [rw] document
835
+ # @deprecated This field is deprecated and may be removed in the next major version update.
821
836
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document]
822
837
  # The document that needs human review.
823
838
  # @!attribute [rw] enable_schema_validation
@@ -1010,9 +1025,9 @@ module Google
1010
1025
 
1011
1026
  # The request message for the
1012
1027
  # {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#import_processor_version ImportProcessorVersion}
1013
- # method. Requirements:
1028
+ # method.
1014
1029
  #
1015
- # - The Document AI [Service
1030
+ # The Document AI [Service
1016
1031
  # Agent](https://cloud.google.com/iam/docs/service-agents) of the destination
1017
1032
  # project must have [Document AI Editor
1018
1033
  # role](https://cloud.google.com/document-ai/docs/access-control/iam-roles) on
@@ -1021,15 +1036,17 @@ module Google
1021
1036
  # The destination project is specified as part of the
1022
1037
  # {::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest#parent parent}
1023
1038
  # field. The source project is specified as part of the
1024
- # [source][ImportProcessorVersionRequest.processor_version_source or
1025
- # ImportProcessorVersionRequest.external_processor_version_source] field.
1039
+ # {::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest#processor_version_source source}
1040
+ # or
1041
+ # {::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest#external_processor_version_source external_processor_version_source}
1042
+ # field.
1026
1043
  # @!attribute [rw] processor_version_source
1027
1044
  # @return [::String]
1028
1045
  # The source processor version to import from. The source processor version
1029
1046
  # and destination processor need to be in the same environment and region.
1030
1047
  # @!attribute [rw] external_processor_version_source
1031
1048
  # @return [::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest::ExternalProcessorVersionSource]
1032
- # The source processor version to import from, and can be from different
1049
+ # The source processor version to import from. It can be from a different
1033
1050
  # environment and region than the destination processor.
1034
1051
  # @!attribute [rw] parent
1035
1052
  # @return [::String]
@@ -21,10 +21,61 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1beta3
24
+ # Metadata for document summarization.
25
+ # @!attribute [rw] length
26
+ # @return [::Google::Cloud::DocumentAI::V1beta3::SummaryOptions::Length]
27
+ # How long the summary should be.
28
+ # @!attribute [rw] format
29
+ # @return [::Google::Cloud::DocumentAI::V1beta3::SummaryOptions::Format]
30
+ # The format the summary should be in.
31
+ class SummaryOptions
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+
35
+ # The Length enum.
36
+ module Length
37
+ # Default.
38
+ LENGTH_UNSPECIFIED = 0
39
+
40
+ # A brief summary of one or two sentences.
41
+ BRIEF = 1
42
+
43
+ # A paragraph-length summary.
44
+ MODERATE = 2
45
+
46
+ # The longest option available.
47
+ COMPREHENSIVE = 3
48
+ end
49
+
50
+ # The Format enum.
51
+ module Format
52
+ # Default.
53
+ FORMAT_UNSPECIFIED = 0
54
+
55
+ # Format the output in paragraphs.
56
+ PARAGRAPH = 1
57
+
58
+ # Format the output in bullets.
59
+ BULLETS = 2
60
+ end
61
+ end
62
+
63
+ # Metadata for how this field value is extracted.
64
+ # @!attribute [rw] summary_options
65
+ # @return [::Google::Cloud::DocumentAI::V1beta3::SummaryOptions]
66
+ # Summary options config.
67
+ class FieldExtractionMetadata
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
24
72
  # Metadata about a property.
25
73
  # @!attribute [rw] inactive
26
74
  # @return [::Boolean]
27
75
  # Whether the property should be considered as "inactive".
76
+ # @!attribute [rw] field_extraction_metadata
77
+ # @return [::Google::Cloud::DocumentAI::V1beta3::FieldExtractionMetadata]
78
+ # Field extraction metadata on the property.
28
79
  class PropertyMetadata
29
80
  include ::Google::Protobuf::MessageExts
30
81
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -35,7 +35,7 @@ module Google
35
35
 
36
36
  # @!attribute [rw] common_metadata
37
37
  # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
38
- # The basic metadata of the long running operation.
38
+ # The basic metadata of the long-running operation.
39
39
  class UpdateDatasetOperationMetadata
40
40
  include ::Google::Protobuf::MessageExts
41
41
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -90,7 +90,7 @@ module Google
90
90
  # Metadata of the import document operation.
91
91
  # @!attribute [rw] common_metadata
92
92
  # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
93
- # The basic metadata of the long running operation.
93
+ # The basic metadata of the long-running operation.
94
94
  # @!attribute [rw] individual_import_statuses
95
95
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsMetadata::IndividualImportStatus>]
96
96
  # The list of response details of each document.
@@ -120,9 +120,9 @@ module Google
120
120
  extend ::Google::Protobuf::MessageExts::ClassMethods
121
121
  end
122
122
 
123
- # The validation status of each import config. Status is set to errors if
124
- # there is no documents to import in the import_config, or OK if the
125
- # operation will try to proceed at least one document.
123
+ # The validation status of each import config. Status is set to an error if
124
+ # there are no documents to import in the `import_config`, or `OK` if the
125
+ # operation will try to proceed with at least one document.
126
126
  # @!attribute [rw] input_gcs_source
127
127
  # @return [::String]
128
128
  # The source Cloud Storage URI specified in the import config.
@@ -163,6 +163,79 @@ module Google
163
163
  extend ::Google::Protobuf::MessageExts::ClassMethods
164
164
  end
165
165
 
166
+ # @!attribute [rw] dataset
167
+ # @return [::String]
168
+ # Required. The resource name of the dataset to be listed.
169
+ # Format:
170
+ # projects/\\{project}/locations/\\{location}/processors/\\{processor}/dataset
171
+ # @!attribute [rw] page_size
172
+ # @return [::Integer]
173
+ # The maximum number of documents to return. The service may return
174
+ # fewer than this value.
175
+ # If unspecified, at most 20 documents will be returned.
176
+ # The maximum value is 100; values above 100 will be coerced to 100.
177
+ # @!attribute [rw] page_token
178
+ # @return [::String]
179
+ # A page token, received from a previous `ListDocuments` call.
180
+ # Provide this to retrieve the subsequent page.
181
+ #
182
+ # When paginating, all other parameters provided to `ListDocuments`
183
+ # must match the call that provided the page token.
184
+ # @!attribute [rw] filter
185
+ # @return [::String]
186
+ # Optional. Query to filter the documents based on
187
+ # https://google.aip.dev/160.
188
+ # ## Currently support query strings are:
189
+ #
190
+ # `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
191
+ # - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
192
+ # - `DisplayName=\"file_name.pdf\"`
193
+ # - `EntityType=abc/def`
194
+ # - `TagName=\"auto-labeling-running\"|\"sampled\"`
195
+ #
196
+ # Note:
197
+ # - Only `AND`, `=` and `!=` are supported.
198
+ # e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
199
+ # - Wildcard `*` is supported only in `DisplayName` filter
200
+ # - No duplicate filter keys are allowed,
201
+ # e.g. `EntityType=a AND EntityType=b` is NOT supported.
202
+ # - String match is case sensitive (for filter `DisplayName` & `EntityType`).
203
+ # @!attribute [rw] return_total_size
204
+ # @return [::Boolean]
205
+ # Optional. Controls if the ListDocuments request requires a total size
206
+ # of matched documents. See ListDocumentsResponse.total_size.
207
+ #
208
+ # Enabling this flag may adversely impact performance.
209
+ #
210
+ # Defaults to false.
211
+ # @!attribute [rw] skip
212
+ # @return [::Integer]
213
+ # Optional. Number of results to skip beginning from the `page_token` if
214
+ # provided. https://google.aip.dev/158#skipping-results. It must be a
215
+ # non-negative integer. Negative values wil be rejected. Note that this is
216
+ # not the number of pages to skip. If this value causes the cursor to move
217
+ # past the end of results, `ListDocumentsResponse.document_metadata` and
218
+ # `ListDocumentsResponse.next_page_token` will be empty.
219
+ class ListDocumentsRequest
220
+ include ::Google::Protobuf::MessageExts
221
+ extend ::Google::Protobuf::MessageExts::ClassMethods
222
+ end
223
+
224
+ # @!attribute [rw] document_metadata
225
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::DocumentMetadata>]
226
+ # Document metadata corresponding to the listed documents.
227
+ # @!attribute [rw] next_page_token
228
+ # @return [::String]
229
+ # A token, which can be sent as `page_token` to retrieve the next page.
230
+ # If this field is omitted, there are no subsequent pages.
231
+ # @!attribute [rw] total_size
232
+ # @return [::Integer]
233
+ # Total count of documents queried.
234
+ class ListDocumentsResponse
235
+ include ::Google::Protobuf::MessageExts
236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
237
+ end
238
+
166
239
  # @!attribute [rw] dataset
167
240
  # @return [::String]
168
241
  # Required. The dataset resource name.
@@ -187,7 +260,7 @@ module Google
187
260
 
188
261
  # @!attribute [rw] common_metadata
189
262
  # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
190
- # The basic metadata of the long running operation.
263
+ # The basic metadata of the long-running operation.
191
264
  # @!attribute [rw] individual_batch_delete_statuses
192
265
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsMetadata::IndividualBatchDeleteStatus>]
193
266
  # The list of response details of each document.
@@ -253,11 +326,31 @@ module Google
253
326
  extend ::Google::Protobuf::MessageExts::ClassMethods
254
327
  end
255
328
 
329
+ # Metadata about a document.
330
+ # @!attribute [rw] document_id
331
+ # @return [::Google::Cloud::DocumentAI::V1beta3::DocumentId]
332
+ # Document identifier.
333
+ # @!attribute [rw] page_count
334
+ # @return [::Integer]
335
+ # Number of pages in the document.
336
+ # @!attribute [rw] dataset_type
337
+ # @return [::Google::Cloud::DocumentAI::V1beta3::DatasetSplitType]
338
+ # Type of the dataset split to which the document belongs.
339
+ # @!attribute [rw] labeling_state
340
+ # @return [::Google::Cloud::DocumentAI::V1beta3::DocumentLabelingState]
341
+ # Labelling state of the document.
342
+ # @!attribute [rw] display_name
343
+ # @return [::String]
344
+ # The display name of the document.
345
+ class DocumentMetadata
346
+ include ::Google::Protobuf::MessageExts
347
+ extend ::Google::Protobuf::MessageExts::ClassMethods
348
+ end
349
+
256
350
  # Documents belonging to a dataset will be split into different groups
257
351
  # referred to as splits: train, test.
258
352
  module DatasetSplitType
259
353
  # Default value if the enum is not set.
260
- # go/protodosdonts#do-include-an-unspecified-value-in-an-enum
261
354
  DATASET_SPLIT_TYPE_UNSPECIFIED = 0
262
355
 
263
356
  # Identifies the train documents.
@@ -269,6 +362,21 @@ module Google
269
362
  # Identifies the unassigned documents.
270
363
  DATASET_SPLIT_UNASSIGNED = 3
271
364
  end
365
+
366
+ # Describes the labelling status of a document.
367
+ module DocumentLabelingState
368
+ # Default value if the enum is not set.
369
+ DOCUMENT_LABELING_STATE_UNSPECIFIED = 0
370
+
371
+ # Document has been labelled.
372
+ DOCUMENT_LABELED = 1
373
+
374
+ # Document has not been labelled.
375
+ DOCUMENT_UNLABELED = 2
376
+
377
+ # Document has been auto-labelled.
378
+ DOCUMENT_AUTO_LABELED = 3
379
+ end
272
380
  end
273
381
  end
274
382
  end
@@ -104,6 +104,18 @@ module Google
104
104
  end
105
105
  end
106
106
 
107
+ # Contains the alias and the aliased resource name of processor version.
108
+ # @!attribute [rw] alias
109
+ # @return [::String]
110
+ # The alias in the form of `processor_version` resource name.
111
+ # @!attribute [rw] processor_version
112
+ # @return [::String]
113
+ # The resource name of aliased processor version.
114
+ class ProcessorVersionAlias
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
107
119
  # The first-class citizen for Document AI. Each processor defines how to
108
120
  # extract structural information from a document.
109
121
  # @!attribute [r] name
@@ -124,6 +136,9 @@ module Google
124
136
  # @!attribute [rw] default_processor_version
125
137
  # @return [::String]
126
138
  # The default processor version.
139
+ # @!attribute [r] processor_version_aliases
140
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorVersionAlias>]
141
+ # Output only. The processor version aliases.
127
142
  # @!attribute [r] process_endpoint
128
143
  # @return [::String]
129
144
  # Output only. Immutable. The http endpoint that can be called to invoke
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.28.0
4
+ version: 0.30.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: 2023-09-14 00:00:00.000000000 Z
11
+ date: 2024-01-11 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.20.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.20.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.4'
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.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -276,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
276
276
  - !ruby/object:Gem::Version
277
277
  version: '0'
278
278
  requirements: []
279
- rubygems_version: 3.4.19
279
+ rubygems_version: 3.5.3
280
280
  signing_key:
281
281
  specification_version: 4
282
282
  summary: Service to parse structured information from unstructured or semi-structured