Class: Aws::Textract::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Textract::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-textract/client.rb

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#analyze_document(params = {}) ⇒ Types::AnalyzeDocumentResponse

Analyzes an input document for relationships between detected items.
#detect_document_text(params = {}) ⇒ Types::DetectDocumentTextResponse

Detects text in the input document.
#get_document_analysis(params = {}) ⇒ Types::GetDocumentAnalysisResponse

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
#get_document_text_detection(params = {}) ⇒ Types::GetDocumentTextDetectionResponse

Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
#start_document_analysis(params = {}) ⇒ Types::StartDocumentAnalysisResponse

Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.
#start_document_text_detection(params = {}) ⇒ Types::StartDocumentTextDetectionResponse

Starts the asynchronous detection of text in a document.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- Aws::Credentials - Used for configuring static, non-refreshing credentials.
- Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- Aws::SharedCredentials - Used for loading credentials from a shared file, such as ‘~/.aws/config`.
- Aws::AssumeRoleCredentials - Used when you need to assume a role.
When :credentials are not configured directly, the following locations will be searched for credentials:
- Aws.config[:credentials]
- The :access_key_id, :secret_access_key, and :session_token options.
- ENV, ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
:region (required, String) —
The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:
- Aws.config[:region]
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.
:client_side_monitoring (Boolean) — default: false —

When true, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —

Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When true, an attempt is made to coerce request parameters into the required types.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:endpoint (String) —

The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —

When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —

When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the :logger at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function.
:retry_jitter (Symbol) — default: :none —

A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

@see www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —

The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.
:retry_max_delay (Integer) — default: 0 —

The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
:secret_access_key (String)
:session_token (String)
:simple_json (Boolean) — default: false —

Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.
:stub_responses (Boolean) — default: false —

Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:validate_params (Boolean) — default: true —

When true, request parameters are validated before sending the request.
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_open_timeout (Float) — default: 15 —

The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.
:http_read_timeout (Integer) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.
:http_idle_timeout (Float) — default: 5 —

The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_continue_timeout (Float) — default: 1 —

The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.
:http_wire_trace (Boolean) — default: false —

When true, HTTP debug output will be sent to the :logger.
:ssl_verify_peer (Boolean) — default: true —

When true, SSL peer certificates are verified when establishing a connection.
:ssl_ca_bundle (String) —

Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.
:ssl_ca_directory (String) —

Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



261
262
263

# File 'lib/aws-sdk-textract/client.rb', line 261

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



887
888
889

# File 'lib/aws-sdk-textract/client.rb', line 887

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



890
891
892

# File 'lib/aws-sdk-textract/client.rb', line 890

def errors_module
  Errors
end

Instance Method Details

#analyze_document(params = {}) ⇒ `Types::AnalyzeDocumentResponse`

Analyzes an input document for relationships between detected items.

The types of information returned are as follows:

Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, *Name: Ana Silva Carolina* contains a key and value. Name: is the key. *Ana Silva Carolina* is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of BLOCK objects.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

For more information, see [Document Text Analysis].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html

Examples:

Request syntax with placeholder values


resp = client.analyze_document({
  document: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  feature_types: ["TABLES"], # required, accepts TABLES, FORMS
})

Response structure


resp.document_metadata.pages #=> Integer
resp.blocks #=> Array
resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
resp.blocks[0].confidence #=> Float
resp.blocks[0].text #=> String
resp.blocks[0].row_index #=> Integer
resp.blocks[0].column_index #=> Integer
resp.blocks[0].row_span #=> Integer
resp.blocks[0].column_span #=> Integer
resp.blocks[0].geometry.bounding_box.width #=> Float
resp.blocks[0].geometry.bounding_box.height #=> Float
resp.blocks[0].geometry.bounding_box.left #=> Float
resp.blocks[0].geometry.bounding_box.top #=> Float
resp.blocks[0].geometry.polygon #=> Array
resp.blocks[0].geometry.polygon[0].x #=> Float
resp.blocks[0].geometry.polygon[0].y #=> Float
resp.blocks[0].id #=> String
resp.blocks[0].relationships #=> Array
resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
resp.blocks[0].relationships[0].ids #=> Array
resp.blocks[0].relationships[0].ids[0] #=> String
resp.blocks[0].entity_types #=> Array
resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
resp.blocks[0].page #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:document (required, Types::Document) —

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can’t pass image bytes. The document must be an image in JPG or PNG format.

If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
:feature_types (required, Array<String>) —

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes.

Returns:

(Types::AnalyzeDocumentResponse) —
Returns a response object which responds to the following methods:
- #document_metadata => Types::DocumentMetadata
- #blocks => Array<Types::Block>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-textract/client.rb', line 368

def analyze_document(params = {}, options = {})
  req = build_request(:analyze_document, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-textract/client.rb', line 865

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-textract'
  context[:gem_version] = '1.10.0'
  Seahorse::Client::Request.new(handlers, context)
end

#detect_document_text(params = {}) ⇒ `Types::DetectDocumentTextResponse`

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

For more information, see [Document Text Detection].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html

Examples:

Request syntax with placeholder values


resp = client.detect_document_text({
  document: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
})

Response structure


resp.document_metadata.pages #=> Integer
resp.blocks #=> Array
resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
resp.blocks[0].confidence #=> Float
resp.blocks[0].text #=> String
resp.blocks[0].row_index #=> Integer
resp.blocks[0].column_index #=> Integer
resp.blocks[0].row_span #=> Integer
resp.blocks[0].column_span #=> Integer
resp.blocks[0].geometry.bounding_box.width #=> Float
resp.blocks[0].geometry.bounding_box.height #=> Float
resp.blocks[0].geometry.bounding_box.left #=> Float
resp.blocks[0].geometry.bounding_box.top #=> Float
resp.blocks[0].geometry.polygon #=> Array
resp.blocks[0].geometry.polygon[0].x #=> Float
resp.blocks[0].geometry.polygon[0].y #=> Float
resp.blocks[0].id #=> String
resp.blocks[0].relationships #=> Array
resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
resp.blocks[0].relationships[0].ids #=> Array
resp.blocks[0].relationships[0].ids[0] #=> String
resp.blocks[0].entity_types #=> Array
resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
resp.blocks[0].page #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:document (required, Types::Document) —

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can’t pass image bytes. The document must be an image in JPG or PNG format.

If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

Returns:

(Types::DetectDocumentTextResponse) —
Returns a response object which responds to the following methods:
- #document_metadata => Types::DocumentMetadata
- #blocks => Array<Types::Block>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-textract/client.rb', line 451

def detect_document_text(params = {}, options = {})
  req = build_request(:detect_document_text, params)
  req.send_request(options)
end

#get_document_analysis(params = {}) ⇒ `Types::GetDocumentAnalysisResponse`

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, *Name: Ana Silva Carolina* contains a key and value. Name: is the key. *Ana Silva Carolina* is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

Use the MaxResults parameter to limit the number of blocks returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetDocumentAnalysis.

For more information, see [Document Text Analysis].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html

Examples:

Request syntax with placeholder values


resp = client.get_document_analysis({
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.document_metadata.pages #=> Integer
resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
resp.next_token #=> String
resp.blocks #=> Array
resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
resp.blocks[0].confidence #=> Float
resp.blocks[0].text #=> String
resp.blocks[0].row_index #=> Integer
resp.blocks[0].column_index #=> Integer
resp.blocks[0].row_span #=> Integer
resp.blocks[0].column_span #=> Integer
resp.blocks[0].geometry.bounding_box.width #=> Float
resp.blocks[0].geometry.bounding_box.height #=> Float
resp.blocks[0].geometry.bounding_box.left #=> Float
resp.blocks[0].geometry.bounding_box.top #=> Float
resp.blocks[0].geometry.polygon #=> Array
resp.blocks[0].geometry.polygon[0].x #=> Float
resp.blocks[0].geometry.polygon[0].y #=> Float
resp.blocks[0].id #=> String
resp.blocks[0].relationships #=> Array
resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
resp.blocks[0].relationships[0].ids #=> Array
resp.blocks[0].relationships[0].ids[0] #=> String
resp.blocks[0].entity_types #=> Array
resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
resp.blocks[0].page #=> Integer
resp.warnings #=> Array
resp.warnings[0].error_code #=> String
resp.warnings[0].pages #=> Array
resp.warnings[0].pages[0] #=> Integer
resp.status_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:job_id (required, String) —

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis.
:max_results (Integer) —

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
:next_token (String) —

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Returns:

(Types::GetDocumentAnalysisResponse) —
Returns a response object which responds to the following methods:
- #document_metadata => Types::DocumentMetadata
- #job_status => String
- #next_token => String
- #blocks => Array<Types::Block>
- #warnings => Array<Types::Warning>
- #status_message => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-textract/client.rb', line 575

def get_document_analysis(params = {}, options = {})
  req = build_request(:get_document_analysis, params)
  req.send_request(options)
end

#get_document_text_detection(params = {}) ⇒ `Types::GetDocumentTextDetectionResponse`

Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

GetDocumentTextDetection returns an array of Block objects.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetDocumentTextDetection.

For more information, see [Document Text Detection].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html

Examples:

Request syntax with placeholder values


resp = client.get_document_text_detection({
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.document_metadata.pages #=> Integer
resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
resp.next_token #=> String
resp.blocks #=> Array
resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
resp.blocks[0].confidence #=> Float
resp.blocks[0].text #=> String
resp.blocks[0].row_index #=> Integer
resp.blocks[0].column_index #=> Integer
resp.blocks[0].row_span #=> Integer
resp.blocks[0].column_span #=> Integer
resp.blocks[0].geometry.bounding_box.width #=> Float
resp.blocks[0].geometry.bounding_box.height #=> Float
resp.blocks[0].geometry.bounding_box.left #=> Float
resp.blocks[0].geometry.bounding_box.top #=> Float
resp.blocks[0].geometry.polygon #=> Array
resp.blocks[0].geometry.polygon[0].x #=> Float
resp.blocks[0].geometry.polygon[0].y #=> Float
resp.blocks[0].id #=> String
resp.blocks[0].relationships #=> Array
resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
resp.blocks[0].relationships[0].ids #=> Array
resp.blocks[0].relationships[0].ids[0] #=> String
resp.blocks[0].entity_types #=> Array
resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
resp.blocks[0].page #=> Integer
resp.warnings #=> Array
resp.warnings[0].error_code #=> String
resp.warnings[0].pages #=> Array
resp.warnings[0].pages[0] #=> Integer
resp.status_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:job_id (required, String) —

A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection.
:max_results (Integer) —

The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
:next_token (String) —

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Returns:

(Types::GetDocumentTextDetectionResponse) —
Returns a response object which responds to the following methods:
- #document_metadata => Types::DocumentMetadata
- #job_status => String
- #next_token => String
- #blocks => Array<Types::Block>
- #warnings => Array<Types::Warning>
- #status_message => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-textract/client.rb', line 689

def get_document_text_detection(params = {}, options = {})
  req = build_request(:get_document_text_detection, params)
  req.send_request(options)
end

#start_document_analysis(params = {}) ⇒ `Types::StartDocumentAnalysisResponse`

Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.

StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

For more information, see [Document Text Analysis].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html

Examples:

Request syntax with placeholder values


resp = client.start_document_analysis({
  document_location: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  feature_types: ["TABLES"], # required, accepts TABLES, FORMS
  client_request_token: "ClientRequestToken",
  job_tag: "JobTag",
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
})

Response structure


resp.job_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:document_location (required, Types::DocumentLocation) —

The location of the document to be processed.
:feature_types (required, Array<String>) —

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.
:client_request_token (String) —

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.
:job_tag (String) —

An identifier you specify that’s included in the completion notification that’s published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.
:notification_channel (Types::NotificationChannel) —

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

(Types::StartDocumentAnalysisResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-textract/client.rb', line 777

def start_document_analysis(params = {}, options = {})
  req = build_request(:start_document_analysis, params)
  req.send_request(options)
end

#start_document_text_detection(params = {}) ⇒ `Types::StartDocumentTextDetectionResponse`

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

StartDocumentTextDetection can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see [Document Text Detection].

[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html

Examples:

Request syntax with placeholder values


resp = client.start_document_text_detection({
  document_location: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  client_request_token: "ClientRequestToken",
  job_tag: "JobTag",
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
})

Response structure


resp.job_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:document_location (required, Types::DocumentLocation) —

The location of the document to be processed.
:client_request_token (String) —

The idempotent token that’s used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.
:job_tag (String) —

An identifier you specify that’s included in the completion notification that’s published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.
:notification_channel (Types::NotificationChannel) —

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

(Types::StartDocumentTextDetectionResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-textract/client.rb', line 856

def start_document_text_detection(params = {}, options = {})
  req = build_request(:start_document_text_detection, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



880
881
882

# File 'lib/aws-sdk-textract/client.rb', line 880

def waiter_names
  []
end

Class: Aws::Textract::Client

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#analyze_document(params = {}) ⇒ Types::AnalyzeDocumentResponse

Examples:

Request syntax with placeholder values

Response structure

#build_request(operation_name, params = {}) ⇒ Object

#detect_document_text(params = {}) ⇒ Types::DetectDocumentTextResponse

Examples:

Request syntax with placeholder values

Response structure

#get_document_analysis(params = {}) ⇒ Types::GetDocumentAnalysisResponse

Examples:

Request syntax with placeholder values

Response structure

#get_document_text_detection(params = {}) ⇒ Types::GetDocumentTextDetectionResponse

Examples:

Request syntax with placeholder values

Response structure

#start_document_analysis(params = {}) ⇒ Types::StartDocumentAnalysisResponse

Examples:

Request syntax with placeholder values

Response structure

#start_document_text_detection(params = {}) ⇒ Types::StartDocumentTextDetectionResponse

Examples:

Request syntax with placeholder values

Response structure

#waiter_names ⇒ Object

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#analyze_document(params = {}) ⇒ `Types::AnalyzeDocumentResponse`

#build_request(operation_name, params = {}) ⇒ `Object`

#detect_document_text(params = {}) ⇒ `Types::DetectDocumentTextResponse`

#get_document_analysis(params = {}) ⇒ `Types::GetDocumentAnalysisResponse`

#get_document_text_detection(params = {}) ⇒ `Types::GetDocumentTextDetectionResponse`

#start_document_analysis(params = {}) ⇒ `Types::StartDocumentAnalysisResponse`

#start_document_text_detection(params = {}) ⇒ `Types::StartDocumentTextDetectionResponse`

#waiter_names ⇒ `Object`