Documentation

Overview

    Package textract provides the API client, operations, and parameter types for Amazon Textract.

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

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-06-27"
    View Source
    const ServiceID = "Textract"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type AnalyzeDocumentInput

          type AnalyzeDocumentInput struct {
          
          	// 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 JPEG or PNG format. If you're using an AWS SDK to
          	// call Amazon Textract, you might not need to base64-encode image bytes that are
          	// passed using the Bytes field.
          	//
          	// This member is required.
          	Document *types.Document
          
          	// 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 form data. To perform both types of analysis, add TABLES and
          	// FORMS to FeatureTypes. All lines and words detected in the document are included
          	// in the response (including text that isn't related to the value of
          	// FeatureTypes).
          	//
          	// This member is required.
          	FeatureTypes []types.FeatureType
          
          	// Sets the configuration for the human in the loop workflow for analyzing
          	// documents.
          	HumanLoopConfig *types.HumanLoopConfig
          }

          type AnalyzeDocumentOutput

          type AnalyzeDocumentOutput struct {
          
          	// The version of the model used to analyze the document.
          	AnalyzeDocumentModelVersion *string
          
          	// The items that are detected and analyzed by AnalyzeDocument.
          	Blocks []types.Block
          
          	// Metadata about the analyzed document. An example is the number of pages.
          	DocumentMetadata *types.DocumentMetadata
          
          	// Shows the results of the human in the loop evaluation.
          	HumanLoopActivationOutput *types.HumanLoopActivationOutput
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for Amazon Textract.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) AnalyzeDocument

                func (c *Client) AnalyzeDocument(ctx context.Context, params *AnalyzeDocumentInput, optFns ...func(*Options)) (*AnalyzeDocumentOutput, error)

                  Analyzes an input document for relationships between detected items. The types of information returned are as follows:

                  * Form data (key-value pairs). 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.

                  * Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).

                  Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status. 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

                  func (*Client) DetectDocumentText

                  func (c *Client) DetectDocumentText(ctx context.Context, params *DetectDocumentTextInput, optFns ...func(*Options)) (*DetectDocumentTextOutput, error)

                    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 JPEG 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

                    func (*Client) GetDocumentAnalysis

                    func (c *Client) GetDocumentAnalysis(ctx context.Context, params *GetDocumentAnalysisInput, optFns ...func(*Options)) (*GetDocumentAnalysisOutput, error)

                      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:

                      * Form data (key-value pairs). 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.

                      * Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysisFeatureTypes input parameter).

                      Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status. 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 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

                      func (*Client) GetDocumentTextDetection

                      func (c *Client) GetDocumentTextDetection(ctx context.Context, params *GetDocumentTextDetectionInput, optFns ...func(*Options)) (*GetDocumentTextDetectionOutput, error)

                        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. 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. 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

                        func (*Client) StartDocumentAnalysis

                        func (c *Client) StartDocumentAnalysis(ctx context.Context, params *StartDocumentAnalysisInput, optFns ...func(*Options)) (*StartDocumentAnalysisOutput, error)

                          Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPEG, 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

                          func (*Client) StartDocumentTextDetection

                          func (c *Client) StartDocumentTextDetection(ctx context.Context, params *StartDocumentTextDetectionInput, optFns ...func(*Options)) (*StartDocumentTextDetectionOutput, error)

                            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 JPEG, 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 (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

                            type DetectDocumentTextInput

                            type DetectDocumentTextInput struct {
                            
                            	// 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 JPEG or PNG format. If you're using an AWS SDK to
                            	// call Amazon Textract, you might not need to base64-encode image bytes that are
                            	// passed using the Bytes field.
                            	//
                            	// This member is required.
                            	Document *types.Document
                            }

                            type DetectDocumentTextOutput

                            type DetectDocumentTextOutput struct {
                            
                            	// An array of Block objects that contain the text that's detected in the document.
                            	Blocks []types.Block
                            
                            	//
                            	DetectDocumentTextModelVersion *string
                            
                            	// Metadata about the document. It contains the number of pages that are detected
                            	// in the document.
                            	DocumentMetadata *types.DocumentMetadata
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type EndpointResolver

                            type EndpointResolver interface {
                            	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                            }

                              EndpointResolver interface for resolving service endpoints.

                              func EndpointResolverFromURL

                              func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                type EndpointResolverFunc

                                type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                  EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                  func (EndpointResolverFunc) ResolveEndpoint

                                  func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                  type EndpointResolverOptions

                                  type EndpointResolverOptions = internalendpoints.Options

                                    EndpointResolverOptions is the service endpoint resolver options

                                    type GetDocumentAnalysisInput

                                    type GetDocumentAnalysisInput struct {
                                    
                                    	// A unique identifier for the text-detection job. The JobId is returned from
                                    	// StartDocumentAnalysis. A JobId value is only valid for 7 days.
                                    	//
                                    	// This member is required.
                                    	JobId *string
                                    
                                    	// 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.
                                    	MaxResults *int32
                                    
                                    	// 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.
                                    	NextToken *string
                                    }

                                    type GetDocumentAnalysisOutput

                                    type GetDocumentAnalysisOutput struct {
                                    
                                    	//
                                    	AnalyzeDocumentModelVersion *string
                                    
                                    	// The results of the text-analysis operation.
                                    	Blocks []types.Block
                                    
                                    	// Information about a document that Amazon Textract processed. DocumentMetadata is
                                    	// returned in every page of paginated responses from an Amazon Textract video
                                    	// operation.
                                    	DocumentMetadata *types.DocumentMetadata
                                    
                                    	// The current status of the text detection job.
                                    	JobStatus types.JobStatus
                                    
                                    	// If the response is truncated, Amazon Textract returns this token. You can use
                                    	// this token in the subsequent request to retrieve the next set of text detection
                                    	// results.
                                    	NextToken *string
                                    
                                    	// Returns if the detection job could not be completed. Contains explanation for
                                    	// what error occured.
                                    	StatusMessage *string
                                    
                                    	// A list of warnings that occurred during the document-analysis operation.
                                    	Warnings []types.Warning
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type GetDocumentTextDetectionInput

                                    type GetDocumentTextDetectionInput struct {
                                    
                                    	// A unique identifier for the text detection job. The JobId is returned from
                                    	// StartDocumentTextDetection. A JobId value is only valid for 7 days.
                                    	//
                                    	// This member is required.
                                    	JobId *string
                                    
                                    	// 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.
                                    	MaxResults *int32
                                    
                                    	// 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.
                                    	NextToken *string
                                    }

                                    type GetDocumentTextDetectionOutput

                                    type GetDocumentTextDetectionOutput struct {
                                    
                                    	// The results of the text-detection operation.
                                    	Blocks []types.Block
                                    
                                    	//
                                    	DetectDocumentTextModelVersion *string
                                    
                                    	// Information about a document that Amazon Textract processed. DocumentMetadata is
                                    	// returned in every page of paginated responses from an Amazon Textract video
                                    	// operation.
                                    	DocumentMetadata *types.DocumentMetadata
                                    
                                    	// The current status of the text detection job.
                                    	JobStatus types.JobStatus
                                    
                                    	// If the response is truncated, Amazon Textract returns this token. You can use
                                    	// this token in the subsequent request to retrieve the next set of text-detection
                                    	// results.
                                    	NextToken *string
                                    
                                    	// Returns if the detection job could not be completed. Contains explanation for
                                    	// what error occured.
                                    	StatusMessage *string
                                    
                                    	// A list of warnings that occurred during the text-detection operation for the
                                    	// document.
                                    	Warnings []types.Warning
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type HTTPClient

                                    type HTTPClient interface {
                                    	Do(*http.Request) (*http.Response, error)
                                    }

                                    type HTTPSignerV4

                                    type HTTPSignerV4 interface {
                                    	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                    }

                                    type Options

                                    type Options struct {
                                    	// Set of options to modify how an operation is invoked. These apply to all
                                    	// operations invoked for this client. Use functional options on operation call to
                                    	// modify this list for per operation behavior.
                                    	APIOptions []func(*middleware.Stack) error
                                    
                                    	// Configures the events that will be sent to the configured logger.
                                    	ClientLogMode aws.ClientLogMode
                                    
                                    	// The credentials object to use when signing requests.
                                    	Credentials aws.CredentialsProvider
                                    
                                    	// The endpoint options to be used when attempting to resolve an endpoint.
                                    	EndpointOptions EndpointResolverOptions
                                    
                                    	// The service endpoint resolver.
                                    	EndpointResolver EndpointResolver
                                    
                                    	// Signature Version 4 (SigV4) Signer
                                    	HTTPSignerV4 HTTPSignerV4
                                    
                                    	// The logger writer interface to write logging messages to.
                                    	Logger logging.Logger
                                    
                                    	// The region to send requests to. (Required)
                                    	Region string
                                    
                                    	// Retryer guides how HTTP requests should be retried in case of recoverable
                                    	// failures. When nil the API client will use a default retryer.
                                    	Retryer aws.Retryer
                                    
                                    	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                    	// implementation if nil.
                                    	HTTPClient HTTPClient
                                    }

                                    func (Options) Copy

                                    func (o Options) Copy() Options

                                      Copy creates a clone where the APIOptions list is deep copied.

                                      type ResolveEndpoint

                                      type ResolveEndpoint struct {
                                      	Resolver EndpointResolver
                                      	Options  EndpointResolverOptions
                                      }

                                      func (*ResolveEndpoint) HandleSerialize

                                      func (*ResolveEndpoint) ID

                                      func (*ResolveEndpoint) ID() string

                                      type StartDocumentAnalysisInput

                                      type StartDocumentAnalysisInput struct {
                                      
                                      	// The location of the document to be processed.
                                      	//
                                      	// This member is required.
                                      	DocumentLocation *types.DocumentLocation
                                      
                                      	// 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 form data. To perform both types of analysis, add TABLES and
                                      	// FORMS to FeatureTypes. All lines and words detected in the document are included
                                      	// in the response (including text that isn't related to the value of
                                      	// FeatureTypes).
                                      	//
                                      	// This member is required.
                                      	FeatureTypes []types.FeatureType
                                      
                                      	// 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. For more information, see Calling Amazon Textract
                                      	// Asynchronous Operations
                                      	// (https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
                                      	ClientRequestToken *string
                                      
                                      	// An identifier that you specify that's included in the completion notification
                                      	// published to the Amazon SNS topic. For example, you can use JobTag to identify
                                      	// the type of document that the completion notification corresponds to (such as a
                                      	// tax form or a receipt).
                                      	JobTag *string
                                      
                                      	// The KMS key used to encrypt the inference results. This can be in either Key ID
                                      	// or Key Alias format. When a KMS key is provided, the KMS key will be used for
                                      	// server-side encryption of the objects in the customer bucket. When this
                                      	// parameter is not enabled, the result will be encrypted server side,using SSE-S3.
                                      	KMSKeyId *string
                                      
                                      	// The Amazon SNS topic ARN that you want Amazon Textract to publish the completion
                                      	// status of the operation to.
                                      	NotificationChannel *types.NotificationChannel
                                      
                                      	// Sets if the output will go to a customer defined bucket. By default, Amazon
                                      	// Textract will save the results internally to be accessed by the
                                      	// GetDocumentAnalysis operation.
                                      	OutputConfig *types.OutputConfig
                                      }

                                      type StartDocumentAnalysisOutput

                                      type StartDocumentAnalysisOutput struct {
                                      
                                      	// The identifier for the document text detection job. Use JobId to identify the
                                      	// job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for
                                      	// 7 days.
                                      	JobId *string
                                      
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

                                      type StartDocumentTextDetectionInput

                                      type StartDocumentTextDetectionInput struct {
                                      
                                      	// The location of the document to be processed.
                                      	//
                                      	// This member is required.
                                      	DocumentLocation *types.DocumentLocation
                                      
                                      	// 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. For more information, see Calling Amazon Textract
                                      	// Asynchronous Operations
                                      	// (https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
                                      	ClientRequestToken *string
                                      
                                      	// An identifier that you specify that's included in the completion notification
                                      	// published to the Amazon SNS topic. For example, you can use JobTag to identify
                                      	// the type of document that the completion notification corresponds to (such as a
                                      	// tax form or a receipt).
                                      	JobTag *string
                                      
                                      	// The KMS key used to encrypt the inference results. This can be in either Key ID
                                      	// or Key Alias format. When a KMS key is provided, the KMS key will be used for
                                      	// server-side encryption of the objects in the customer bucket. When this
                                      	// parameter is not enabled, the result will be encrypted server side,using SSE-S3.
                                      	KMSKeyId *string
                                      
                                      	// The Amazon SNS topic ARN that you want Amazon Textract to publish the completion
                                      	// status of the operation to.
                                      	NotificationChannel *types.NotificationChannel
                                      
                                      	// Sets if the output will go to a customer defined bucket. By default Amazon
                                      	// Textract will save the results internally to be accessed with the
                                      	// GetDocumentTextDetection operation.
                                      	OutputConfig *types.OutputConfig
                                      }

                                      type StartDocumentTextDetectionOutput

                                      type StartDocumentTextDetectionOutput struct {
                                      
                                      	// The identifier of the text detection job for the document. Use JobId to identify
                                      	// the job in a subsequent call to GetDocumentTextDetection. A JobId value is only
                                      	// valid for 7 days.
                                      	JobId *string
                                      
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

                                      Directories

                                      Path Synopsis
                                      internal