Amazon Comprehend
Amazon Comprehend is an Amazon Web Services 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.
Latency
Not monitored yet
Uptime
Not monitored yet
Playground
Verified
live
Endpoints
/#X-Amz-Target=Comprehend_20171127.CreateEntityRecognizer
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
/#X-Amz-Target=Comprehend_20171127.BatchDetectDominantLanguage
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 .
/#X-Amz-Target=Comprehend_20171127.BatchDetectEntities
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.
/#X-Amz-Target=Comprehend_20171127.BatchDetectKeyPhrases
Detects the key noun phrases found in a batch of documents.
/#X-Amz-Target=Comprehend_20171127.BatchDetectSentiment
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE , NEUTRAL , MIXED , or NEGATIVE , in each one.
/#X-Amz-Target=Comprehend_20171127.BatchDetectSyntax
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.
/#X-Amz-Target=Comprehend_20171127.BatchDetectTargetedSentiment
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 .
/#X-Amz-Target=Comprehend_20171127.ClassifyDocument
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. If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
/#X-Amz-Target=Comprehend_20171127.ContainsPiiEntities
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
/#X-Amz-Target=Comprehend_20171127.CreateDataset
Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.CreateDocumentClassifier
Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.
/#X-Amz-Target=Comprehend_20171127.CreateEndpoint
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints .
/#X-Amz-Target=Comprehend_20171127.CreateFlywheel
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.DeleteDocumentClassifier
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. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
/#X-Amz-Target=Comprehend_20171127.DeleteEndpoint
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 .
/#X-Amz-Target=Comprehend_20171127.DeleteEntityRecognizer
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. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
/#X-Amz-Target=Comprehend_20171127.DeleteFlywheel
Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.DeleteResourcePolicy
Deletes a resource-based policy that is attached to a custom model.
/#X-Amz-Target=Comprehend_20171127.DescribeDataset
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassificationJob
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
/#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassifier
Gets the properties associated with a document classifier.
/#X-Amz-Target=Comprehend_20171127.DescribeDominantLanguageDetectionJob
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
/#X-Amz-Target=Comprehend_20171127.DescribeEndpoint
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 .
/#X-Amz-Target=Comprehend_20171127.DescribeEntitiesDetectionJob
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
/#X-Amz-Target=Comprehend_20171127.DescribeEntityRecognizer
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
/#X-Amz-Target=Comprehend_20171127.DescribeEventsDetectionJob
Gets the status and details of an events detection job.
/#X-Amz-Target=Comprehend_20171127.DescribeFlywheel
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.DescribeFlywheelIteration
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.DescribeKeyPhrasesDetectionJob
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
/#X-Amz-Target=Comprehend_20171127.DescribePiiEntitiesDetectionJob
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
/#X-Amz-Target=Comprehend_20171127.DescribeResourcePolicy
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
/#X-Amz-Target=Comprehend_20171127.DescribeSentimentDetectionJob
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
/#X-Amz-Target=Comprehend_20171127.DescribeTargetedSentimentDetectionJob
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
/#X-Amz-Target=Comprehend_20171127.DescribeTopicsDetectionJob
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
/#X-Amz-Target=Comprehend_20171127.DetectDominantLanguage
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages .
/#X-Amz-Target=Comprehend_20171127.DetectEntities
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. If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
/#X-Amz-Target=Comprehend_20171127.DetectKeyPhrases
Detects the key noun phrases found in the text.
/#X-Amz-Target=Comprehend_20171127.DetectPiiEntities
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
/#X-Amz-Target=Comprehend_20171127.DetectSentiment
Inspects text and returns an inference of the prevailing sentiment ( POSITIVE , NEUTRAL , MIXED , or NEGATIVE ).
/#X-Amz-Target=Comprehend_20171127.DetectSyntax
Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
/#X-Amz-Target=Comprehend_20171127.DetectTargetedSentiment
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 .
/#X-Amz-Target=Comprehend_20171127.ImportModel
Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.
/#X-Amz-Target=Comprehend_20171127.ListPiiEntitiesDetectionJobs
Gets a list of the PII entity detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListDatasets
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.ListDocumentClassificationJobs
Gets a list of the documentation classification jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListDocumentClassifierSummaries
Gets a list of summaries of the document classifiers that you have created
/#X-Amz-Target=Comprehend_20171127.ListDocumentClassifiers
Gets a list of the document classifiers that you have created.
/#X-Amz-Target=Comprehend_20171127.ListDominantLanguageDetectionJobs
Gets a list of the dominant language detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListEndpoints
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints .
/#X-Amz-Target=Comprehend_20171127.ListEntitiesDetectionJobs
Gets a list of the entity detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListEntityRecognizerSummaries
Gets a list of summaries for the entity recognizers that you have created.
/#X-Amz-Target=Comprehend_20171127.ListEntityRecognizers
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.
/#X-Amz-Target=Comprehend_20171127.ListEventsDetectionJobs
Gets a list of the events detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListFlywheelIterationHistory
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.ListFlywheels
Gets a list of the flywheels that you have created.
/#X-Amz-Target=Comprehend_20171127.ListKeyPhrasesDetectionJobs
Get a list of key phrase detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListSentimentDetectionJobs
Gets a list of sentiment detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListTagsForResource
Lists all tags associated with a given Amazon Comprehend resource.
/#X-Amz-Target=Comprehend_20171127.ListTargetedSentimentDetectionJobs
Gets a list of targeted sentiment detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.ListTopicsDetectionJobs
Gets a list of the topic detection jobs that you have submitted.
/#X-Amz-Target=Comprehend_20171127.PutResourcePolicy
Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.
/#X-Amz-Target=Comprehend_20171127.StartDocumentClassificationJob
Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
/#X-Amz-Target=Comprehend_20171127.StartDominantLanguageDetectionJob
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
/#X-Amz-Target=Comprehend_20171127.StartEntitiesDetectionJob
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 optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
/#X-Amz-Target=Comprehend_20171127.StartEventsDetectionJob
Starts an asynchronous event detection job for a collection of documents.
/#X-Amz-Target=Comprehend_20171127.StartFlywheelIteration
Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .
/#X-Amz-Target=Comprehend_20171127.StartKeyPhrasesDetectionJob
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
/#X-Amz-Target=Comprehend_20171127.StartPiiEntitiesDetectionJob
Starts an asynchronous PII entity detection job for a collection of documents.
/#X-Amz-Target=Comprehend_20171127.StartSentimentDetectionJob
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
/#X-Amz-Target=Comprehend_20171127.StartTargetedSentimentDetectionJob
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
/#X-Amz-Target=Comprehend_20171127.StartTopicsDetectionJob
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
/#X-Amz-Target=Comprehend_20171127.StopDominantLanguageDetectionJob
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. When a job is stopped, any documents already processed are written to the output location.
/#X-Amz-Target=Comprehend_20171127.StopEntitiesDetectionJob
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. When a job is stopped, any documents already processed are written to the output location.
/#X-Amz-Target=Comprehend_20171127.StopEventsDetectionJob
Stops an events detection job in progress.
/#X-Amz-Target=Comprehend_20171127.StopKeyPhrasesDetectionJob
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. When a job is stopped, any documents already processed are written to the output location.
/#X-Amz-Target=Comprehend_20171127.StopPiiEntitiesDetectionJob
Stops a PII entities detection job in progress.
/#X-Amz-Target=Comprehend_20171127.StopSentimentDetectionJob
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. When a job is stopped, any documents already processed are written to the output location.
/#X-Amz-Target=Comprehend_20171127.StopTargetedSentimentDetectionJob
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. When a job is stopped, any documents already processed are written to the output location.
/#X-Amz-Target=Comprehend_20171127.StopTrainingDocumentClassifier
Stops a document classifier training job while in progress. If the training job state is TRAINING , 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.
/#X-Amz-Target=Comprehend_20171127.StopTrainingEntityRecognizer
Stops an entity recognizer training job while in progress. If the training job state is TRAINING , 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.
/#X-Amz-Target=Comprehend_20171127.TagResource
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.
/#X-Amz-Target=Comprehend_20171127.UntagResource
Removes a specific tag associated with an Amazon Comprehend resource.
/#X-Amz-Target=Comprehend_20171127.UpdateEndpoint
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints .
/#X-Amz-Target=Comprehend_20171127.UpdateFlywheel
Update the configuration information for an existing flywheel.
84 endpoints auto-detected
Authentication
This API uses an API key, passed in the "Authorization" header. No OAuth required.
curl -X POST \ "https://github.com/mermade/aws2openapi/#X-Amz-Target=Comprehend_20171127.CreateEntityRecognizer" \ -H "Authorization: YOUR_API_KEY"
github.com · HTTPS only
