ExtractiveSummaryResult Class
ExtractiveSummaryResult is a result object which contains the extractive text summarization from a particular document.
- Inheritance
-
azure.ai.textanalytics._dict_mixin.DictMixinExtractiveSummaryResult
Constructor
ExtractiveSummaryResult(**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.
id: str
is_error
Boolean check for error item when iterating over list of results. Always False for an instance of an ExtractiveSummaryResult.
is_error: Literal[False] = False
kind
The text analysis kind - "ExtractiveSummarization".
kind: Literal['ExtractiveSummarization'] = 'ExtractiveSummarization'
sentences
A ranked list of sentences representing the extracted summary.
sentences: List[SummarySentence]
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.
warnings: List[TextAnalyticsWarning]
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for