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…
AI & machine learning#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 85
- POSTBatch detect dominant language
/#X-Amz-Target=Comprehend_20171127.BatchDetectDominantLanguageDetermines 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… - POSTBatch detect entities
/#X-Amz-Target=Comprehend_20171127.BatchDetectEntitiesInspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in… - POSTBatch detect key phrases
/#X-Amz-Target=Comprehend_20171127.BatchDetectKeyPhrasesDetects the key noun phrases found in a batch of documents. - POSTBatch detect sentiment
/#X-Amz-Target=Comprehend_20171127.BatchDetectSentimentInspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE , NEUTRAL , MIXED , or NEGATIVE , in each one. - POSTBatch detect syntax
/#X-Amz-Target=Comprehend_20171127.BatchDetectSyntaxInspects 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… - POSTBatch detect targeted sentiment
/#X-Amz-Target=Comprehend_20171127.BatchDetectTargetedSentimentInspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. For more information about targeted sentiment, see… - POSTClassify document
/#X-Amz-Target=Comprehend_20171127.ClassifyDocumentCreates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types: Custom classifier - a custom… - POSTContains pii entities
/#X-Amz-Target=Comprehend_20171127.ContainsPiiEntitiesAnalyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address,… - POSTCreate dataset
/#X-Amz-Target=Comprehend_20171127.CreateDatasetCreates 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… - POSTCreate document classifier
/#X-Amz-Target=Comprehend_20171127.CreateDocumentClassifierCreates 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… - POSTCreate endpoint
/#X-Amz-Target=Comprehend_20171127.CreateEndpointCreates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints . - POSTCreate entity recognizer
/#X-Amz-Target=Comprehend_20171127.CreateEntityRecognizerCreates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the… - POSTCreate flywheel
/#X-Amz-Target=Comprehend_20171127.CreateFlywheelA flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You… - POSTDelete document classifier
/#X-Amz-Target=Comprehend_20171127.DeleteDocumentClassifierDeletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active… - POSTDelete endpoint
/#X-Amz-Target=Comprehend_20171127.DeleteEndpointDeletes 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… - POSTDelete entity recognizer
/#X-Amz-Target=Comprehend_20171127.DeleteEntityRecognizerDeletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using… - POSTDelete flywheel
/#X-Amz-Target=Comprehend_20171127.DeleteFlywheelDeletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more… - POSTDelete resource policy
/#X-Amz-Target=Comprehend_20171127.DeleteResourcePolicyDeletes a resource-based policy that is attached to a custom model. - POSTDescribe dataset
/#X-Amz-Target=Comprehend_20171127.DescribeDatasetReturns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide . - POSTDescribe document classification job
/#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassificationJobGets the properties associated with a document classification job. Use this operation to get the status of a classification job. - POSTDescribe document classifier
/#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassifierGets the properties associated with a document classifier. - POSTDescribe dominant language detection job
/#X-Amz-Target=Comprehend_20171127.DescribeDominantLanguageDetectionJobGets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. - POSTDescribe endpoint
/#X-Amz-Target=Comprehend_20171127.DescribeEndpointGets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing… - POSTDescribe entities detection job
/#X-Amz-Target=Comprehend_20171127.DescribeEntitiesDetectionJobGets the properties associated with an entities detection job. Use this operation to get the status of a detection job. - POSTDescribe entity recognizer
/#X-Amz-Target=Comprehend_20171127.DescribeEntityRecognizerProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. - POSTDescribe events detection job
/#X-Amz-Target=Comprehend_20171127.DescribeEventsDetectionJobGets the status and details of an events detection job. - POSTDescribe flywheel
/#X-Amz-Target=Comprehend_20171127.DescribeFlywheelProvides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide . - POSTDescribe flywheel iteration
/#X-Amz-Target=Comprehend_20171127.DescribeFlywheelIterationRetrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer… - POSTDescribe key phrases detection job
/#X-Amz-Target=Comprehend_20171127.DescribeKeyPhrasesDetectionJobGets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. - POSTDescribe pii entities detection job
/#X-Amz-Target=Comprehend_20171127.DescribePiiEntitiesDetectionJobGets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status. - POSTDescribe resource policy
/#X-Amz-Target=Comprehend_20171127.DescribeResourcePolicyGets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy. - POSTDescribe sentiment detection job
/#X-Amz-Target=Comprehend_20171127.DescribeSentimentDetectionJobGets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. - POSTDescribe targeted sentiment detection job
/#X-Amz-Target=Comprehend_20171127.DescribeTargetedSentimentDetectionJobGets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job. - POSTDescribe topics detection job
/#X-Amz-Target=Comprehend_20171127.DescribeTopicsDetectionJobGets the properties associated with a topic detection job. Use this operation to get the status of a detection job. - POSTDetect dominant language
/#X-Amz-Target=Comprehend_20171127.DetectDominantLanguageDetermines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages . - POSTDetect entities
/#X-Amz-Target=Comprehend_20171127.DetectEntitiesDetects 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… - POSTDetect key phrases
/#X-Amz-Target=Comprehend_20171127.DetectKeyPhrasesDetects the key noun phrases found in the text. - POSTDetect pii entities
/#X-Amz-Target=Comprehend_20171127.DetectPiiEntitiesInspects the input text for entities that contain personally identifiable information (PII) and returns information about them. - POSTDetect sentiment
/#X-Amz-Target=Comprehend_20171127.DetectSentimentInspects text and returns an inference of the prevailing sentiment ( POSITIVE , NEUTRAL , MIXED , or NEGATIVE ). - POSTDetect syntax
/#X-Amz-Target=Comprehend_20171127.DetectSyntaxInspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide. - POSTDetect targeted sentiment
/#X-Amz-Target=Comprehend_20171127.DetectTargetedSentimentInspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted… - POSTDetect toxic content
/#X-Amz-Target=Comprehend_20171127.DetectToxicContentPerforms toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input… - POSTImport model
/#X-Amz-Target=Comprehend_20171127.ImportModelCreates 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.… - POSTList datasets
/#X-Amz-Target=Comprehend_20171127.ListDatasetsList the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide . - POSTList document classification jobs
/#X-Amz-Target=Comprehend_20171127.ListDocumentClassificationJobsGets a list of the documentation classification jobs that you have submitted. - POSTList document classifier summaries
/#X-Amz-Target=Comprehend_20171127.ListDocumentClassifierSummariesGets a list of summaries of the document classifiers that you have created - POSTList document classifiers
/#X-Amz-Target=Comprehend_20171127.ListDocumentClassifiersGets a list of the document classifiers that you have created. - POSTList dominant language detection jobs
/#X-Amz-Target=Comprehend_20171127.ListDominantLanguageDetectionJobsGets a list of the dominant language detection jobs that you have submitted. - POSTList endpoints
/#X-Amz-Target=Comprehend_20171127.ListEndpointsGets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints . - POSTList entities detection jobs
/#X-Amz-Target=Comprehend_20171127.ListEntitiesDetectionJobsGets a list of the entity detection jobs that you have submitted. - POSTList entity recognizer summaries
/#X-Amz-Target=Comprehend_20171127.ListEntityRecognizerSummariesGets a list of summaries for the entity recognizers that you have created. - POSTList entity recognizers
/#X-Amz-Target=Comprehend_20171127.ListEntityRecognizersGets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of… - POSTList events detection jobs
/#X-Amz-Target=Comprehend_20171127.ListEventsDetectionJobsGets a list of the events detection jobs that you have submitted. - POSTList flywheel iteration history
/#X-Amz-Target=Comprehend_20171127.ListFlywheelIterationHistoryInformation about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide . - POSTList flywheels
/#X-Amz-Target=Comprehend_20171127.ListFlywheelsGets a list of the flywheels that you have created. - POSTList key phrases detection jobs
/#X-Amz-Target=Comprehend_20171127.ListKeyPhrasesDetectionJobsGet a list of key phrase detection jobs that you have submitted. - POSTList pii entities detection jobs
/#X-Amz-Target=Comprehend_20171127.ListPiiEntitiesDetectionJobsGets a list of the PII entity detection jobs that you have submitted. - POSTList sentiment detection jobs
/#X-Amz-Target=Comprehend_20171127.ListSentimentDetectionJobsGets a list of sentiment detection jobs that you have submitted. - POSTList tags for resource
/#X-Amz-Target=Comprehend_20171127.ListTagsForResourceLists all tags associated with a given Amazon Comprehend resource. - POSTList targeted sentiment detection jobs
/#X-Amz-Target=Comprehend_20171127.ListTargetedSentimentDetectionJobsGets a list of targeted sentiment detection jobs that you have submitted. - POSTList topics detection jobs
/#X-Amz-Target=Comprehend_20171127.ListTopicsDetectionJobsGets a list of the topic detection jobs that you have submitted. - POSTPut resource policy
/#X-Amz-Target=Comprehend_20171127.PutResourcePolicyAttaches 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… - POSTStart document classification job
/#X-Amz-Target=Comprehend_20171127.StartDocumentClassificationJobStarts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the… - POSTStart dominant language detection job
/#X-Amz-Target=Comprehend_20171127.StartDominantLanguageDetectionJobStarts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. - POSTStart entities detection job
/#X-Amz-Target=Comprehend_20171127.StartEntitiesDetectionJobStarts 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… - POSTStart events detection job
/#X-Amz-Target=Comprehend_20171127.StartEventsDetectionJobStarts an asynchronous event detection job for a collection of documents. - POSTStart flywheel iteration
/#X-Amz-Target=Comprehend_20171127.StartFlywheelIterationStart the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in… - POSTStart key phrases detection job
/#X-Amz-Target=Comprehend_20171127.StartKeyPhrasesDetectionJobStarts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. - POSTStart pii entities detection job
/#X-Amz-Target=Comprehend_20171127.StartPiiEntitiesDetectionJobStarts an asynchronous PII entity detection job for a collection of documents. - POSTStart sentiment detection job
/#X-Amz-Target=Comprehend_20171127.StartSentimentDetectionJobStarts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job. - POSTStart targeted sentiment detection job
/#X-Amz-Target=Comprehend_20171127.StartTargetedSentimentDetectionJobStarts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the… - POSTStart topics detection job
/#X-Amz-Target=Comprehend_20171127.StartTopicsDetectionJobStarts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job. - POSTStop dominant language detection job
/#X-Amz-Target=Comprehend_20171127.StopDominantLanguageDetectionJobStops 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.… - POSTStop entities detection job
/#X-Amz-Target=Comprehend_20171127.StopEntitiesDetectionJobStops 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… - POSTStop events detection job
/#X-Amz-Target=Comprehend_20171127.StopEventsDetectionJobStops an events detection job in progress. - POSTStop key phrases detection job
/#X-Amz-Target=Comprehend_20171127.StopKeyPhrasesDetectionJobStops 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… - POSTStop pii entities detection job
/#X-Amz-Target=Comprehend_20171127.StopPiiEntitiesDetectionJobStops a PII entities detection job in progress. - POSTStop sentiment detection job
/#X-Amz-Target=Comprehend_20171127.StopSentimentDetectionJobStops 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… - POSTStop targeted sentiment detection job
/#X-Amz-Target=Comprehend_20171127.StopTargetedSentimentDetectionJobStops 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… - POSTStop training document classifier
/#X-Amz-Target=Comprehend_20171127.StopTrainingDocumentClassifierStops 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… - POSTStop training entity recognizer
/#X-Amz-Target=Comprehend_20171127.StopTrainingEntityRecognizerStops 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… - POSTTag resource
/#X-Amz-Target=Comprehend_20171127.TagResourceAssociates 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… - POSTUntag resource
/#X-Amz-Target=Comprehend_20171127.UntagResourceRemoves a specific tag associated with an Amazon Comprehend resource. - POSTUpdate endpoint
/#X-Amz-Target=Comprehend_20171127.UpdateEndpointUpdates information about the specified endpoint. For information about endpoints, see Managing endpoints . - POSTUpdate flywheel
/#X-Amz-Target=Comprehend_20171127.UpdateFlywheelUpdate the configuration information for an existing flywheel.
API details
- Base URL
https://comprehend.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 85 operations on 85 pathsPOST 85
- Description format
- AWS Smithy model, API version
2017-11-27 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Comprehend in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Comprehend collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch detect dominant language” (POST /#X-Amz-Target=Comprehend_20171127.BatchDetectDominantLanguage), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under AI & machine learning and has 85 endpoints.
Who publishes the Amazon Comprehend?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Comprehend?
Requests go to https://comprehend.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Comprehend?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Comprehend have?
85 operations on 85 paths (85 POST).
Is forking the Amazon Comprehend free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.