@aws-sdk/client-comprehend
TypeScript icon, indicating that this package has built-in type declarations

3.577.0 • Public • Published

@aws-sdk/client-comprehend

Description

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.

Installing

To install the this package, simply type add or install @aws-sdk/client-comprehend using your favorite package manager:

  • npm install @aws-sdk/client-comprehend
  • yarn add @aws-sdk/client-comprehend
  • pnpm add @aws-sdk/client-comprehend

Getting Started

Import

The 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";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call 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);

Async/await

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.

Promises

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.
  });

Callbacks

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.
});

v2 compatible style

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.
});

Troubleshooting

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;
   * }
   */
}

Getting Help

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.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

BatchDetectDominantLanguage

Command API Reference / Input / Output

BatchDetectEntities

Command API Reference / Input / Output

BatchDetectKeyPhrases

Command API Reference / Input / Output

BatchDetectSentiment

Command API Reference / Input / Output

BatchDetectSyntax

Command API Reference / Input / Output

BatchDetectTargetedSentiment

Command API Reference / Input / Output

ClassifyDocument

Command API Reference / Input / Output

ContainsPiiEntities

Command API Reference / Input / Output

CreateDataset

Command API Reference / Input / Output

CreateDocumentClassifier

Command API Reference / Input / Output

CreateEndpoint

Command API Reference / Input / Output

CreateEntityRecognizer

Command API Reference / Input / Output

CreateFlywheel

Command API Reference / Input / Output

DeleteDocumentClassifier

Command API Reference / Input / Output

DeleteEndpoint

Command API Reference / Input / Output

DeleteEntityRecognizer

Command API Reference / Input / Output

DeleteFlywheel

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DescribeDataset

Command API Reference / Input / Output

DescribeDocumentClassificationJob

Command API Reference / Input / Output

DescribeDocumentClassifier

Command API Reference / Input / Output

DescribeDominantLanguageDetectionJob

Command API Reference / Input / Output

DescribeEndpoint

Command API Reference / Input / Output

DescribeEntitiesDetectionJob

Command API Reference / Input / Output

DescribeEntityRecognizer

Command API Reference / Input / Output

DescribeEventsDetectionJob

Command API Reference / Input / Output

DescribeFlywheel

Command API Reference / Input / Output

DescribeFlywheelIteration

Command API Reference / Input / Output

DescribeKeyPhrasesDetectionJob

Command API Reference / Input / Output

DescribePiiEntitiesDetectionJob

Command API Reference / Input / Output

DescribeResourcePolicy

Command API Reference / Input / Output

DescribeSentimentDetectionJob

Command API Reference / Input / Output

DescribeTargetedSentimentDetectionJob

Command API Reference / Input / Output

DescribeTopicsDetectionJob

Command API Reference / Input / Output

DetectDominantLanguage

Command API Reference / Input / Output

DetectEntities

Command API Reference / Input / Output

DetectKeyPhrases

Command API Reference / Input / Output

DetectPiiEntities

Command API Reference / Input / Output

DetectSentiment

Command API Reference / Input / Output

DetectSyntax

Command API Reference / Input / Output

DetectTargetedSentiment

Command API Reference / Input / Output

DetectToxicContent

Command API Reference / Input / Output

ImportModel

Command API Reference / Input / Output

ListDatasets

Command API Reference / Input / Output

ListDocumentClassificationJobs

Command API Reference / Input / Output

ListDocumentClassifiers

Command API Reference / Input / Output

ListDocumentClassifierSummaries

Command API Reference / Input / Output

ListDominantLanguageDetectionJobs

Command API Reference / Input / Output

ListEndpoints

Command API Reference / Input / Output

ListEntitiesDetectionJobs

Command API Reference / Input / Output

ListEntityRecognizers

Command API Reference / Input / Output

ListEntityRecognizerSummaries

Command API Reference / Input / Output

ListEventsDetectionJobs

Command API Reference / Input / Output

ListFlywheelIterationHistory

Command API Reference / Input / Output

ListFlywheels

Command API Reference / Input / Output

ListKeyPhrasesDetectionJobs

Command API Reference / Input / Output

ListPiiEntitiesDetectionJobs

Command API Reference / Input / Output

ListSentimentDetectionJobs

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTargetedSentimentDetectionJobs

Command API Reference / Input / Output

ListTopicsDetectionJobs

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

StartDocumentClassificationJob

Command API Reference / Input / Output

StartDominantLanguageDetectionJob

Command API Reference / Input / Output

StartEntitiesDetectionJob

Command API Reference / Input / Output

StartEventsDetectionJob

Command API Reference / Input / Output

StartFlywheelIteration

Command API Reference / Input / Output

StartKeyPhrasesDetectionJob

Command API Reference / Input / Output

StartPiiEntitiesDetectionJob

Command API Reference / Input / Output

StartSentimentDetectionJob

Command API Reference / Input / Output

StartTargetedSentimentDetectionJob

Command API Reference / Input / Output

StartTopicsDetectionJob

Command API Reference / Input / Output

StopDominantLanguageDetectionJob

Command API Reference / Input / Output

StopEntitiesDetectionJob

Command API Reference / Input / Output

StopEventsDetectionJob

Command API Reference / Input / Output

StopKeyPhrasesDetectionJob

Command API Reference / Input / Output

StopPiiEntitiesDetectionJob

Command API Reference / Input / Output

StopSentimentDetectionJob

Command API Reference / Input / Output

StopTargetedSentimentDetectionJob

Command API Reference / Input / Output

StopTrainingDocumentClassifier

Command API Reference / Input / Output

StopTrainingEntityRecognizer

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateEndpoint

Command API Reference / Input / Output

UpdateFlywheel

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-comprehend

Weekly Downloads

493,651

Version

3.577.0

License

Apache-2.0

Unpacked Size

1.84 MB

Total Files

383

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws