Share via

ExtractKeyPhrasesResult Class

  • Reference

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

Inheritance
azure.ai.textanalytics._dict_mixin.DictMixin
ExtractKeyPhrasesResult

Constructor

ExtractKeyPhrasesResult(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k: str) -> bool

Parameters

Name Description
k
Required

items 

items() -> Iterable[Tuple[str, Any]]

keys 

keys() -> Iterable[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> Iterable[Any]

Attributes

id

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.

id: str

is_error

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

is_error: Literal[False] = False

key_phrases

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

key_phrases: List[str]

kind

The text analysis kind - "KeyPhraseExtraction".

kind: Literal['KeyPhraseExtraction'] = 'KeyPhraseExtraction'

statistics

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

statistics: TextDocumentStatistics | None = None

warnings

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

warnings: List[TextAnalyticsWarning]