textract: Amazon Textract

In paws: Amazon Web Services Software Development Kit

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(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: 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⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: 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	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

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.

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",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

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
create_adapter	Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents
create_adapter_version	Creates a new version of an adapter
delete_adapter	Deletes an Amazon Textract adapter
delete_adapter_version	Deletes an Amazon Textract adapter version
detect_document_text	Detects text in the input document
get_adapter	Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes
get_adapter_version	Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics
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
list_adapters	Lists all adapters that match the specified filtration criteria
list_adapter_versions	List all version of an adapter that meet the specified filtration criteria
list_tags_for_resource	Lists all tags for an Amazon Textract resource
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
tag_resource	Adds one or more tags to the specified resource
untag_resource	Removes any tags with the specified keys from the specified resource
update_adapter	Update the configuration for an adapter

Examples

## Not run: 
svc <- textract()
svc$analyze_document(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.