@aws-sdk/client-comprehend
Advanced tools
AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native
@aws-sdk/client-comprehend is an AWS SDK for JavaScript package that allows developers to interact with Amazon Comprehend, a natural language processing (NLP) service. This package provides functionalities for text analysis, including language detection, sentiment analysis, entity recognition, key phrase extraction, and topic modeling.
Language Detection
This feature allows you to detect the dominant language in a given text. The code sample demonstrates how to use the DetectDominantLanguageCommand to identify the language of the input text.
const { ComprehendClient, DetectDominantLanguageCommand } = require('@aws-sdk/client-comprehend');
const client = new ComprehendClient({ region: 'us-east-1' });
const params = { Text: 'Hello, how are you?' };
const command = new DetectDominantLanguageCommand(params);
client.send(command).then(response => console.log(response)).catch(error => console.error(error));Sentiment Analysis
This feature allows you to analyze the sentiment of a given text, determining whether it is positive, negative, neutral, or mixed. The code sample shows how to use the DetectSentimentCommand to analyze the sentiment of the input text.
const { ComprehendClient, DetectSentimentCommand } = require('@aws-sdk/client-comprehend');
const client = new ComprehendClient({ region: 'us-east-1' });
const params = { Text: 'I am very happy today!', LanguageCode: 'en' };
const command = new DetectSentimentCommand(params);
client.send(command).then(response => console.log(response)).catch(error => console.error(error));Entity Recognition
This feature allows you to identify entities such as people, places, and organizations in a given text. The code sample demonstrates how to use the DetectEntitiesCommand to recognize entities in the input text.
const { ComprehendClient, DetectEntitiesCommand } = require('@aws-sdk/client-comprehend');
const client = new ComprehendClient({ region: 'us-east-1' });
const params = { Text: 'Amazon Web Services is a subsidiary of Amazon.', LanguageCode: 'en' };
const command = new DetectEntitiesCommand(params);
client.send(command).then(response => console.log(response)).catch(error => console.error(error));Key Phrase Extraction
This feature allows you to extract key phrases from a given text. The code sample shows how to use the DetectKeyPhrasesCommand to extract key phrases from the input text.
const { ComprehendClient, DetectKeyPhrasesCommand } = require('@aws-sdk/client-comprehend');
const client = new ComprehendClient({ region: 'us-east-1' });
const params = { Text: 'Machine learning is a fascinating field of study.', LanguageCode: 'en' };
const command = new DetectKeyPhrasesCommand(params);
client.send(command).then(response => console.log(response)).catch(error => console.error(error));Topic Modeling
This feature allows you to identify topics in a collection of documents. The code sample demonstrates how to use the StartTopicsDetectionJobCommand to start a topic detection job with input and output data stored in Amazon S3.
const { ComprehendClient, StartTopicsDetectionJobCommand } = require('@aws-sdk/client-comprehend');
const client = new ComprehendClient({ region: 'us-east-1' });
const params = { InputDataConfig: { S3Uri: 's3://your-bucket/input-data' }, OutputDataConfig: { S3Uri: 's3://your-bucket/output-data' }, DataAccessRoleArn: 'arn:aws:iam::your-account-id:role/your-role', NumberOfTopics: 10 };
const command = new StartTopicsDetectionJobCommand(params);
client.send(command).then(response => console.log(response)).catch(error => console.error(error));The 'natural' package is a general natural language processing (NLP) library for JavaScript. It provides functionalities such as tokenization, stemming, classification, and more. Unlike @aws-sdk/client-comprehend, which is a cloud-based service, 'natural' is a local library that does not require internet access or an AWS account.
The 'compromise' package is a lightweight NLP library for JavaScript. It offers features like part-of-speech tagging, named entity recognition, and text normalization. While it provides some similar functionalities to @aws-sdk/client-comprehend, it operates entirely on the client side and does not offer the same level of scalability or integration with other AWS services.
The 'wink-nlp' package is a fast and accurate NLP library for JavaScript. It includes features such as tokenization, named entity recognition, sentiment analysis, and more. Unlike @aws-sdk/client-comprehend, 'wink-nlp' is designed for local processing and does not require cloud infrastructure, making it suitable for applications where data privacy is a concern.
AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native.
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.
To install this package, simply type add or install @aws-sdk/client-comprehend using your favorite package manager:
npm install @aws-sdk/client-comprehendyarn add @aws-sdk/client-comprehendpnpm add @aws-sdk/client-comprehendThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ComprehendClient and
the commands you need, for example ListDatasetsCommand:
// ES5 example
const { ComprehendClient, ListDatasetsCommand } = require("@aws-sdk/client-comprehend");
// ES6+ example
import { ComprehendClient, ListDatasetsCommand } from "@aws-sdk/client-comprehend";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new ComprehendClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListDatasetsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-comprehend";
const client = new AWS.Comprehend({ region: "REGION" });
// async/await.
try {
const data = await client.listDatasets(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listDatasets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listDatasets(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-comprehend package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.709.0 (2024-12-10)
FAQs
AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native
We found that @aws-sdk/client-comprehend demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.