aws-sdk-textract 1.10.0 → 1.15.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 +5 -5
- data/lib/aws-sdk-textract.rb +7 -4
- data/lib/aws-sdk-textract/client.rb +183 -82
- data/lib/aws-sdk-textract/client_api.rb +65 -0
- data/lib/aws-sdk-textract/errors.rb +180 -0
- data/lib/aws-sdk-textract/resource.rb +1 -0
- data/lib/aws-sdk-textract/types.rb +371 -108
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 537a7b71040220ade1bbf5f72acf3fc390e1d46fa6b1d55f8d87dd9fd0f735c0
|
4
|
+
data.tar.gz: e051eab2549faf7ac255dd7510ee8d26802899c346c78cb2818cf124fd53b3b4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b7be45341515fea42830bae014054b3ace3c5bbfa8d9529b2d4c21cf6d1ca676e2e2d1bee7eacb3570e2bdac3dcfeb317a0660440552b3715cf1abdea478110d
|
7
|
+
data.tar.gz: 8e7b013f8f1bb864312f7cdd48709fc9ff34c45350e6e112a10936b428a67ca38a2f94189aea2400f4451453c84a015f68936fd9757be72275e099ca89d6bffe
|
data/lib/aws-sdk-textract.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-textract/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# textract = Aws::Textract::Client.new
|
28
|
+
# resp = textract.analyze_document(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon Textract
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon Textract are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Textract::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon Textract API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-textract/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Textract
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.15.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:textract)
|
31
31
|
|
32
32
|
module Aws::Textract
|
33
|
+
# An API client for Textract. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Textract::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Textract
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Textract
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Textract
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Textract
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Textract
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Textract
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Textract
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::Textract
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::Textract
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -268,27 +322,30 @@ module Aws::Textract
|
|
268
322
|
#
|
269
323
|
# The types of information returned are as follows:
|
270
324
|
#
|
271
|
-
# *
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
325
|
+
# * Form data (key-value pairs). The related information is returned in
|
326
|
+
# two Block objects, each of type `KEY_VALUE_SET`\: a KEY `Block`
|
327
|
+
# object and a VALUE `Block` object. For example, *Name: Ana Silva
|
328
|
+
# Carolina* contains a key and value. *Name:* is the key. *Ana Silva
|
329
|
+
# Carolina* is the value.
|
276
330
|
#
|
277
|
-
# * Table and table cell data. A TABLE Block object contains
|
278
|
-
# about a detected table. A CELL Block object is
|
279
|
-
# cell in a table.
|
331
|
+
# * Table and table cell data. A TABLE `Block` object contains
|
332
|
+
# information about a detected table. A CELL `Block` object is
|
333
|
+
# returned for each cell in a table.
|
280
334
|
#
|
281
|
-
# *
|
282
|
-
#
|
283
|
-
#
|
335
|
+
# * Lines and words of text. A LINE `Block` object contains one or more
|
336
|
+
# WORD `Block` objects. All lines and words that are detected in the
|
337
|
+
# document are returned (including text that doesn't have a
|
338
|
+
# relationship with the value of `FeatureTypes`).
|
284
339
|
#
|
285
|
-
#
|
286
|
-
#
|
340
|
+
# Selection elements such as check boxes and option buttons (radio
|
341
|
+
# buttons) can be detected in form data and in tables. A
|
342
|
+
# SELECTION\_ELEMENT `Block` object contains information about a
|
343
|
+
# selection element, including the selection status.
|
287
344
|
#
|
288
345
|
# You can choose which type of analysis to perform by specifying the
|
289
346
|
# `FeatureTypes` list.
|
290
347
|
#
|
291
|
-
# The output is returned in a list of `
|
348
|
+
# The output is returned in a list of `Block` objects.
|
292
349
|
#
|
293
350
|
# `AnalyzeDocument` is a synchronous operation. To analyze documents
|
294
351
|
# asynchronously, use StartDocumentAnalysis.
|
@@ -302,22 +359,30 @@ module Aws::Textract
|
|
302
359
|
# @option params [required, Types::Document] :document
|
303
360
|
# The input document as base64-encoded bytes or an Amazon S3 object. If
|
304
361
|
# you use the AWS CLI to call Amazon Textract operations, you can't
|
305
|
-
# pass image bytes. The document must be an image in
|
362
|
+
# pass image bytes. The document must be an image in JPEG or PNG format.
|
306
363
|
#
|
307
|
-
# If you
|
308
|
-
# need to base64-encode image bytes passed using the `Bytes`
|
364
|
+
# If you're using an AWS SDK to call Amazon Textract, you might not
|
365
|
+
# need to base64-encode image bytes that are passed using the `Bytes`
|
366
|
+
# field.
|
309
367
|
#
|
310
368
|
# @option params [required, Array<String>] :feature_types
|
311
369
|
# A list of the types of analysis to perform. Add TABLES to the list to
|
312
|
-
# return information about the tables detected in the input
|
313
|
-
# Add FORMS to return detected
|
314
|
-
#
|
315
|
-
#
|
370
|
+
# return information about the tables that are detected in the input
|
371
|
+
# document. Add FORMS to return detected form data. To perform both
|
372
|
+
# types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines
|
373
|
+
# and words detected in the document are included in the response
|
374
|
+
# (including text that isn't related to the value of `FeatureTypes`).
|
375
|
+
#
|
376
|
+
# @option params [Types::HumanLoopConfig] :human_loop_config
|
377
|
+
# Sets the configuration for the human in the loop workflow for
|
378
|
+
# analyzing documents.
|
316
379
|
#
|
317
380
|
# @return [Types::AnalyzeDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
318
381
|
#
|
319
382
|
# * {Types::AnalyzeDocumentResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
320
383
|
# * {Types::AnalyzeDocumentResponse#blocks #blocks} => Array<Types::Block>
|
384
|
+
# * {Types::AnalyzeDocumentResponse#human_loop_activation_output #human_loop_activation_output} => Types::HumanLoopActivationOutput
|
385
|
+
# * {Types::AnalyzeDocumentResponse#analyze_document_model_version #analyze_document_model_version} => String
|
321
386
|
#
|
322
387
|
# @example Request syntax with placeholder values
|
323
388
|
#
|
@@ -331,6 +396,13 @@ module Aws::Textract
|
|
331
396
|
# },
|
332
397
|
# },
|
333
398
|
# feature_types: ["TABLES"], # required, accepts TABLES, FORMS
|
399
|
+
# human_loop_config: {
|
400
|
+
# human_loop_name: "HumanLoopName", # required
|
401
|
+
# flow_definition_arn: "FlowDefinitionArn", # required
|
402
|
+
# data_attributes: {
|
403
|
+
# content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
|
404
|
+
# },
|
405
|
+
# },
|
334
406
|
# })
|
335
407
|
#
|
336
408
|
# @example Response structure
|
@@ -360,6 +432,11 @@ module Aws::Textract
|
|
360
432
|
# resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
|
361
433
|
# resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
|
362
434
|
# resp.blocks[0].page #=> Integer
|
435
|
+
# resp.human_loop_activation_output.human_loop_arn #=> String
|
436
|
+
# resp.human_loop_activation_output.human_loop_activation_reasons #=> Array
|
437
|
+
# resp.human_loop_activation_output.human_loop_activation_reasons[0] #=> String
|
438
|
+
# resp.human_loop_activation_output.human_loop_activation_conditions_evaluation_results #=> String
|
439
|
+
# resp.analyze_document_model_version #=> String
|
363
440
|
#
|
364
441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocument AWS API Documentation
|
365
442
|
#
|
@@ -372,7 +449,7 @@ module Aws::Textract
|
|
372
449
|
|
373
450
|
# Detects text in the input document. Amazon Textract can detect lines
|
374
451
|
# of text and the words that make up a line of text. The input document
|
375
|
-
# must be an image in
|
452
|
+
# must be an image in JPEG or PNG format. `DetectDocumentText` returns
|
376
453
|
# the detected text in an array of Block objects.
|
377
454
|
#
|
378
455
|
# Each document page has as an associated `Block` of type PAGE. Each
|
@@ -393,15 +470,17 @@ module Aws::Textract
|
|
393
470
|
# @option params [required, Types::Document] :document
|
394
471
|
# The input document as base64-encoded bytes or an Amazon S3 object. If
|
395
472
|
# you use the AWS CLI to call Amazon Textract operations, you can't
|
396
|
-
# pass image bytes. The document must be an image in
|
473
|
+
# pass image bytes. The document must be an image in JPEG or PNG format.
|
397
474
|
#
|
398
|
-
# If you
|
399
|
-
# need to base64-encode image bytes passed using the `Bytes`
|
475
|
+
# If you're using an AWS SDK to call Amazon Textract, you might not
|
476
|
+
# need to base64-encode image bytes that are passed using the `Bytes`
|
477
|
+
# field.
|
400
478
|
#
|
401
479
|
# @return [Types::DetectDocumentTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
402
480
|
#
|
403
481
|
# * {Types::DetectDocumentTextResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
404
482
|
# * {Types::DetectDocumentTextResponse#blocks #blocks} => Array<Types::Block>
|
483
|
+
# * {Types::DetectDocumentTextResponse#detect_document_text_model_version #detect_document_text_model_version} => String
|
405
484
|
#
|
406
485
|
# @example Request syntax with placeholder values
|
407
486
|
#
|
@@ -443,6 +522,7 @@ module Aws::Textract
|
|
443
522
|
# resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
|
444
523
|
# resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
|
445
524
|
# resp.blocks[0].page #=> Integer
|
525
|
+
# resp.detect_document_text_model_version #=> String
|
446
526
|
#
|
447
527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectDocumentText AWS API Documentation
|
448
528
|
#
|
@@ -469,30 +549,34 @@ module Aws::Textract
|
|
469
549
|
# `GetDocumentAnalysis` returns an array of Block objects. The following
|
470
550
|
# types of information are returned:
|
471
551
|
#
|
472
|
-
# *
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
552
|
+
# * Form data (key-value pairs). The related information is returned in
|
553
|
+
# two Block objects, each of type `KEY_VALUE_SET`\: a KEY `Block`
|
554
|
+
# object and a VALUE `Block` object. For example, *Name: Ana Silva
|
555
|
+
# Carolina* contains a key and value. *Name:* is the key. *Ana Silva
|
556
|
+
# Carolina* is the value.
|
477
557
|
#
|
478
|
-
# * Table and table cell data. A TABLE Block object contains
|
479
|
-
# about a detected table. A CELL Block object is
|
480
|
-
# cell in a table.
|
558
|
+
# * Table and table cell data. A TABLE `Block` object contains
|
559
|
+
# information about a detected table. A CELL `Block` object is
|
560
|
+
# returned for each cell in a table.
|
481
561
|
#
|
482
|
-
# *
|
483
|
-
#
|
484
|
-
#
|
562
|
+
# * Lines and words of text. A LINE `Block` object contains one or more
|
563
|
+
# WORD `Block` objects. All lines and words that are detected in the
|
564
|
+
# document are returned (including text that doesn't have a
|
565
|
+
# relationship with the value of the `StartDocumentAnalysis`
|
566
|
+
# `FeatureTypes` input parameter).
|
485
567
|
#
|
486
|
-
#
|
487
|
-
#
|
568
|
+
# Selection elements such as check boxes and option buttons (radio
|
569
|
+
# buttons) can be detected in form data and in tables. A
|
570
|
+
# SELECTION\_ELEMENT `Block` object contains information about a
|
571
|
+
# selection element, including the selection status.
|
488
572
|
#
|
489
|
-
# Use the `MaxResults` parameter to limit the number of blocks
|
490
|
-
# If there are more results than specified in `MaxResults`,
|
491
|
-
# `NextToken` in the operation response contains a
|
492
|
-
# getting the next set of results. To get the next
|
493
|
-
# `GetDocumentAnalysis`, and populate the
|
494
|
-
# with the token value that's returned
|
495
|
-
# `GetDocumentAnalysis`.
|
573
|
+
# Use the `MaxResults` parameter to limit the number of blocks that are
|
574
|
+
# returned. If there are more results than specified in `MaxResults`,
|
575
|
+
# the value of `NextToken` in the operation response contains a
|
576
|
+
# pagination token for getting the next set of results. To get the next
|
577
|
+
# page of results, call `GetDocumentAnalysis`, and populate the
|
578
|
+
# `NextToken` request parameter with the token value that's returned
|
579
|
+
# from the previous call to `GetDocumentAnalysis`.
|
496
580
|
#
|
497
581
|
# For more information, see [Document Text Analysis][1].
|
498
582
|
#
|
@@ -502,7 +586,8 @@ module Aws::Textract
|
|
502
586
|
#
|
503
587
|
# @option params [required, String] :job_id
|
504
588
|
# A unique identifier for the text-detection job. The `JobId` is
|
505
|
-
# returned from `StartDocumentAnalysis`.
|
589
|
+
# returned from `StartDocumentAnalysis`. A `JobId` value is only valid
|
590
|
+
# for 7 days.
|
506
591
|
#
|
507
592
|
# @option params [Integer] :max_results
|
508
593
|
# The maximum number of results to return per paginated call. The
|
@@ -524,6 +609,7 @@ module Aws::Textract
|
|
524
609
|
# * {Types::GetDocumentAnalysisResponse#blocks #blocks} => Array<Types::Block>
|
525
610
|
# * {Types::GetDocumentAnalysisResponse#warnings #warnings} => Array<Types::Warning>
|
526
611
|
# * {Types::GetDocumentAnalysisResponse#status_message #status_message} => String
|
612
|
+
# * {Types::GetDocumentAnalysisResponse#analyze_document_model_version #analyze_document_model_version} => String
|
527
613
|
#
|
528
614
|
# @example Request syntax with placeholder values
|
529
615
|
#
|
@@ -567,6 +653,7 @@ module Aws::Textract
|
|
567
653
|
# resp.warnings[0].pages #=> Array
|
568
654
|
# resp.warnings[0].pages[0] #=> Integer
|
569
655
|
# resp.status_message #=> String
|
656
|
+
# resp.analyze_document_model_version #=> String
|
570
657
|
#
|
571
658
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentAnalysis AWS API Documentation
|
572
659
|
#
|
@@ -616,7 +703,8 @@ module Aws::Textract
|
|
616
703
|
#
|
617
704
|
# @option params [required, String] :job_id
|
618
705
|
# A unique identifier for the text detection job. The `JobId` is
|
619
|
-
# returned from `StartDocumentTextDetection`.
|
706
|
+
# returned from `StartDocumentTextDetection`. A `JobId` value is only
|
707
|
+
# valid for 7 days.
|
620
708
|
#
|
621
709
|
# @option params [Integer] :max_results
|
622
710
|
# The maximum number of results to return per paginated call. The
|
@@ -638,6 +726,7 @@ module Aws::Textract
|
|
638
726
|
# * {Types::GetDocumentTextDetectionResponse#blocks #blocks} => Array<Types::Block>
|
639
727
|
# * {Types::GetDocumentTextDetectionResponse#warnings #warnings} => Array<Types::Warning>
|
640
728
|
# * {Types::GetDocumentTextDetectionResponse#status_message #status_message} => String
|
729
|
+
# * {Types::GetDocumentTextDetectionResponse#detect_document_text_model_version #detect_document_text_model_version} => String
|
641
730
|
#
|
642
731
|
# @example Request syntax with placeholder values
|
643
732
|
#
|
@@ -681,6 +770,7 @@ module Aws::Textract
|
|
681
770
|
# resp.warnings[0].pages #=> Array
|
682
771
|
# resp.warnings[0].pages[0] #=> Integer
|
683
772
|
# resp.status_message #=> String
|
773
|
+
# resp.detect_document_text_model_version #=> String
|
684
774
|
#
|
685
775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection AWS API Documentation
|
686
776
|
#
|
@@ -691,14 +781,14 @@ module Aws::Textract
|
|
691
781
|
req.send_request(options)
|
692
782
|
end
|
693
783
|
|
694
|
-
# Starts asynchronous analysis of an input document for
|
695
|
-
# between detected items such as key
|
696
|
-
# selection elements.
|
784
|
+
# Starts the asynchronous analysis of an input document for
|
785
|
+
# relationships between detected items such as key-value pairs, tables,
|
786
|
+
# and selection elements.
|
697
787
|
#
|
698
|
-
# `StartDocumentAnalysis` can analyze text in documents that are in
|
699
|
-
# PNG, and PDF format. The documents are stored in an Amazon S3
|
700
|
-
# Use DocumentLocation to specify the bucket name and file name
|
701
|
-
# document.
|
788
|
+
# `StartDocumentAnalysis` can analyze text in documents that are in
|
789
|
+
# JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
|
790
|
+
# bucket. Use DocumentLocation to specify the bucket name and file name
|
791
|
+
# of the document.
|
702
792
|
#
|
703
793
|
# `StartDocumentAnalysis` returns a job identifier (`JobId`) that you
|
704
794
|
# use to get the results of the operation. When text analysis is
|
@@ -722,22 +812,27 @@ module Aws::Textract
|
|
722
812
|
# @option params [required, Array<String>] :feature_types
|
723
813
|
# A list of the types of analysis to perform. Add TABLES to the list to
|
724
814
|
# return information about the tables that are detected in the input
|
725
|
-
# document. Add FORMS to return detected
|
726
|
-
#
|
727
|
-
#
|
728
|
-
#
|
815
|
+
# document. Add FORMS to return detected form data. To perform both
|
816
|
+
# types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines
|
817
|
+
# and words detected in the document are included in the response
|
818
|
+
# (including text that isn't related to the value of `FeatureTypes`).
|
729
819
|
#
|
730
820
|
# @option params [String] :client_request_token
|
731
821
|
# The idempotent token that you use to identify the start request. If
|
732
822
|
# you use the same token with multiple `StartDocumentAnalysis` requests,
|
733
823
|
# the same `JobId` is returned. Use `ClientRequestToken` to prevent the
|
734
|
-
# same job from being accidentally started more than once.
|
824
|
+
# same job from being accidentally started more than once. For more
|
825
|
+
# information, see [Calling Amazon Textract Asynchronous Operations][1].
|
826
|
+
#
|
827
|
+
#
|
828
|
+
#
|
829
|
+
# [1]: https://docs.aws.amazon.com/textract/latest/dg/api-async.html
|
735
830
|
#
|
736
831
|
# @option params [String] :job_tag
|
737
|
-
# An identifier you specify that's included in the completion
|
738
|
-
# notification
|
739
|
-
#
|
740
|
-
#
|
832
|
+
# An identifier that you specify that's included in the completion
|
833
|
+
# notification published to the Amazon SNS topic. For example, you can
|
834
|
+
# use `JobTag` to identify the type of document that the completion
|
835
|
+
# notification corresponds to (such as a tax form or a receipt).
|
741
836
|
#
|
742
837
|
# @option params [Types::NotificationChannel] :notification_channel
|
743
838
|
# The Amazon SNS topic ARN that you want Amazon Textract to publish the
|
@@ -784,7 +879,7 @@ module Aws::Textract
|
|
784
879
|
# text.
|
785
880
|
#
|
786
881
|
# `StartDocumentTextDetection` can analyze text in documents that are in
|
787
|
-
#
|
882
|
+
# JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
|
788
883
|
# bucket. Use DocumentLocation to specify the bucket name and file name
|
789
884
|
# of the document.
|
790
885
|
#
|
@@ -812,12 +907,18 @@ module Aws::Textract
|
|
812
907
|
# you use the same token with multiple `StartDocumentTextDetection`
|
813
908
|
# requests, the same `JobId` is returned. Use `ClientRequestToken` to
|
814
909
|
# prevent the same job from being accidentally started more than once.
|
910
|
+
# For more information, see [Calling Amazon Textract Asynchronous
|
911
|
+
# Operations][1].
|
912
|
+
#
|
913
|
+
#
|
914
|
+
#
|
915
|
+
# [1]: https://docs.aws.amazon.com/textract/latest/dg/api-async.html
|
815
916
|
#
|
816
917
|
# @option params [String] :job_tag
|
817
|
-
# An identifier you specify that's included in the completion
|
818
|
-
# notification
|
819
|
-
#
|
820
|
-
#
|
918
|
+
# An identifier that you specify that's included in the completion
|
919
|
+
# notification published to the Amazon SNS topic. For example, you can
|
920
|
+
# use `JobTag` to identify the type of document that the completion
|
921
|
+
# notification corresponds to (such as a tax form or a receipt).
|
821
922
|
#
|
822
923
|
# @option params [Types::NotificationChannel] :notification_channel
|
823
924
|
# The Amazon SNS topic ARN that you want Amazon Textract to publish the
|
@@ -871,7 +972,7 @@ module Aws::Textract
|
|
871
972
|
params: params,
|
872
973
|
config: config)
|
873
974
|
context[:gem_name] = 'aws-sdk-textract'
|
874
|
-
context[:gem_version] = '1.
|
975
|
+
context[:gem_version] = '1.15.0'
|
875
976
|
Seahorse::Client::Request.new(handlers, context)
|
876
977
|
end
|
877
978
|
|