google-cloud-document_ai-v1 0.5.0 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +2 -0
- data/lib/google/cloud/document_ai/v1/version.rb +1 -1
- data/lib/google/cloud/documentai/v1/document_io_pb.rb +3 -0
- data/lib/google/cloud/documentai/v1/document_pb.rb +13 -0
- data/lib/google/cloud/documentai/v1/processor_pb.rb +2 -0
- data/proto_docs/google/cloud/documentai/v1/barcode.rb +29 -27
- data/proto_docs/google/cloud/documentai/v1/document.rb +55 -11
- data/proto_docs/google/cloud/documentai/v1/document_io.rb +7 -2
- data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +2 -0
- data/proto_docs/google/cloud/documentai/v1/document_schema.rb +4 -3
- data/proto_docs/google/cloud/documentai/v1/processor.rb +8 -5
- data/proto_docs/google/cloud/documentai/v1/processor_type.rb +2 -2
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 90b5a3c9e7d05297c9a6f2d2c351ce1bb121f1e92ff77ada6042883859350795
|
4
|
+
data.tar.gz: bf0fd6fd65d030fe8c0e77465651a585d9d5c1007e3b97c26535614a0a01c7c3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a57b551259eb706e50343c7d5c29e9d1281e96a57d0b21e1557c93e19e2c6b93cb446bb542cdfecb6a95d16d27ee4cfa45d7f568673303fe6948476ee0f7e479
|
7
|
+
data.tar.gz: ebe7406306f10d17d25abf459bb0949e8babc59b2075dcf5ba88e1267003b2ffec71921d065f6a24dc49e8904d162af3f1561d796dc71d385da6cafd1055e7b5
|
data/AUTHENTICATION.md
CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
|
|
114
114
|
To configure your system for this, simply:
|
115
115
|
|
116
116
|
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
117
|
-
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
|
117
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
|
118
118
|
3. Write code as if already authenticated.
|
119
119
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
@@ -223,6 +223,8 @@ module Google
|
|
223
223
|
# false.
|
224
224
|
# @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
|
225
225
|
# Specifies which fields to include in ProcessResponse's document.
|
226
|
+
# Only supports top level document and pages field so it must be in the form
|
227
|
+
# of `{document_field_name}` or `pages.{page_field_name}`.
|
226
228
|
#
|
227
229
|
# @yield [response, operation] Access the result along with the RPC operation
|
228
230
|
# @yieldparam response [::Google::Cloud::DocumentAI::V1::ProcessResponse]
|
@@ -3,6 +3,8 @@
|
|
3
3
|
|
4
4
|
require 'google/protobuf'
|
5
5
|
|
6
|
+
require 'google/protobuf/field_mask_pb'
|
7
|
+
|
6
8
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
7
9
|
add_file("google/cloud/documentai/v1/document_io.proto", :syntax => :proto3) do
|
8
10
|
add_message "google.cloud.documentai.v1.RawDocument" do
|
@@ -32,6 +34,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
32
34
|
end
|
33
35
|
add_message "google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig" do
|
34
36
|
optional :gcs_uri, :string, 1
|
37
|
+
optional :field_mask, :message, 2, "google.protobuf.FieldMask"
|
35
38
|
end
|
36
39
|
end
|
37
40
|
end
|
@@ -45,6 +45,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
45
45
|
optional :text_style, :string, 5
|
46
46
|
optional :text_decoration, :string, 6
|
47
47
|
optional :font_size, :message, 7, "google.cloud.documentai.v1.Document.Style.FontSize"
|
48
|
+
optional :font_family, :string, 8
|
48
49
|
end
|
49
50
|
add_message "google.cloud.documentai.v1.Document.Style.FontSize" do
|
50
51
|
optional :size, :float, 1
|
@@ -66,6 +67,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
66
67
|
repeated :form_fields, :message, 11, "google.cloud.documentai.v1.Document.Page.FormField"
|
67
68
|
repeated :symbols, :message, 12, "google.cloud.documentai.v1.Document.Page.Symbol"
|
68
69
|
repeated :detected_barcodes, :message, 15, "google.cloud.documentai.v1.Document.Page.DetectedBarcode"
|
70
|
+
optional :image_quality_scores, :message, 17, "google.cloud.documentai.v1.Document.Page.ImageQualityScores"
|
69
71
|
optional :provenance, :message, 16, "google.cloud.documentai.v1.Document.Provenance"
|
70
72
|
end
|
71
73
|
add_message "google.cloud.documentai.v1.Document.Page.Dimension" do
|
@@ -142,6 +144,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
142
144
|
repeated :header_rows, :message, 2, "google.cloud.documentai.v1.Document.Page.Table.TableRow"
|
143
145
|
repeated :body_rows, :message, 3, "google.cloud.documentai.v1.Document.Page.Table.TableRow"
|
144
146
|
repeated :detected_languages, :message, 4, "google.cloud.documentai.v1.Document.Page.DetectedLanguage"
|
147
|
+
optional :provenance, :message, 5, "google.cloud.documentai.v1.Document.Provenance"
|
145
148
|
end
|
146
149
|
add_message "google.cloud.documentai.v1.Document.Page.Table.TableRow" do
|
147
150
|
repeated :cells, :message, 1, "google.cloud.documentai.v1.Document.Page.Table.TableCell"
|
@@ -170,6 +173,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
170
173
|
optional :language_code, :string, 1
|
171
174
|
optional :confidence, :float, 2
|
172
175
|
end
|
176
|
+
add_message "google.cloud.documentai.v1.Document.Page.ImageQualityScores" do
|
177
|
+
optional :quality_score, :float, 1
|
178
|
+
repeated :detected_defects, :message, 2, "google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect"
|
179
|
+
end
|
180
|
+
add_message "google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect" do
|
181
|
+
optional :type, :string, 1
|
182
|
+
optional :confidence, :float, 2
|
183
|
+
end
|
173
184
|
add_message "google.cloud.documentai.v1.Document.Entity" do
|
174
185
|
optional :text_anchor, :message, 1, "google.cloud.documentai.v1.Document.TextAnchor"
|
175
186
|
optional :type, :string, 2
|
@@ -299,6 +310,8 @@ module Google
|
|
299
310
|
Document::Page::FormField = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.FormField").msgclass
|
300
311
|
Document::Page::DetectedBarcode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.DetectedBarcode").msgclass
|
301
312
|
Document::Page::DetectedLanguage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.DetectedLanguage").msgclass
|
313
|
+
Document::Page::ImageQualityScores = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.ImageQualityScores").msgclass
|
314
|
+
Document::Page::ImageQualityScores::DetectedDefect = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect").msgclass
|
302
315
|
Document::Entity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Entity").msgclass
|
303
316
|
Document::Entity::NormalizedValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.Entity.NormalizedValue").msgclass
|
304
317
|
Document::EntityRelation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.Document.EntityRelation").msgclass
|
@@ -5,6 +5,7 @@ require 'google/protobuf'
|
|
5
5
|
|
6
6
|
require 'google/api/field_behavior_pb'
|
7
7
|
require 'google/api/resource_pb'
|
8
|
+
require 'google/cloud/documentai/v1/document_schema_pb'
|
8
9
|
require 'google/protobuf/timestamp_pb'
|
9
10
|
|
10
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
@@ -12,6 +13,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
12
13
|
add_message "google.cloud.documentai.v1.ProcessorVersion" do
|
13
14
|
optional :name, :string, 1
|
14
15
|
optional :display_name, :string, 2
|
16
|
+
optional :document_schema, :message, 12, "google.cloud.documentai.v1.DocumentSchema"
|
15
17
|
optional :state, :enum, 6, "google.cloud.documentai.v1.ProcessorVersion.State"
|
16
18
|
optional :create_time, :message, 7, "google.protobuf.Timestamp"
|
17
19
|
optional :kms_key_name, :string, 9
|
@@ -26,41 +26,43 @@ module Google
|
|
26
26
|
# @return [::String]
|
27
27
|
# Format of a barcode.
|
28
28
|
# The supported formats are:
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
29
|
+
#
|
30
|
+
# - `CODE_128`: Code 128 type.
|
31
|
+
# - `CODE_39`: Code 39 type.
|
32
|
+
# - `CODE_93`: Code 93 type.
|
33
|
+
# - `CODABAR`: Codabar type.
|
34
|
+
# - `DATA_MATRIX`: 2D Data Matrix type.
|
35
|
+
# - `ITF`: ITF type.
|
36
|
+
# - `EAN_13`: EAN-13 type.
|
37
|
+
# - `EAN_8`: EAN-8 type.
|
38
|
+
# - `QR_CODE`: 2D QR code type.
|
39
|
+
# - `UPC_A`: UPC-A type.
|
40
|
+
# - `UPC_E`: UPC-E type.
|
41
|
+
# - `PDF417`: PDF417 type.
|
42
|
+
# - `AZTEC`: 2D Aztec code type.
|
43
|
+
# - `DATABAR`: GS1 DataBar code type.
|
43
44
|
# @!attribute [rw] value_format
|
44
45
|
# @return [::String]
|
45
46
|
# Value format describes the format of the value that a barcode
|
46
47
|
# encodes.
|
47
48
|
# The supported formats are:
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
49
|
+
#
|
50
|
+
# - `CONTACT_INFO`: Contact information.
|
51
|
+
# - `EMAIL`: Email address.
|
52
|
+
# - `ISBN`: ISBN identifier.
|
53
|
+
# - `PHONE`: Phone number.
|
54
|
+
# - `PRODUCT`: Product.
|
55
|
+
# - `SMS`: SMS message.
|
56
|
+
# - `TEXT`: Text string.
|
57
|
+
# - `URL`: URL address.
|
58
|
+
# - `WIFI`: Wifi information.
|
59
|
+
# - `GEO`: Geo-localization.
|
60
|
+
# - `CALENDAR_EVENT`: Calendar event.
|
61
|
+
# - `DRIVER_LICENSE`: Driver's license.
|
60
62
|
# @!attribute [rw] raw_value
|
61
63
|
# @return [::String]
|
62
64
|
# Raw value encoded in the barcode.
|
63
|
-
# For example
|
65
|
+
# For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
|
64
66
|
class Barcode
|
65
67
|
include ::Google::Protobuf::MessageExts
|
66
68
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -60,9 +60,9 @@ module Google
|
|
60
60
|
# Placeholder. Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
|
61
61
|
# @!attribute [rw] text_changes
|
62
62
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>]
|
63
|
-
# Placeholder. A list of text corrections made to
|
64
|
-
# usually used for annotating corrections to OCR mistakes. Text changes
|
65
|
-
# a given revision may not overlap with each other.
|
63
|
+
# Placeholder. A list of text corrections made to {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. This
|
64
|
+
# is usually used for annotating corrections to OCR mistakes. Text changes
|
65
|
+
# for a given revision may not overlap with each other.
|
66
66
|
# @!attribute [rw] shard_info
|
67
67
|
# @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo]
|
68
68
|
# Information about the sharding if this document is sharded part of a larger
|
@@ -122,6 +122,10 @@ module Google
|
|
122
122
|
# @!attribute [rw] font_size
|
123
123
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Style::FontSize]
|
124
124
|
# Font size.
|
125
|
+
# @!attribute [rw] font_family
|
126
|
+
# @return [::String]
|
127
|
+
# Font family such as `Arial`, `Times New Roman`.
|
128
|
+
# https://www.w3schools.com/cssref/pr_font_font-family.asp
|
125
129
|
class Style
|
126
130
|
include ::Google::Protobuf::MessageExts
|
127
131
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -195,6 +199,9 @@ module Google
|
|
195
199
|
# @!attribute [rw] detected_barcodes
|
196
200
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode>]
|
197
201
|
# A list of detected barcodes.
|
202
|
+
# @!attribute [rw] image_quality_scores
|
203
|
+
# @return [::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores]
|
204
|
+
# Image Quality Scores.
|
198
205
|
# @!attribute [rw] provenance
|
199
206
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
200
207
|
# The history of this page.
|
@@ -265,7 +272,7 @@ module Google
|
|
265
272
|
# @return [::Float]
|
266
273
|
# Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within context of the object this
|
267
274
|
# layout is for. e.g. confidence can be for a single token, a table,
|
268
|
-
# a visual element, etc. depending on context. Range [0, 1]
|
275
|
+
# a visual element, etc. depending on context. Range `[0, 1]`.
|
269
276
|
# @!attribute [rw] bounding_poly
|
270
277
|
# @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
|
271
278
|
# The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
|
@@ -357,7 +364,7 @@ module Google
|
|
357
364
|
# A list of detected languages together with confidence.
|
358
365
|
# @!attribute [rw] provenance
|
359
366
|
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
360
|
-
# The
|
367
|
+
# The history of this annotation.
|
361
368
|
class Token
|
362
369
|
include ::Google::Protobuf::MessageExts
|
363
370
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -428,6 +435,9 @@ module Google
|
|
428
435
|
# @!attribute [rw] detected_languages
|
429
436
|
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
|
430
437
|
# A list of detected languages together with confidence.
|
438
|
+
# @!attribute [rw] provenance
|
439
|
+
# @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
|
440
|
+
# The history of this table.
|
431
441
|
class Table
|
432
442
|
include ::Google::Protobuf::MessageExts
|
433
443
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -514,16 +524,50 @@ module Google
|
|
514
524
|
# Detected language for a structural component.
|
515
525
|
# @!attribute [rw] language_code
|
516
526
|
# @return [::String]
|
517
|
-
# The BCP-47 language code, such as
|
527
|
+
# The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
|
518
528
|
# information, see
|
519
529
|
# https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
520
530
|
# @!attribute [rw] confidence
|
521
531
|
# @return [::Float]
|
522
|
-
# Confidence of detected language. Range [0, 1]
|
532
|
+
# Confidence of detected language. Range `[0, 1]`.
|
523
533
|
class DetectedLanguage
|
524
534
|
include ::Google::Protobuf::MessageExts
|
525
535
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
526
536
|
end
|
537
|
+
|
538
|
+
# Image Quality Scores for the page image
|
539
|
+
# @!attribute [rw] quality_score
|
540
|
+
# @return [::Float]
|
541
|
+
# The overall quality score. Range `[0, 1]` where 1 is perfect quality.
|
542
|
+
# @!attribute [rw] detected_defects
|
543
|
+
# @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::ImageQualityScores::DetectedDefect>]
|
544
|
+
# A list of detected defects.
|
545
|
+
class ImageQualityScores
|
546
|
+
include ::Google::Protobuf::MessageExts
|
547
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
548
|
+
|
549
|
+
# Image Quality Defects
|
550
|
+
# @!attribute [rw] type
|
551
|
+
# @return [::String]
|
552
|
+
# Name of the defect type. Supported values are:
|
553
|
+
#
|
554
|
+
# - `quality/defect_blurry`
|
555
|
+
# - `quality/defect_noisy`
|
556
|
+
# - `quality/defect_dark`
|
557
|
+
# - `quality/defect_faint`
|
558
|
+
# - `quality/defect_text_too_small`
|
559
|
+
# - `quality/defect_document_cutoff`
|
560
|
+
# - `quality/defect_text_cutoff`
|
561
|
+
# - `quality/defect_glare`
|
562
|
+
# @!attribute [rw] confidence
|
563
|
+
# @return [::Float]
|
564
|
+
# Confidence of detected defect. Range `[0, 1]` where 1 indicates
|
565
|
+
# strong confidence of that the defect exists.
|
566
|
+
class DetectedDefect
|
567
|
+
include ::Google::Protobuf::MessageExts
|
568
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
569
|
+
end
|
570
|
+
end
|
527
571
|
end
|
528
572
|
|
529
573
|
# An entity that could be a phrase in the text or a property that belongs to
|
@@ -538,14 +582,13 @@ module Google
|
|
538
582
|
# Required. Entity type from a schema e.g. `Address`.
|
539
583
|
# @!attribute [rw] mention_text
|
540
584
|
# @return [::String]
|
541
|
-
# Optional. Text value
|
542
|
-
# is not present in the document, this field will be empty.
|
585
|
+
# Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
|
543
586
|
# @!attribute [rw] mention_id
|
544
587
|
# @return [::String]
|
545
588
|
# Optional. Deprecated. Use `id` field instead.
|
546
589
|
# @!attribute [rw] confidence
|
547
590
|
# @return [::Float]
|
548
|
-
# Optional. Confidence of detected Schema entity. Range [0, 1]
|
591
|
+
# Optional. Confidence of detected Schema entity. Range `[0, 1]`.
|
549
592
|
# @!attribute [rw] page_anchor
|
550
593
|
# @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor]
|
551
594
|
# Optional. Represents the provenance of this entity wrt. the location on the
|
@@ -610,6 +653,7 @@ module Google
|
|
610
653
|
# or int normalized text by default.
|
611
654
|
#
|
612
655
|
# Below are sample formats mapped to structured values.
|
656
|
+
#
|
613
657
|
# - Money/Currency type (`money_value`) is in the ISO 4217 text format.
|
614
658
|
# - Date type (`date_value`) is in the ISO 8601 text format.
|
615
659
|
# - Datetime type (`datetime_value`) is in the ISO 8601 text format.
|
@@ -691,7 +735,7 @@ module Google
|
|
691
735
|
# Optional. Identifies the bounding polygon of a layout element on the page.
|
692
736
|
# @!attribute [rw] confidence
|
693
737
|
# @return [::Float]
|
694
|
-
# Optional. Confidence of detected page element, if applicable. Range [0, 1]
|
738
|
+
# Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
|
695
739
|
class PageRef
|
696
740
|
include ::Google::Protobuf::MessageExts
|
697
741
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -28,7 +28,7 @@ module Google
|
|
28
28
|
# @!attribute [rw] mime_type
|
29
29
|
# @return [::String]
|
30
30
|
# An IANA MIME type (RFC6838) indicating the nature and format of the
|
31
|
-
#
|
31
|
+
# {::Google::Cloud::DocumentAI::V1::RawDocument#content content}.
|
32
32
|
class RawDocument
|
33
33
|
include ::Google::Protobuf::MessageExts
|
34
34
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -67,7 +67,7 @@ module Google
|
|
67
67
|
# The common config to specify a set of documents used as input.
|
68
68
|
# @!attribute [rw] gcs_prefix
|
69
69
|
# @return [::Google::Cloud::DocumentAI::V1::GcsPrefix]
|
70
|
-
# The set of documents that match the specified Cloud Storage
|
70
|
+
# The set of documents that match the specified Cloud Storage `gcs_prefix`.
|
71
71
|
# @!attribute [rw] gcs_documents
|
72
72
|
# @return [::Google::Cloud::DocumentAI::V1::GcsDocuments]
|
73
73
|
# The set of documents individually specified on Cloud Storage.
|
@@ -89,6 +89,11 @@ module Google
|
|
89
89
|
# @!attribute [rw] gcs_uri
|
90
90
|
# @return [::String]
|
91
91
|
# The Cloud Storage uri (a directory) of the output.
|
92
|
+
# @!attribute [rw] field_mask
|
93
|
+
# @return [::Google::Protobuf::FieldMask]
|
94
|
+
# Specifies which fields to include in the output documents.
|
95
|
+
# Only supports top level document and pages field so it must be in the
|
96
|
+
# form of `{document_field_name}` or `pages.{page_field_name}`.
|
92
97
|
class GcsOutputConfig
|
93
98
|
include ::Google::Protobuf::MessageExts
|
94
99
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -43,6 +43,8 @@ module Google
|
|
43
43
|
# @!attribute [rw] field_mask
|
44
44
|
# @return [::Google::Protobuf::FieldMask]
|
45
45
|
# Specifies which fields to include in ProcessResponse's document.
|
46
|
+
# Only supports top level document and pages field so it must be in the form
|
47
|
+
# of `{document_field_name}` or `pages.{page_field_name}`.
|
46
48
|
class ProcessRequest
|
47
49
|
include ::Google::Protobuf::MessageExts
|
48
50
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -56,15 +56,16 @@ module Google
|
|
56
56
|
# Name of the type. It must be unique within the schema file and
|
57
57
|
# cannot be a 'Common Type'. Besides that we use the following naming
|
58
58
|
# conventions:
|
59
|
-
#
|
59
|
+
#
|
60
|
+
# - *use `snake_casing`*
|
60
61
|
# - name matching is case-insensitive
|
61
62
|
# - Maximum 64 characters.
|
62
63
|
# - Must start with a letter.
|
63
64
|
# - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
|
64
65
|
# compatibility internal infrastructure and tooling can handle any ascii
|
65
66
|
# character)
|
66
|
-
# - The
|
67
|
-
# line_item/amount
|
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
|
68
69
|
# honored for backward compatibility.
|
69
70
|
# @!attribute [rw] base_types
|
70
71
|
# @return [::Array<::String>]
|
@@ -34,6 +34,9 @@ module Google
|
|
34
34
|
# @!attribute [rw] display_name
|
35
35
|
# @return [::String]
|
36
36
|
# The display name of the processor version.
|
37
|
+
# @!attribute [rw] document_schema
|
38
|
+
# @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
|
39
|
+
# The schema of the processor version. Describes the output.
|
37
40
|
# @!attribute [rw] state
|
38
41
|
# @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::State]
|
39
42
|
# The state of the processor version.
|
@@ -104,7 +107,7 @@ module Google
|
|
104
107
|
# Format: `projects/{project}/locations/{location}/processors/{processor}`
|
105
108
|
# @!attribute [rw] type
|
106
109
|
# @return [::String]
|
107
|
-
# The processor type, e.g., OCR_PROCESSOR
|
110
|
+
# The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
|
108
111
|
# To get a list of processors types, see
|
109
112
|
# {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
|
110
113
|
# @!attribute [rw] display_name
|
@@ -143,14 +146,14 @@ module Google
|
|
143
146
|
# The processor is disabled.
|
144
147
|
DISABLED = 2
|
145
148
|
|
146
|
-
# The processor is being enabled, will become ENABLED if successful.
|
149
|
+
# The processor is being enabled, will become `ENABLED` if successful.
|
147
150
|
ENABLING = 3
|
148
151
|
|
149
|
-
# The processor is being disabled, will become DISABLED if successful.
|
152
|
+
# The processor is being disabled, will become `DISABLED` if successful.
|
150
153
|
DISABLING = 4
|
151
154
|
|
152
|
-
# The processor is being created, will become either ENABLED (for
|
153
|
-
# successful creation) or FAILED (for failed ones).
|
155
|
+
# The processor is being created, will become either `ENABLED` (for
|
156
|
+
# successful creation) or `FAILED` (for failed ones).
|
154
157
|
# Once a processor is in this state, it can then be used for document
|
155
158
|
# processing, but the feature dependencies of the processor might not be
|
156
159
|
# fully created yet.
|
@@ -26,10 +26,10 @@ module Google
|
|
26
26
|
# @!attribute [rw] name
|
27
27
|
# @return [::String]
|
28
28
|
# The resource name of the processor type.
|
29
|
-
# Format: projects
|
29
|
+
# Format: `projects/{project}/processorTypes/{processor_type}`
|
30
30
|
# @!attribute [rw] type
|
31
31
|
# @return [::String]
|
32
|
-
# The type
|
32
|
+
# The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
|
33
33
|
# @!attribute [rw] category
|
34
34
|
# @return [::String]
|
35
35
|
# The processor category, used by UI to group processor types.
|
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.6.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-10 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
|