amazonaws.com – comprehend

OpenAPI apis-guru cloud

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.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:comprehend/2017-11-27.json
Provider: amazonaws.com:comprehend / comprehend
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/comprehend/2017-11-27/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/comprehend/2017-11-27/openapi.yaml

Tools (86)

Extracted live via the executor SDK.

xAmzTargetComprehend20171127BatchDetectDominantLanguage.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 .
xAmzTargetComprehend20171127BatchDetectEntities.batchDetectEntities

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see in the Comprehend Developer Guide.
xAmzTargetComprehend20171127BatchDetectKeyPhrases.batchDetectKeyPhrases

Detects the key noun phrases found in a batch of documents.
xAmzTargetComprehend20171127BatchDetectSentiment.batchDetectSentiment

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
xAmzTargetComprehend20171127BatchDetectSyntax.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 in the Comprehend Developer Guide.
xAmzTargetComprehend20171127BatchDetectTargetedSentiment.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 .
xAmzTargetComprehend20171127ClassifyDocument.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 in the Comprehend Developer Guide.
xAmzTargetComprehend20171127ContainsPiiEntities.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.
xAmzTargetComprehend20171127CreateDataset.createDataset

Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127CreateDocumentClassifier.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 in the Comprehend Developer Guide.
xAmzTargetComprehend20171127CreateEndpoint.createEndpoint

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see .
xAmzTargetComprehend20171127CreateEntityRecognizer.createEntityRecognizer

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
xAmzTargetComprehend20171127CreateFlywheel.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 in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127DeleteDocumentClassifier.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.
xAmzTargetComprehend20171127DeleteEndpoint.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 .
xAmzTargetComprehend20171127DeleteEntityRecognizer.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.
xAmzTargetComprehend20171127DeleteFlywheel.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 in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127DeleteResourcePolicy.deleteResourcePolicy

Deletes a resource-based policy that is attached to a custom model.
xAmzTargetComprehend20171127DescribeDataset.describeDataset

Returns information about the dataset that you specify. For more information about datasets, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127DescribeDocumentClassificationJob.describeDocumentClassificationJob

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
xAmzTargetComprehend20171127DescribeDocumentClassifier.describeDocumentClassifier

Gets the properties associated with a document classifier.
xAmzTargetComprehend20171127DescribeDominantLanguageDetectionJob.describeDominantLanguageDetectionJob

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
xAmzTargetComprehend20171127DescribeEndpoint.describeEndpoint

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see .
xAmzTargetComprehend20171127DescribeEntitiesDetectionJob.describeEntitiesDetectionJob

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
xAmzTargetComprehend20171127DescribeEntityRecognizer.describeEntityRecognizer

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
xAmzTargetComprehend20171127DescribeEventsDetectionJob.describeEventsDetectionJob

Gets the status and details of an events detection job.
xAmzTargetComprehend20171127DescribeFlywheel.describeFlywheel

Provides configuration information about the flywheel. For more information about flywheels, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127DescribeFlywheelIteration.describeFlywheelIteration

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127DescribeKeyPhrasesDetectionJob.describeKeyPhrasesDetectionJob

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
xAmzTargetComprehend20171127DescribePiiEntitiesDetectionJob.describePiiEntitiesDetectionJob

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
xAmzTargetComprehend20171127DescribeResourcePolicy.describeResourcePolicy

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
xAmzTargetComprehend20171127DescribeSentimentDetectionJob.describeSentimentDetectionJob

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
xAmzTargetComprehend20171127DescribeTargetedSentimentDetectionJob.describeTargetedSentimentDetectionJob

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
xAmzTargetComprehend20171127DescribeTopicsDetectionJob.describeTopicsDetectionJob

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
xAmzTargetComprehend20171127DetectDominantLanguage.detectDominantLanguage

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see .
xAmzTargetComprehend20171127DetectEntities.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 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 in the Comprehend Developer Guide.
xAmzTargetComprehend20171127DetectKeyPhrases.detectKeyPhrases

Detects the key noun phrases found in the text.
xAmzTargetComprehend20171127DetectPiiEntities.detectPiiEntities

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
xAmzTargetComprehend20171127DetectSentiment.detectSentiment

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
xAmzTargetComprehend20171127DetectSyntax.detectSyntax

Inspects text for syntax and the part of speech of words in the document. For more information, see in the Comprehend Developer Guide.
xAmzTargetComprehend20171127DetectTargetedSentiment.detectTargetedSentiment

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

For more information about targeted sentiment, see .
xAmzTargetComprehend20171127ImportModel.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.
xAmzTargetComprehend20171127ListDatasets.listDatasets

List the datasets that you have configured in this Region. For more information about datasets, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127ListDocumentClassificationJobs.listDocumentClassificationJobs

Gets a list of the documentation classification jobs that you have submitted.
xAmzTargetComprehend20171127ListDocumentClassifiers.listDocumentClassifiers

