AbstractiveSummaryResult Class

  • Reference

AbstractiveSummaryResult is a result object which contains the summary generated for a particular document.

New in version 2023-04-01: The AbstractiveSummaryResult model.

Inheritance
azure.ai.textanalytics._dict_mixin.DictMixin
AbstractiveSummaryResult

Constructor

AbstractiveSummaryResult(**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. Required.

id: str

is_error

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

is_error: Literal[False] = False

kind

The text analysis kind - "AbstractiveSummarization".

kind: Literal['AbstractiveSummarization'] = 'AbstractiveSummarization'

statistics

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

statistics: TextDocumentStatistics | None = None

summaries

A list of abstractive summaries. Required.

summaries: List[AbstractiveSummary]

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]