paws (version 0.3.0)

textract: Amazon Textract

Description

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Usage

textract(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• access_key_id: AWS access key ID

• secret_access_key: AWS secret access key

• session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- textract(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

analyze_document	Analyzes an input document for relationships between detected items
analyze_expense	AnalyzeExpense synchronously analyzes an input document for financially related relationships between text
analyze_id	Analyzes identity documents for relevant information
detect_document_text	Detects text in the input document
get_document_analysis	Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document
get_document_text_detection	Gets the results for an Amazon Textract asynchronous operation that detects text in a document
get_expense_analysis	Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts
get_lending_analysis	Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document
get_lending_analysis_summary	Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document
start_document_analysis	Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements
start_document_text_detection	Starts the asynchronous detection of text in a document
start_expense_analysis	Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names
start_lending_analysis	Starts the classification and analysis of an input document

Examples

if (FALSE) {
svc <- textract()
svc$analyze_document(
  Foo = 123
)
}