Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExtractKeyPhrasesSuccessResult

Package version

The result of the extract key phrases operation on a single document, containing a collection of the key phrases identified in that document.

Hierarchy

Index

Properties

Optional error

error: undefined

Discriminant to determine if that this is an error result.

id

id: string

Unique, non-empty document identifier.

keyPhrases

keyPhrases: string[]

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

Optional statistics

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

An array of warning data corresponding to this document.

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

Generated using TypeDoc