Share via


ExtractiveSummarizeAction Class

Definition

A set of options used to configure extractive summarization, including the model version to use, the maximum number of sentences to extract, and more.

public class ExtractiveSummarizeAction
type ExtractiveSummarizeAction = class
Public Class ExtractiveSummarizeAction
Inheritance
ExtractiveSummarizeAction

Constructors

ExtractiveSummarizeAction()

Initializes a new instance of the ExtractiveSummarizeAction class.

ExtractiveSummarizeAction(ExtractiveSummarizeOptions)

Initializes a new instance of the ExtractiveSummarizeAction class based on the given ExtractiveSummarizeOptions.

Properties

ActionName

The name of this action. If not set, the service will generate one.

DisableServiceLogs

Indicates whether the service logs your input text for 48 hours, which is solely to allow for troubleshooting, if needed. Setting this property to true disables input logging and may limit our ability to investigate any issues that occur. If not set, the service default is used.

Please see the Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and the Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

MaxSentenceCount

The maximum number of sentences to be returned in the result. If not set, the service default is used.

ModelVersion

The version of the text analytics model that will be used to generate the result. To learn more about the supported model versions for each feature, see https://learn.microsoft.com/azure/cognitive-services/language-service/concepts/model-lifecycle.

OrderBy

The order in which the extracted sentences will be returned in the result. Use Offset to keep the original order in which the sentences appear in the input document. Use Rank to order them according to their relevance, as determined by the service. If not set, the service default is used.

Applies to