ExtractKeyPhrasesResult Class

ExtractKeyPhrasesResult is a result object which contains the key phrases found in a particular document.

Inheritance

azure.ai.textanalytics._models.DictMixin

ExtractKeyPhrasesResult

Constructor

ExtractKeyPhrasesResult(**kwargs)

Variables

id

str

Unique, non-empty document identifier that matches the document id that was passed in with the request. If not specified in the request, an id is assigned for the document.

key_phrases

list[str]

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

warnings

list[TextAnalyticsWarning]

Warnings encountered while processing document. Results will still be returned if there are warnings, but they may not be fully accurate.

statistics

TextDocumentStatistics

If show_stats=True was specified in the request this field will contain information about the document payload.

is_error

bool

Boolean check for error item when iterating over list of results. Always False for an instance of a ExtractKeyPhrasesResult.