ExtractiveSummaryAction Class

ExtractiveSummaryAction encapsulates the parameters for starting a long-running Extractive Text Summarization operation. For a conceptual discussion of extractive summarization, see the service documentation: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview

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

Inheritance

azure.ai.textanalytics._dict_mixin.DictMixin

ExtractiveSummaryAction

Constructor

ExtractiveSummaryAction(*, model_version: str | None = None, string_index_type: str | None = None, disable_service_logs: bool | None = None, max_sentence_count: int | None = None, order_by: Literal['Rank', 'Offset'] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
model_version	Optional[str] The model version to use for the analysis, e.g. "latest". If a model version is not specified, the API will default to the latest, non-preview version. See here for more info: https://aka.ms/text-analytics-model-versioning
string_index_type	Optional[str] Specifies the method used to interpret string offsets. UnicodeCodePoint, the Python encoding, is the default. To override the Python default, you can also pass in Utf16CodeUnit or TextElement_v8. For additional information see https://aka.ms/text-analytics-offsets
disable_service_logs	Optional[bool] If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the service's natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.
max_sentence_count	Optional[int] Maximum number of sentences to return. Defaults to 3.
order_by	Optional[str] Possible values include: "Offset", "Rank". Default value: "Offset".

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

disable_service_logs

If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the service's natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

disable_service_logs: bool | None = None

max_sentence_count

Number of sentences to return. Defaults to 3.

max_sentence_count: int | None = None

model_version

The model version to use for the analysis, e.g. "latest". If a model version is not specified, the API will default to the latest, non-preview version. See here for more info: https://aka.ms/text-analytics-model-versioning

model_version: str | None = None

order_by

Possible values include "Offset", "Rank". Default value is "Offset".

order_by: Literal['Rank', 'Offset'] | None = None

string_index_type

Specifies the method used to interpret string offsets. UnicodeCodePoint, the Python encoding, is the default. To override the Python default, you can also pass in Utf16CodeUnit or TextElement_v8. For additional information see https://aka.ms/text-analytics-offsets

string_index_type: str | None = None