aws-sdk-textract 1.30.0 → 1.34.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-textract/client.rb +78 -5
- data/lib/aws-sdk-textract/client_api.rb +58 -0
- data/lib/aws-sdk-textract/types.rb +145 -3
- data/lib/aws-sdk-textract.rb +1 -1
- 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: 3637d2e8975c11358d3c1694c50a28eb1f840ef0e0b579092b80753cabd2e3ed
|
4
|
+
data.tar.gz: 82fe7e548dd5c8b7119b632d6ffce7ebd7a08a4c1113128fc9cc60662412d45d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a1c318ae57a86eb7f5cd96126060e272310b168e56ab82e845905bd881ed167eaa2823091b7ce6cf273b626819ea51cc5d9f80241577ef58f2701d94885ff1d7
|
7
|
+
data.tar.gz: b4d14b58768bc1ec5ce727e249b8c3f9d544418d32a0ad99814fecf00741c91ab1500dece8ab457aa32ca6b0767ef2818a7debd37436bf2a1cf265e795fd1fef
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.34.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.33.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.32.0 (2021-11-29)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds support for synchronously analyzing identity documents through a new API: AnalyzeID
|
18
|
+
|
19
|
+
1.31.0 (2021-11-04)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.30.0 (2021-10-27)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.34.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Textract
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Textract
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Textract
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -285,6 +293,15 @@ module Aws::Textract
|
|
285
293
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
294
|
# requests are made, and retries are disabled.
|
287
295
|
#
|
296
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
297
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
298
|
+
# will be used if available.
|
299
|
+
#
|
300
|
+
# @option options [Boolean] :use_fips_endpoint
|
301
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
302
|
+
# When a `fips` region is used, the region is normalized and this config
|
303
|
+
# is set to `true`.
|
304
|
+
#
|
288
305
|
# @option options [Boolean] :validate_params (true)
|
289
306
|
# When `true`, request parameters are validated before
|
290
307
|
# sending the request.
|
@@ -296,7 +313,7 @@ module Aws::Textract
|
|
296
313
|
# seconds to wait when opening a HTTP session before raising a
|
297
314
|
# `Timeout::Error`.
|
298
315
|
#
|
299
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
300
317
|
# number of seconds to wait for response data. This value can
|
301
318
|
# safely be set per-request on the session.
|
302
319
|
#
|
@@ -312,6 +329,9 @@ module Aws::Textract
|
|
312
329
|
# disables this behaviour. This value can safely be set per
|
313
330
|
# request on the session.
|
314
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
315
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
336
|
# HTTP debug output will be sent to the `:logger`.
|
317
337
|
#
|
@@ -467,8 +487,8 @@ module Aws::Textract
|
|
467
487
|
req.send_request(options)
|
468
488
|
end
|
469
489
|
|
470
|
-
#
|
471
|
-
# between text.
|
490
|
+
# `AnalyzeExpense` synchronously analyzes an input document for
|
491
|
+
# financially related relationships between text.
|
472
492
|
#
|
473
493
|
# Information is returned as `ExpenseDocuments` and seperated as
|
474
494
|
# follows.
|
@@ -585,6 +605,59 @@ module Aws::Textract
|
|
585
605
|
req.send_request(options)
|
586
606
|
end
|
587
607
|
|
608
|
+
# Analyzes identity documents for relevant information. This information
|
609
|
+
# is extracted and returned as `IdentityDocumentFields`, which records
|
610
|
+
# both the normalized field and value of the extracted text.
|
611
|
+
#
|
612
|
+
# @option params [required, Array<Types::Document>] :document_pages
|
613
|
+
# The document being passed to AnalyzeID.
|
614
|
+
#
|
615
|
+
# @return [Types::AnalyzeIDResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
616
|
+
#
|
617
|
+
# * {Types::AnalyzeIDResponse#identity_documents #identity_documents} => Array<Types::IdentityDocument>
|
618
|
+
# * {Types::AnalyzeIDResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
619
|
+
# * {Types::AnalyzeIDResponse#analyze_id_model_version #analyze_id_model_version} => String
|
620
|
+
#
|
621
|
+
# @example Request syntax with placeholder values
|
622
|
+
#
|
623
|
+
# resp = client.analyze_id({
|
624
|
+
# document_pages: [ # required
|
625
|
+
# {
|
626
|
+
# bytes: "data",
|
627
|
+
# s3_object: {
|
628
|
+
# bucket: "S3Bucket",
|
629
|
+
# name: "S3ObjectName",
|
630
|
+
# version: "S3ObjectVersion",
|
631
|
+
# },
|
632
|
+
# },
|
633
|
+
# ],
|
634
|
+
# })
|
635
|
+
#
|
636
|
+
# @example Response structure
|
637
|
+
#
|
638
|
+
# resp.identity_documents #=> Array
|
639
|
+
# resp.identity_documents[0].document_index #=> Integer
|
640
|
+
# resp.identity_documents[0].identity_document_fields #=> Array
|
641
|
+
# resp.identity_documents[0].identity_document_fields[0].type.text #=> String
|
642
|
+
# resp.identity_documents[0].identity_document_fields[0].type.normalized_value.value #=> String
|
643
|
+
# resp.identity_documents[0].identity_document_fields[0].type.normalized_value.value_type #=> String, one of "DATE"
|
644
|
+
# resp.identity_documents[0].identity_document_fields[0].type.confidence #=> Float
|
645
|
+
# resp.identity_documents[0].identity_document_fields[0].value_detection.text #=> String
|
646
|
+
# resp.identity_documents[0].identity_document_fields[0].value_detection.normalized_value.value #=> String
|
647
|
+
# resp.identity_documents[0].identity_document_fields[0].value_detection.normalized_value.value_type #=> String, one of "DATE"
|
648
|
+
# resp.identity_documents[0].identity_document_fields[0].value_detection.confidence #=> Float
|
649
|
+
# resp.document_metadata.pages #=> Integer
|
650
|
+
# resp.analyze_id_model_version #=> String
|
651
|
+
#
|
652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeID AWS API Documentation
|
653
|
+
#
|
654
|
+
# @overload analyze_id(params = {})
|
655
|
+
# @param [Hash] params ({})
|
656
|
+
def analyze_id(params = {}, options = {})
|
657
|
+
req = build_request(:analyze_id, params)
|
658
|
+
req.send_request(options)
|
659
|
+
end
|
660
|
+
|
588
661
|
# Detects text in the input document. Amazon Textract can detect lines
|
589
662
|
# of text and the words that make up a line of text. The input document
|
590
663
|
# must be an image in JPEG or PNG format. `DetectDocumentText` returns
|
@@ -1383,7 +1456,7 @@ module Aws::Textract
|
|
1383
1456
|
params: params,
|
1384
1457
|
config: config)
|
1385
1458
|
context[:gem_name] = 'aws-sdk-textract'
|
1386
|
-
context[:gem_version] = '1.
|
1459
|
+
context[:gem_version] = '1.34.0'
|
1387
1460
|
Seahorse::Client::Request.new(handlers, context)
|
1388
1461
|
end
|
1389
1462
|
|
@@ -18,6 +18,9 @@ module Aws::Textract
|
|
18
18
|
AnalyzeDocumentResponse = Shapes::StructureShape.new(name: 'AnalyzeDocumentResponse')
|
19
19
|
AnalyzeExpenseRequest = Shapes::StructureShape.new(name: 'AnalyzeExpenseRequest')
|
20
20
|
AnalyzeExpenseResponse = Shapes::StructureShape.new(name: 'AnalyzeExpenseResponse')
|
21
|
+
AnalyzeIDDetections = Shapes::StructureShape.new(name: 'AnalyzeIDDetections')
|
22
|
+
AnalyzeIDRequest = Shapes::StructureShape.new(name: 'AnalyzeIDRequest')
|
23
|
+
AnalyzeIDResponse = Shapes::StructureShape.new(name: 'AnalyzeIDResponse')
|
21
24
|
BadDocumentException = Shapes::StructureShape.new(name: 'BadDocumentException')
|
22
25
|
Block = Shapes::StructureShape.new(name: 'Block')
|
23
26
|
BlockList = Shapes::ListShape.new(name: 'BlockList')
|
@@ -31,6 +34,7 @@ module Aws::Textract
|
|
31
34
|
Document = Shapes::StructureShape.new(name: 'Document')
|
32
35
|
DocumentLocation = Shapes::StructureShape.new(name: 'DocumentLocation')
|
33
36
|
DocumentMetadata = Shapes::StructureShape.new(name: 'DocumentMetadata')
|
37
|
+
DocumentPages = Shapes::ListShape.new(name: 'DocumentPages')
|
34
38
|
DocumentTooLargeException = Shapes::StructureShape.new(name: 'DocumentTooLargeException')
|
35
39
|
EntityType = Shapes::StringShape.new(name: 'EntityType')
|
36
40
|
EntityTypes = Shapes::ListShape.new(name: 'EntityTypes')
|
@@ -63,6 +67,10 @@ module Aws::Textract
|
|
63
67
|
HumanLoopQuotaExceededException = Shapes::StructureShape.new(name: 'HumanLoopQuotaExceededException')
|
64
68
|
IdList = Shapes::ListShape.new(name: 'IdList')
|
65
69
|
IdempotentParameterMismatchException = Shapes::StructureShape.new(name: 'IdempotentParameterMismatchException')
|
70
|
+
IdentityDocument = Shapes::StructureShape.new(name: 'IdentityDocument')
|
71
|
+
IdentityDocumentField = Shapes::StructureShape.new(name: 'IdentityDocumentField')
|
72
|
+
IdentityDocumentFieldList = Shapes::ListShape.new(name: 'IdentityDocumentFieldList')
|
73
|
+
IdentityDocumentList = Shapes::ListShape.new(name: 'IdentityDocumentList')
|
66
74
|
ImageBlob = Shapes::BlobShape.new(name: 'ImageBlob')
|
67
75
|
InternalServerError = Shapes::StructureShape.new(name: 'InternalServerError')
|
68
76
|
InvalidJobIdException = Shapes::StructureShape.new(name: 'InvalidJobIdException')
|
@@ -80,6 +88,7 @@ module Aws::Textract
|
|
80
88
|
LineItemList = Shapes::ListShape.new(name: 'LineItemList')
|
81
89
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
82
90
|
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
91
|
+
NormalizedValue = Shapes::StructureShape.new(name: 'NormalizedValue')
|
83
92
|
NotificationChannel = Shapes::StructureShape.new(name: 'NotificationChannel')
|
84
93
|
OutputConfig = Shapes::StructureShape.new(name: 'OutputConfig')
|
85
94
|
Pages = Shapes::ListShape.new(name: 'Pages')
|
@@ -110,6 +119,7 @@ module Aws::Textract
|
|
110
119
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
111
120
|
UInteger = Shapes::IntegerShape.new(name: 'UInteger')
|
112
121
|
UnsupportedDocumentException = Shapes::StructureShape.new(name: 'UnsupportedDocumentException')
|
122
|
+
ValueType = Shapes::StringShape.new(name: 'ValueType')
|
113
123
|
Warning = Shapes::StructureShape.new(name: 'Warning')
|
114
124
|
Warnings = Shapes::ListShape.new(name: 'Warnings')
|
115
125
|
|
@@ -133,6 +143,19 @@ module Aws::Textract
|
|
133
143
|
AnalyzeExpenseResponse.add_member(:expense_documents, Shapes::ShapeRef.new(shape: ExpenseDocumentList, location_name: "ExpenseDocuments"))
|
134
144
|
AnalyzeExpenseResponse.struct_class = Types::AnalyzeExpenseResponse
|
135
145
|
|
146
|
+
AnalyzeIDDetections.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
147
|
+
AnalyzeIDDetections.add_member(:normalized_value, Shapes::ShapeRef.new(shape: NormalizedValue, location_name: "NormalizedValue"))
|
148
|
+
AnalyzeIDDetections.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
|
149
|
+
AnalyzeIDDetections.struct_class = Types::AnalyzeIDDetections
|
150
|
+
|
151
|
+
AnalyzeIDRequest.add_member(:document_pages, Shapes::ShapeRef.new(shape: DocumentPages, required: true, location_name: "DocumentPages"))
|
152
|
+
AnalyzeIDRequest.struct_class = Types::AnalyzeIDRequest
|
153
|
+
|
154
|
+
AnalyzeIDResponse.add_member(:identity_documents, Shapes::ShapeRef.new(shape: IdentityDocumentList, location_name: "IdentityDocuments"))
|
155
|
+
AnalyzeIDResponse.add_member(:document_metadata, Shapes::ShapeRef.new(shape: DocumentMetadata, location_name: "DocumentMetadata"))
|
156
|
+
AnalyzeIDResponse.add_member(:analyze_id_model_version, Shapes::ShapeRef.new(shape: String, location_name: "AnalyzeIDModelVersion"))
|
157
|
+
AnalyzeIDResponse.struct_class = Types::AnalyzeIDResponse
|
158
|
+
|
136
159
|
BadDocumentException.struct_class = Types::BadDocumentException
|
137
160
|
|
138
161
|
Block.add_member(:block_type, Shapes::ShapeRef.new(shape: BlockType, location_name: "BlockType"))
|
@@ -179,6 +202,8 @@ module Aws::Textract
|
|
179
202
|
DocumentMetadata.add_member(:pages, Shapes::ShapeRef.new(shape: UInteger, location_name: "Pages"))
|
180
203
|
DocumentMetadata.struct_class = Types::DocumentMetadata
|
181
204
|
|
205
|
+
DocumentPages.member = Shapes::ShapeRef.new(shape: Document)
|
206
|
+
|
182
207
|
DocumentTooLargeException.struct_class = Types::DocumentTooLargeException
|
183
208
|
|
184
209
|
EntityTypes.member = Shapes::ShapeRef.new(shape: EntityType)
|
@@ -279,6 +304,18 @@ module Aws::Textract
|
|
279
304
|
|
280
305
|
IdempotentParameterMismatchException.struct_class = Types::IdempotentParameterMismatchException
|
281
306
|
|
307
|
+
IdentityDocument.add_member(:document_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "DocumentIndex"))
|
308
|
+
IdentityDocument.add_member(:identity_document_fields, Shapes::ShapeRef.new(shape: IdentityDocumentFieldList, location_name: "IdentityDocumentFields"))
|
309
|
+
IdentityDocument.struct_class = Types::IdentityDocument
|
310
|
+
|
311
|
+
IdentityDocumentField.add_member(:type, Shapes::ShapeRef.new(shape: AnalyzeIDDetections, location_name: "Type"))
|
312
|
+
IdentityDocumentField.add_member(:value_detection, Shapes::ShapeRef.new(shape: AnalyzeIDDetections, location_name: "ValueDetection"))
|
313
|
+
IdentityDocumentField.struct_class = Types::IdentityDocumentField
|
314
|
+
|
315
|
+
IdentityDocumentFieldList.member = Shapes::ShapeRef.new(shape: IdentityDocumentField)
|
316
|
+
|
317
|
+
IdentityDocumentList.member = Shapes::ShapeRef.new(shape: IdentityDocument)
|
318
|
+
|
282
319
|
InternalServerError.struct_class = Types::InternalServerError
|
283
320
|
|
284
321
|
InvalidJobIdException.struct_class = Types::InvalidJobIdException
|
@@ -302,6 +339,10 @@ module Aws::Textract
|
|
302
339
|
|
303
340
|
LineItemList.member = Shapes::ShapeRef.new(shape: LineItemFields)
|
304
341
|
|
342
|
+
NormalizedValue.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
|
343
|
+
NormalizedValue.add_member(:value_type, Shapes::ShapeRef.new(shape: ValueType, location_name: "ValueType"))
|
344
|
+
NormalizedValue.struct_class = Types::NormalizedValue
|
345
|
+
|
305
346
|
NotificationChannel.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SNSTopicArn, required: true, location_name: "SNSTopicArn"))
|
306
347
|
NotificationChannel.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
307
348
|
NotificationChannel.struct_class = Types::NotificationChannel
|
@@ -428,6 +469,23 @@ module Aws::Textract
|
|
428
469
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
429
470
|
end)
|
430
471
|
|
472
|
+
api.add_operation(:analyze_id, Seahorse::Model::Operation.new.tap do |o|
|
473
|
+
o.name = "AnalyzeID"
|
474
|
+
o.http_method = "POST"
|
475
|
+
o.http_request_uri = "/"
|
476
|
+
o.input = Shapes::ShapeRef.new(shape: AnalyzeIDRequest)
|
477
|
+
o.output = Shapes::ShapeRef.new(shape: AnalyzeIDResponse)
|
478
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
479
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
480
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
|
481
|
+
o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
|
482
|
+
o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
|
483
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
484
|
+
o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
|
485
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
486
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
487
|
+
end)
|
488
|
+
|
431
489
|
api.add_operation(:detect_document_text, Seahorse::Model::Operation.new.tap do |o|
|
432
490
|
o.name = "DetectDocumentText"
|
433
491
|
o.http_method = "POST"
|
@@ -168,6 +168,84 @@ module Aws::Textract
|
|
168
168
|
include Aws::Structure
|
169
169
|
end
|
170
170
|
|
171
|
+
# Used to contain the information detected by an AnalyzeID operation.
|
172
|
+
#
|
173
|
+
# @!attribute [rw] text
|
174
|
+
# Text of either the normalized field or value associated with it.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] normalized_value
|
178
|
+
# Only returned for dates, returns the type of value detected and the
|
179
|
+
# date written in a more machine readable way.
|
180
|
+
# @return [Types::NormalizedValue]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] confidence
|
183
|
+
# The confidence score of the detected text.
|
184
|
+
# @return [Float]
|
185
|
+
#
|
186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeIDDetections AWS API Documentation
|
187
|
+
#
|
188
|
+
class AnalyzeIDDetections < Struct.new(
|
189
|
+
:text,
|
190
|
+
:normalized_value,
|
191
|
+
:confidence)
|
192
|
+
SENSITIVE = []
|
193
|
+
include Aws::Structure
|
194
|
+
end
|
195
|
+
|
196
|
+
# @note When making an API call, you may pass AnalyzeIDRequest
|
197
|
+
# data as a hash:
|
198
|
+
#
|
199
|
+
# {
|
200
|
+
# document_pages: [ # required
|
201
|
+
# {
|
202
|
+
# bytes: "data",
|
203
|
+
# s3_object: {
|
204
|
+
# bucket: "S3Bucket",
|
205
|
+
# name: "S3ObjectName",
|
206
|
+
# version: "S3ObjectVersion",
|
207
|
+
# },
|
208
|
+
# },
|
209
|
+
# ],
|
210
|
+
# }
|
211
|
+
#
|
212
|
+
# @!attribute [rw] document_pages
|
213
|
+
# The document being passed to AnalyzeID.
|
214
|
+
# @return [Array<Types::Document>]
|
215
|
+
#
|
216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeIDRequest AWS API Documentation
|
217
|
+
#
|
218
|
+
class AnalyzeIDRequest < Struct.new(
|
219
|
+
:document_pages)
|
220
|
+
SENSITIVE = []
|
221
|
+
include Aws::Structure
|
222
|
+
end
|
223
|
+
|
224
|
+
# @!attribute [rw] identity_documents
|
225
|
+
# The list of documents processed by AnalyzeID. Includes a number
|
226
|
+
# denoting their place in the list and the response structure for the
|
227
|
+
# document.
|
228
|
+
# @return [Array<Types::IdentityDocument>]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] document_metadata
|
231
|
+
# Information about the input document.
|
232
|
+
# @return [Types::DocumentMetadata]
|
233
|
+
#
|
234
|
+
# @!attribute [rw] analyze_id_model_version
|
235
|
+
# The version of the AnalyzeIdentity API being used to process
|
236
|
+
# documents.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeIDResponse AWS API Documentation
|
240
|
+
#
|
241
|
+
class AnalyzeIDResponse < Struct.new(
|
242
|
+
:identity_documents,
|
243
|
+
:document_metadata,
|
244
|
+
:analyze_id_model_version)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
171
249
|
# Amazon Textract isn't able to read the document. For more information
|
172
250
|
# on the document limits in Amazon Textract, see limits.
|
173
251
|
#
|
@@ -619,7 +697,7 @@ module Aws::Textract
|
|
619
697
|
end
|
620
698
|
|
621
699
|
# Breakdown of detected information, seperated into the catagories Type,
|
622
|
-
#
|
700
|
+
# LabelDetection, and ValueDetection
|
623
701
|
#
|
624
702
|
# @!attribute [rw] type
|
625
703
|
# The implied label of a detected element. Present alongside
|
@@ -1073,6 +1151,50 @@ module Aws::Textract
|
|
1073
1151
|
#
|
1074
1152
|
class IdempotentParameterMismatchException < Aws::EmptyStructure; end
|
1075
1153
|
|
1154
|
+
# The structure that lists each document processed in an AnalyzeID
|
1155
|
+
# operation.
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] document_index
|
1158
|
+
# Denotes the placement of a document in the IdentityDocument list.
|
1159
|
+
# The first document is marked 1, the second 2 and so on.
|
1160
|
+
# @return [Integer]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] identity_document_fields
|
1163
|
+
# The structure used to record information extracted from identity
|
1164
|
+
# documents. Contains both normalized field and value of the extracted
|
1165
|
+
# text.
|
1166
|
+
# @return [Array<Types::IdentityDocumentField>]
|
1167
|
+
#
|
1168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/IdentityDocument AWS API Documentation
|
1169
|
+
#
|
1170
|
+
class IdentityDocument < Struct.new(
|
1171
|
+
:document_index,
|
1172
|
+
:identity_document_fields)
|
1173
|
+
SENSITIVE = []
|
1174
|
+
include Aws::Structure
|
1175
|
+
end
|
1176
|
+
|
1177
|
+
# Structure containing both the normalized type of the extracted
|
1178
|
+
# information and the text associated with it. These are extracted as
|
1179
|
+
# Type and Value respectively.
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] type
|
1182
|
+
# Used to contain the information detected by an AnalyzeID operation.
|
1183
|
+
# @return [Types::AnalyzeIDDetections]
|
1184
|
+
#
|
1185
|
+
# @!attribute [rw] value_detection
|
1186
|
+
# Used to contain the information detected by an AnalyzeID operation.
|
1187
|
+
# @return [Types::AnalyzeIDDetections]
|
1188
|
+
#
|
1189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/IdentityDocumentField AWS API Documentation
|
1190
|
+
#
|
1191
|
+
class IdentityDocumentField < Struct.new(
|
1192
|
+
:type,
|
1193
|
+
:value_detection)
|
1194
|
+
SENSITIVE = []
|
1195
|
+
include Aws::Structure
|
1196
|
+
end
|
1197
|
+
|
1076
1198
|
# Amazon Textract experienced a service issue. Try your call again.
|
1077
1199
|
#
|
1078
1200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InternalServerError AWS API Documentation
|
@@ -1165,6 +1287,26 @@ module Aws::Textract
|
|
1165
1287
|
include Aws::Structure
|
1166
1288
|
end
|
1167
1289
|
|
1290
|
+
# Contains information relating to dates in a document, including the
|
1291
|
+
# type of value, and the value.
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] value
|
1294
|
+
# The value of the date, written as Year-Month-DayTHour:Minute:Second.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] value_type
|
1298
|
+
# The normalized type of the value detected. In this case, DATE.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
1301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/NormalizedValue AWS API Documentation
|
1302
|
+
#
|
1303
|
+
class NormalizedValue < Struct.new(
|
1304
|
+
:value,
|
1305
|
+
:value_type)
|
1306
|
+
SENSITIVE = []
|
1307
|
+
include Aws::Structure
|
1308
|
+
end
|
1309
|
+
|
1168
1310
|
# The Amazon Simple Notification Service (Amazon SNS) topic to which
|
1169
1311
|
# Amazon Textract publishes the completion status of an asynchronous
|
1170
1312
|
# document operation, such as StartDocumentTextDetection.
|
@@ -1662,8 +1804,8 @@ module Aws::Textract
|
|
1662
1804
|
class ThrottlingException < Aws::EmptyStructure; end
|
1663
1805
|
|
1664
1806
|
# The format of the input document isn't supported. Documents for
|
1665
|
-
# synchronous operations can be in PNG or JPEG format. Documents
|
1666
|
-
# asynchronous operations can
|
1807
|
+
# synchronous operations can be in PNG or JPEG format only. Documents
|
1808
|
+
# for asynchronous operations can be in PDF format.
|
1667
1809
|
#
|
1668
1810
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UnsupportedDocumentException AWS API Documentation
|
1669
1811
|
#
|
data/lib/aws-sdk-textract.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-textract
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.34.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-12-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.125.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.125.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|