Package version:

Interface KeyPhraseExtractionSuccessResult

The result of a key phrase extraction action on a single document, containing a collection of the key phrases identified in that document.

Hierarchy

Properties

error?: undefined

Discriminant to determine if this is an error result.

id: string

Unique, non-empty document identifier.

keyPhrases: Object

A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.

Statistics about the input document and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.

warnings: Object

An array of warning data corresponding to this document.

If no warnings were returned, this array will be empty.

Generated using TypeDoc