ExtractiveSummarizeOptions Class

Definition

Namespace:

Azure.AI.TextAnalytics

Assembly:

Azure.AI.TextAnalytics.dll

Package:

Azure.AI.TextAnalytics v5.3.0

Source:

ExtractiveSummarizeOptions.cs

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

public class ExtractiveSummarizeOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions

type ExtractiveSummarizeOptions = class
    inherit TextAnalyticsRequestOptions

Public Class ExtractiveSummarizeOptions
Inherits TextAnalyticsRequestOptions

Inheritance

Object

TextAnalyticsRequestOptions

ExtractiveSummarizeOptions

Constructors

ExtractiveSummarizeOptions()

Initializes a new instance of the ExtractiveSummarizeOptions class.

Properties

DisableServiceLogs	The default value of this property is false except for methods like AnalyzeHealthcareEntities and RecognizePiiEntities. This means that the Language service logs your input text for 48 hours solely to allow for troubleshooting issues. Setting this property to true disables input logging and may limit our ability to investigate 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. (Inherited from TextAnalyticsRequestOptions)
DisplayName	The optional display name of the operation.
IncludeStatistics	Gets or sets a value that, if set to true, indicates that the service should return document and document batch statistics with the results of the operation. Returns data for batch document methods only. (Inherited from TextAnalyticsRequestOptions)
MaxSentenceCount	The maximum number of sentences to be returned in the result. If not set, the service default is used.
ModelVersion	Gets or sets a value that, if set, indicates the version of the Language service model that will be used to generate the result. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/language-service/concepts/model-lifecycle#available-versions. (Inherited from TextAnalyticsRequestOptions)
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.