View Source aws_comprehend (aws v0.7.15)
Amazon Comprehend is an AWS service for gaining insight into the content of documents.
Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.Link to this section Summary
Functions
Determines the dominant language of the input text for a batch of documents.
Inspects the text of a batch of documents for named entities and returns information about them.
POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
, in each one.Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them.
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
Creates a new document classifier that you can use to categorize documents.
Creates an entity recognizer using submitted files.
Deletes a previously created document classifier
Deletes a model-specific endpoint for a previously-trained custom model.
Deletes an entity recognizer.
Gets the properties associated with a document classification job.
Gets the properties associated with a dominant language detection job.
Gets the properties associated with a specific endpoint.
Gets the properties associated with an entities detection job.
Gets the properties associated with a key phrases detection job.
Gets the properties associated with a PII entities detection job.
Gets the properties associated with a sentiment detection job.
Gets the properties associated with a targeted sentiment detection job.
Gets the properties associated with a topic detection job.
Determines the dominant language of the input text.
Detects named entities in input text when you use the pre-trained model.
POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
).Inspects text for syntax and the part of speech of words in the document.
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
Creates a new custom model that replicates a source custom model that you import.
Gets a list of all existing endpoints that you've created.
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training.
Attaches a resource-based policy to a custom model.
Starts an asynchronous document classification job.
Starts an asynchronous dominant language detection job for a collection of documents.
Starts an asynchronous entity detection job for a collection of documents.
Starts an asynchronous key phrase detection job for a collection of documents.
Starts an asynchronous sentiment detection job for a collection of documents.
Starts an asynchronous targeted sentiment detection job for a collection of documents.
Starts an asynchronous topic detection job.
Stops a dominant language detection job in progress.
Stops an entities detection job in progress.
Stops a key phrases detection job in progress.
Stops a sentiment detection job in progress.
Stops a targeted sentiment detection job in progress.
Stops a document classifier training job while in progress.
Stops an entity recognizer training job while in progress.
Associates a specific tag with an Amazon Comprehend resource.
Updates information about the specified endpoint.
Link to this section Functions
Determines the dominant language of the input text for a batch of documents.
For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.Inspects the text of a batch of documents for named entities and returns information about them.
For more information about named entities, see Entities in the Comprehend Developer Guide.POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
, in each one.
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them.
For more information, see Syntax in the Comprehend Developer Guide.Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors
that describes the errors.
InvalidRequestException
error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
Creates a new document classifier that you can use to categorize documents.
To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.Creates an entity recognizer using submitted files.
After yourCreateEntityRecognizer
request is submitted, you can check job status using the API.
Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
If an active inference job is using the model, a ResourceInUseException
will be returned.
Deletes a model-specific endpoint for a previously-trained custom model.
All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException
will be returned.
Gets the properties associated with a document classification job.
Use this operation to get the status of a classification job.Gets the properties associated with a dominant language detection job.
Use this operation to get the status of a detection job.Gets the properties associated with a specific endpoint.
Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.Gets the properties associated with an entities detection job.
Use this operation to get the status of a detection job.Gets the properties associated with a key phrases detection job.
Use this operation to get the status of a detection job.Gets the properties associated with a PII entities detection job.
For example, you can use this operation to get the job status.Gets the properties associated with a sentiment detection job.
Use this operation to get the status of a detection job.Gets the properties associated with a targeted sentiment detection job.
Use this operation to get the status of the job.Gets the properties associated with a topic detection job.
Use this operation to get the status of a detection job.Determines the dominant language of the input text.
For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.Detects named entities in input text when you use the pre-trained model.
Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors
for each error.
InvalidRequestException
error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
).
Inspects text for syntax and the part of speech of words in the document.
For more information, see Syntax in the Comprehend Developer Guide.Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.Creates a new custom model that replicates a source custom model that you import.
The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.Gets a list of all existing endpoints that you've created.
For information about endpoints, see Managing endpoints.Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training.
Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.Attaches a resource-based policy to a custom model.
You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.Starts an asynchronous document classification job.
Use the operation to track the progress of the job.Starts an asynchronous dominant language detection job for a collection of documents.
Use the operation to track the status of a job.Starts an asynchronous entity detection job for a collection of documents.
Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optionalEntityRecognizerArn
must be used in order to provide access to the recognizer being used to detect the custom entity.
Starts an asynchronous key phrase detection job for a collection of documents.
Use the operation to track the status of a job.Starts an asynchronous sentiment detection job for a collection of documents.
Use the operation to track the status of a job.Starts an asynchronous targeted sentiment detection job for a collection of documents.
Use the operation to track the status of a job.Starts an asynchronous topic detection job.
Use theDescribeTopicDetectionJob
operation to track the status of a job.
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
Stops an entities detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS
, the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is be stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
Stops a targeted sentiment detection job in progress.
If the job state is IN_PROGRESS
, the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is be stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
Stops a document classifier training job while in progress.
If the training job state isTRAINING
, the job is marked for termination and put into the STOP_REQUESTED
state. If the training job completes before it can be stopped, it is put into the TRAINED
; otherwise the training job is stopped and put into the STOPPED
state and the service sends back an HTTP 200 response with an empty HTTP body.
Stops an entity recognizer training job while in progress.
If the training job state isTRAINING
, the job is marked for termination and put into the STOP_REQUESTED
state. If the training job completes before it can be stopped, it is put into the TRAINED
; otherwise the training job is stopped and putted into the STOPPED
state and the service sends back an HTTP 200 response with an empty HTTP body.
Associates a specific tag with an Amazon Comprehend resource.
A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.Updates information about the specified endpoint.
For information about endpoints, see Managing endpoints.