azure.ai.textanalytics.ExtractiveSummaryResult.yml

### YamlMime:PythonClass
uid: azure.ai.textanalytics.ExtractiveSummaryResult
name: ExtractiveSummaryResult
fullName: azure.ai.textanalytics.ExtractiveSummaryResult
module: azure.ai.textanalytics
inheritances:
- azure.ai.textanalytics._dict_mixin.DictMixin
summary: 'ExtractiveSummaryResult is a result object which contains

  the extractive text summarization from a particular document.'
constructor:
  syntax: 'ExtractiveSummaryResult(**kwargs: Any)'
methods:
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.get
  name: get
  signature: 'get(key: str, default: Any | None = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.has_key
  name: has_key
  signature: 'has_key(k: str) -> bool'
  parameters:
  - name: k
    isRequired: true
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.items
  name: items
  signature: items() -> Iterable[Tuple[str, Any]]
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.keys
  name: keys
  signature: keys() -> Iterable[str]
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.values
  name: values
  signature: values() -> Iterable[Any]
attributes:
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.id
  name: id
  summary: Unique, non-empty document identifier.
  signature: 'id: str'
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.is_error
  name: is_error
  summary: 'Boolean check for error item when iterating over list of

    results. Always False for an instance of an ExtractiveSummaryResult.'
  signature: 'is_error: Literal[False] = False'
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.kind
  name: kind
  summary: The text analysis kind - "ExtractiveSummarization".
  signature: 'kind: Literal[''ExtractiveSummarization''] = ''ExtractiveSummarization'''
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.sentences
  name: sentences
  summary: A ranked list of sentences representing the extracted summary.
  signature: 'sentences: List[SummarySentence]'
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.statistics
  name: statistics
  summary: 'If *show_stats=True* was specified in the request this

    field will contain information about the document payload.'
  signature: 'statistics: TextDocumentStatistics | None = None'
- uid: azure.ai.textanalytics.ExtractiveSummaryResult.warnings
  name: warnings
  summary: Warnings encountered while processing document.
  signature: 'warnings: List[TextAnalyticsWarning]'