Package-level declarations
Types
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.
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
The result of calling the operation. The operation returns one object that is successfully processed by the operation.
Analysis results for one of the documents in the batch.
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.
The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
A reference to a block.
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).
Nested block contained within a block.
Describes the result metrics for the test data associated with an documentation classifier.
Provides information about a document classifier.
Base class for all service related exceptions thrown by the Comprehend client
Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
Data security configuration.
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.
Describes the dataset input data configuration for a document classifier model.
Describes the annotations associated with a entity recognizer.
Describes the documents submitted with a dataset for an entity recognizer model.
Describes the dataset entity list for an entity recognizer model.
Specifies the format and location of the input data. You must provide either the Annotations
parameter or the EntityList
parameter.
Filter the datasets based on creation time or dataset status.
Specifies the format and location of the input data for the dataset.
Properties associated with the dataset.
Specifies the class that categorizes the document being analyzed
Configuration required for a document classification model.
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.
Provides information about a document classification job.
The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.
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.
The input properties for training a document classifier.
Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.
Provides information about a document classifier.
Describes information about a document classifier and its versions.
Specifies one of the label or labels that categorize the document being analyzed.
Information about the document, discovered during text extraction.
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
TABLES or FORMS
Document type for each page in the document.
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.
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
Provides information about a dominant language detection job.
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.
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
Provides information about an entities detection job.
Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.
Configuration required for an entity recognition model.
Describes the annotations associated with a entity recognizer.
Describes the training documents submitted with an entity recognizer.
Describes the entity list submitted with an entity recognizer.
Detailed information about the accuracy of an entity recognizer.
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./>
Specifies the format and location of the input data.
Detailed information about an entity recognizer.
Individual item from the list of entity types in the metadata of an entity recognizer.
Output data configuration.
Describes information about an entity recognizer.
Describes the information about an entity recognizer and its versions.
Detailed information about the accuracy of an entity recognizer for a specific entity type.
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Text extraction encountered one or more page-level errors in the input document.
Provides information for filtering a list of event detection jobs.
Provides information about an events detection job.
Array of the number of characters extracted from each page.
Filter the flywheels based on creation time or flywheel status.
Filter the flywheel iterations based on creation time.
The configuration properties of a flywheel iteration.
The evaluation metrics associated with the evaluated model.
The flywheel properties.
Flywheel summary information.
The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
An internal server error occurred. Retry your request.
The filter specified for the operation is invalid. Specify a different filter.
Provides additional detail about why the request failed.
The request is invalid.
The specified job was not found. Check the job ID and try again.
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
Provides information about a key phrases detection job.
The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
Contains the sentiment and sentiment score for one mention of an entity.
Provides configuration parameters for the output of inference jobs.
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.
Provides information for filtering a list of PII entity detection jobs.
Provides information about a PII entities detection job.
Provides configuration parameters for the output of PII entity detection jobs.
Provides configuration parameters for PII entity redaction.
List of child blocks for the current block.
The specified resource name is already in use. Use a different name and try your request again.
The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
The specified resource ARN was not found. Check the ARN and try your request again.
The specified resource is not available. Check the resource and try your request again.
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
Provides information about a sentiment detection job.
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
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.
Provides information for filtering a list of dominant language detection jobs. For more information, see the ListTargetedSentimentDetectionJobs
operation.
Provides information about a targeted sentiment detection job.
Information about one of the entities found by targeted sentiment analysis.
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.
Configuration about the model associated with a flywheel.
One of the of text strings. Each string has a size limit of 1KB.
The size of the input text exceeds the limit. Use a smaller document.
The number of requests exceeds the limit. Resubmit your request later.
The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
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.
Provides information for filtering topic detection jobs. For more information, see .
Provides information about a topic detection job.
Toxic content analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide
Toxicity analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.
Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
Data security configuration.
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.
The system identified one of the following warnings while processing the input document: