Share via

ExtractKeyPhrasesSuccessResult interface

  • Reference
Package:
@azure/ai-text-analytics

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

Extends
TextAnalyticsSuccessResult

Properties

keyPhrases

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

Inherited Properties

error

Discriminant to determine if that this is an error result.
id

Unique, non-empty document identifier.
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.

Property Details

keyPhrases

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

keyPhrases: string[]

Property Value

string[]

Inherited Property Details

error

Discriminant to determine if that this is an error result.

error?: undefined

Property Value

undefined

Inherited From TextAnalyticsSuccessResult.error

id

Unique, non-empty document identifier.

id: string

Property Value

string

Inherited From TextAnalyticsSuccessResult.id

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.

statistics?: TextDocumentStatistics

Property Value

TextDocumentStatistics

Inherited From TextAnalyticsSuccessResult.statistics

warnings

An array of warning data corresponding to this document.

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

warnings: TextAnalyticsWarning[]

Property Value

TextAnalyticsWarning[]

Inherited From TextAnalyticsSuccessResult.warnings