Package-level declarations

Types

Link copied to clipboard

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

Link copied to clipboard

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Link copied to clipboard

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Link copied to clipboard

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Link copied to clipboard

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Link copied to clipboard

The result of calling the operation. The operation returns one object that is successfully processed by the operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Analysis results for one of the documents in the batch.

Link copied to clipboard

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

Link copied to clipboard

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

Link copied to clipboard
class Block

Information about each word or line of text in the input document.

Link copied to clipboard

A reference to a block.

Link copied to clipboard
sealed class BlockType
Link copied to clipboard

The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

Link copied to clipboard

Nested block contained within a block.

Link copied to clipboard

Describes the result metrics for the test data associated with an documentation classifier.

Link copied to clipboard

Provides information about a document classifier.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Base class for all service related exceptions thrown by the Comprehend client

Link copied to clipboard

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Data security configuration.

Link copied to clipboard

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

Link copied to clipboard
sealed class DatasetDataFormat
Link copied to clipboard

Describes the dataset input data configuration for a document classifier model.

Link copied to clipboard

Describes the annotations associated with a entity recognizer.

Link copied to clipboard

Describes the documents submitted with a dataset for an entity recognizer model.

Link copied to clipboard

Describes the dataset entity list for an entity recognizer model.

Link copied to clipboard

Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.

Link copied to clipboard

Filter the datasets based on creation time or dataset status.

Link copied to clipboard

Specifies the format and location of the input data for the dataset.

Link copied to clipboard

Properties associated with the dataset.

Link copied to clipboard
sealed class DatasetStatus
Link copied to clipboard
sealed class DatasetType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies the class that categorizes the document being analyzed

Link copied to clipboard

Configuration required for a document classification model.

Link copied to clipboard

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

Link copied to clipboard

Provides information about a document classification job.

Link copied to clipboard
Link copied to clipboard

The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.

Link copied to clipboard

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the ListDocumentClassifiers operation.

Link copied to clipboard

The input properties for training a document classifier.

Link copied to clipboard
Link copied to clipboard

Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.

Link copied to clipboard

Provides information about a document classifier.

Link copied to clipboard

Describes information about a document classifier and its versions.

Link copied to clipboard

Specifies one of the label or labels that categorize the document being analyzed.

Link copied to clipboard

Information about the document, discovered during text extraction.

Link copied to clipboard
sealed class DocumentReadAction
Link copied to clipboard

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

Link copied to clipboard

TABLES or FORMS

Link copied to clipboard
sealed class DocumentReadMode
Link copied to clipboard
sealed class DocumentType
Link copied to clipboard

Document type for each page in the document.

Link copied to clipboard

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

Link copied to clipboard

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Link copied to clipboard

Provides information about a dominant language detection job.

Link copied to clipboard

The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

Link copied to clipboard

Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.

Link copied to clipboard
sealed class EndpointStatus
Link copied to clipboard

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Link copied to clipboard

Provides information about an entities detection job.

Link copied to clipboard
class Entity

Provides information about an entity.

Link copied to clipboard

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

Link copied to clipboard

Configuration required for an entity recognition model.

Link copied to clipboard

Describes the annotations associated with a entity recognizer.

Link copied to clipboard
Link copied to clipboard

Describes the training documents submitted with an entity recognizer.

Link copied to clipboard

Describes the entity list submitted with an entity recognizer.

Link copied to clipboard

Detailed information about the accuracy of an entity recognizer.

Link copied to clipboard

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the ListEntityRecognizers operation./>

Link copied to clipboard

Specifies the format and location of the input data.

Link copied to clipboard

Detailed information about an entity recognizer.

Individual item from the list of entity types in the metadata of an entity recognizer.

Link copied to clipboard

Output data configuration.

Link copied to clipboard

Describes information about an entity recognizer.

Link copied to clipboard

Describes the information about an entity recognizer and its versions.

Link copied to clipboard
sealed class EntityType
Link copied to clipboard

Detailed information about the accuracy of an entity recognizer for a specific entity type.

Link copied to clipboard

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

Link copied to clipboard

Text extraction encountered one or more page-level errors in the input document.

Link copied to clipboard

Provides information for filtering a list of event detection jobs.

Link copied to clipboard

Provides information about an events detection job.

Link copied to clipboard

Array of the number of characters extracted from each page.

Link copied to clipboard

Filter the flywheels based on creation time or flywheel status.

Link copied to clipboard

Filter the flywheel iterations based on creation time.

Link copied to clipboard

The configuration properties of a flywheel iteration.

Link copied to clipboard
Link copied to clipboard

The evaluation metrics associated with the evaluated model.

Link copied to clipboard

The flywheel properties.

Link copied to clipboard
sealed class FlywheelStatus
Link copied to clipboard

Flywheel summary information.

Link copied to clipboard
class Geometry

Information about the location of items on a document page.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

Link copied to clipboard
sealed class InputFormat
Link copied to clipboard

An internal server error occurred. Retry your request.

Link copied to clipboard

The filter specified for the operation is invalid. Specify a different filter.

Link copied to clipboard

Provides additional detail about why the request failed.

Link copied to clipboard
Link copied to clipboard

The request is invalid.

Link copied to clipboard
Link copied to clipboard

The specified job was not found. Check the job ID and try again.

Link copied to clipboard
sealed class JobStatus
Link copied to clipboard
class KeyPhrase

Describes a key noun phrase.

Link copied to clipboard

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Link copied to clipboard

Provides information about a key phrases detection job.

Link copied to clipboard

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

Link copied to clipboard
sealed class LanguageCode
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains the sentiment and sentiment score for one mention of an entity.

Link copied to clipboard
sealed class ModelStatus
Link copied to clipboard
sealed class ModelType
Link copied to clipboard

Provides configuration parameters for the output of inference jobs.

Link copied to clipboard
sealed class PageBasedErrorCode
Link copied to clipboard
Link copied to clipboard

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see Syntax in the Comprehend Developer Guide.

Link copied to clipboard
sealed class PartOfSpeechTagType
Link copied to clipboard

Provides information for filtering a list of PII entity detection jobs.

Link copied to clipboard

Provides information about a PII entities detection job.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class PiiEntity

Provides information about a PII entity.

Link copied to clipboard
sealed class PiiEntityType
Link copied to clipboard

Provides configuration parameters for the output of PII entity detection jobs.

Link copied to clipboard
class Point

The X and Y coordinates of a point on a document page.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides configuration parameters for PII entity redaction.

Link copied to clipboard

List of child blocks for the current block.

Link copied to clipboard
sealed class RelationshipType
Link copied to clipboard

The specified resource name is already in use. Use a different name and try your request again.

Link copied to clipboard

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

Link copied to clipboard

The specified resource ARN was not found. Check the ARN and try your request again.

Link copied to clipboard

The specified resource is not available. Check the resource and try your request again.

Link copied to clipboard

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

Link copied to clipboard

Provides information about a sentiment detection job.

Link copied to clipboard

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

Link copied to clipboard
sealed class SentimentType
Link copied to clipboard
sealed class Split
Link copied to clipboard
sealed class SyntaxLanguageCode
Link copied to clipboard

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

Link copied to clipboard
class Tag

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides information for filtering a list of dominant language detection jobs. For more information, see the ListTargetedSentimentDetectionJobs operation.

Link copied to clipboard

Provides information about a targeted sentiment detection job.

Link copied to clipboard

Information about one of the entities found by targeted sentiment analysis.

Link copied to clipboard
Link copied to clipboard

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

Link copied to clipboard

Configuration about the model associated with a flywheel.

Link copied to clipboard

One of the of text strings. Each string has a size limit of 1KB.

Link copied to clipboard

The size of the input text exceeds the limit. Use a smaller document.

Link copied to clipboard

The number of requests exceeds the limit. Resubmit your request later.

Link copied to clipboard

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

Link copied to clipboard

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

Link copied to clipboard

Provides information for filtering topic detection jobs. For more information, see .

Link copied to clipboard

Provides information about a topic detection job.

Link copied to clipboard

Toxic content analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide

Link copied to clipboard
sealed class ToxicContentType
Link copied to clipboard

Toxicity analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

Link copied to clipboard

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Data security configuration.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Link copied to clipboard

The system identified one of the following warnings while processing the input document: