DetectKeyPhrasesCommand

Suggest an Edit

Detects the key noun phrases found in the text.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, DetectKeyPhrasesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, DetectKeyPhrasesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // DetectKeyPhrasesRequest
  Text: "STRING_VALUE", // required
  LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
};
const command = new DetectKeyPhrasesCommand(input);
const response = await client.send(command);
// { // DetectKeyPhrasesResponse
//   KeyPhrases: [ // ListOfKeyPhrases
//     { // KeyPhrase
//       Score: Number("float"),
//       Text: "STRING_VALUE",
//       BeginOffset: Number("int"),
//       EndOffset: Number("int"),
//     },
//   ],
// };

DetectKeyPhrasesCommand Input

See DetectKeyPhrasesCommandInput for more details

Parameter
Type
Description
LanguageCode
Required
LanguageCode | undefined

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Text
Required
string | undefined

A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

DetectKeyPhrasesCommand Output

See DetectKeyPhrasesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
KeyPhrases
KeyPhrase[] | undefined

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

TextSizeLimitExceededException
client

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException
client

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages  in the Comprehend Developer Guide.

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.