AbstractiveSummarizeOptions Class

  • Reference

Definition

Namespace:
Azure.AI.TextAnalytics
Assembly:
Azure.AI.TextAnalytics.dll
Package:
Azure.AI.TextAnalytics v5.3.0
Source:
AbstractiveSummarizeOptions.cs

A set of options used to configure abstractive summarization, including the display name to use, the maximum number of sentences that the resulting summary can have, and more.

public class AbstractiveSummarizeOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions
type AbstractiveSummarizeOptions = class
    inherit TextAnalyticsRequestOptions
Public Class AbstractiveSummarizeOptions
Inherits TextAnalyticsRequestOptions
Inheritance
Object
TextAnalyticsRequestOptions
AbstractiveSummarizeOptions

Constructors

AbstractiveSummarizeOptions()

Initializes a new instance of the AbstractiveSummarizeOptions 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)
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)
SentenceCount

The desired number of sentences in the resulting summaries, which the service will attempt to approximate.

Applies to