Gets a list of the document classifiers that you have created.
xAmzTargetComprehend20171127ListDocumentClassifierSummaries.listDocumentClassifierSummaries

Gets a list of summaries of the document classifiers that you have created
xAmzTargetComprehend20171127ListDominantLanguageDetectionJobs.listDominantLanguageDetectionJobs

Gets a list of the dominant language detection jobs that you have submitted.
xAmzTargetComprehend20171127ListEndpoints.listEndpoints

Gets a list of all existing endpoints that you've created. For information about endpoints, see .
xAmzTargetComprehend20171127ListEntitiesDetectionJobs.listEntitiesDetectionJobs

Gets a list of the entity detection jobs that you have submitted.
xAmzTargetComprehend20171127ListEntityRecognizers.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.
xAmzTargetComprehend20171127ListEntityRecognizerSummaries.listEntityRecognizerSummaries

Gets a list of summaries for the entity recognizers that you have created.
xAmzTargetComprehend20171127ListEventsDetectionJobs.listEventsDetectionJobs

Gets a list of the events detection jobs that you have submitted.
xAmzTargetComprehend20171127ListFlywheelIterationHistory.listFlywheelIterationHistory

Information about the history of a flywheel iteration. For more information about flywheels, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127ListFlywheels.listFlywheels

Gets a list of the flywheels that you have created.
xAmzTargetComprehend20171127ListKeyPhrasesDetectionJobs.listKeyPhrasesDetectionJobs

Get a list of key phrase detection jobs that you have submitted.
xAmzTargetComprehend20171127ListPiiEntitiesDetectionJobs.listPiiEntitiesDetectionJobs

Gets a list of the PII entity detection jobs that you have submitted.
xAmzTargetComprehend20171127ListSentimentDetectionJobs.listSentimentDetectionJobs

Gets a list of sentiment detection jobs that you have submitted.
xAmzTargetComprehend20171127ListTagsForResource.listTagsForResource

Lists all tags associated with a given Amazon Comprehend resource.
xAmzTargetComprehend20171127ListTargetedSentimentDetectionJobs.listTargetedSentimentDetectionJobs

Gets a list of targeted sentiment detection jobs that you have submitted.
xAmzTargetComprehend20171127ListTopicsDetectionJobs.listTopicsDetectionJobs

Gets a list of the topic detection jobs that you have submitted.
xAmzTargetComprehend20171127PutResourcePolicy.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.
xAmzTargetComprehend20171127StartDocumentClassificationJob.startDocumentClassificationJob

Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
xAmzTargetComprehend20171127StartDominantLanguageDetectionJob.startDominantLanguageDetectionJob

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
xAmzTargetComprehend20171127StartEntitiesDetectionJob.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.
xAmzTargetComprehend20171127StartEventsDetectionJob.startEventsDetectionJob

Starts an asynchronous event detection job for a collection of documents.
xAmzTargetComprehend20171127StartFlywheelIteration.startFlywheelIteration

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see in the Amazon Comprehend Developer Guide.
xAmzTargetComprehend20171127StartKeyPhrasesDetectionJob.startKeyPhrasesDetectionJob

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
xAmzTargetComprehend20171127StartPiiEntitiesDetectionJob.startPiiEntitiesDetectionJob

Starts an asynchronous PII entity detection job for a collection of documents.
xAmzTargetComprehend20171127StartSentimentDetectionJob.startSentimentDetectionJob

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
xAmzTargetComprehend20171127StartTargetedSentimentDetectionJob.startTargetedSentimentDetectionJob

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
xAmzTargetComprehend20171127StartTopicsDetectionJob.startTopicsDetectionJob

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
xAmzTargetComprehend20171127StopDominantLanguageDetectionJob.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.
xAmzTargetComprehend20171127StopEntitiesDetectionJob.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.
xAmzTargetComprehend20171127StopEventsDetectionJob.stopEventsDetectionJob

Stops an events detection job in progress.
xAmzTargetComprehend20171127StopKeyPhrasesDetectionJob.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.
xAmzTargetComprehend20171127StopPiiEntitiesDetectionJob.stopPiiEntitiesDetectionJob

Stops a PII entities detection job in progress.
xAmzTargetComprehend20171127StopSentimentDetectionJob.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.
xAmzTargetComprehend20171127StopTargetedSentimentDetectionJob.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.
xAmzTargetComprehend20171127StopTrainingDocumentClassifier.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.
xAmzTargetComprehend20171127StopTrainingEntityRecognizer.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.
xAmzTargetComprehend20171127TagResource.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.
xAmzTargetComprehend20171127UntagResource.untagResource

Removes a specific tag associated with an Amazon Comprehend resource.
xAmzTargetComprehend20171127UpdateEndpoint.updateEndpoint

Updates information about the specified endpoint. For information about endpoints, see .
xAmzTargetComprehend20171127UpdateFlywheel.updateFlywheel

Update the configuration information for an existing flywheel.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools