AbstractiveSummaryOptions Class

Package:

com.azure.ai.textanalytics.models

Maven Artifact:

com.azure:azure-ai-textanalytics:5.5.12

• java.lang.Object
• • com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
  • • com.azure.ai.textanalytics.models.AbstractiveSummaryOptions

public final class AbstractiveSummaryOptions
extends TextAnalyticsRequestOptions

Configurations that allow callers to specify details about how to execute an abstractive summarization in a set of documents.

Constructor Summary

Constructor	Description
AbstractiveSummaryOptions()	Constructs a AbstractiveSummaryOptions model.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Gets display name of the operation.
Integer	getSentenceCount() Get the sentenceCount property: It controls the approximate number of sentences in the output summaries.
AbstractiveSummaryOptions	setDisplayName(String displayName) Sets display name of the operation.
AbstractiveSummaryOptions	setIncludeStatistics(boolean includeStatistics) Sets the value of includeStatistics.
AbstractiveSummaryOptions	setModelVersion(String modelVersion) Sets the model version.
AbstractiveSummaryOptions	setSentenceCount(Integer sentenceCount) Set the sentenceCount property: It controls the approximate number of sentences in the output summaries.
AbstractiveSummaryOptions	setServiceLogsDisabled(boolean disableServiceLogs) Sets the value of service logs disable status.

Methods inherited from TextAnalyticsRequestOptions

getModelVersion isIncludeStatistics isServiceLogsDisabled setIncludeStatistics setModelVersion setServiceLogsDisabled

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AbstractiveSummaryOptions

public AbstractiveSummaryOptions()

Constructs a AbstractiveSummaryOptions model.

Method Details

getDisplayName

public String getDisplayName()

Gets display name of the operation.

Returns:

Display name of the operation.

getSentenceCount

public Integer getSentenceCount()

Get the sentenceCount property: It controls the approximate number of sentences in the output summaries.

Returns:

the sentenceCount value.

setDisplayName

public AbstractiveSummaryOptions setDisplayName(String displayName)

Sets display name of the operation.

Parameters:

displayName - Display name of the operation.

Returns:

The AbstractiveSummaryOptions object itself.

setIncludeStatistics

public AbstractiveSummaryOptions setIncludeStatistics(boolean includeStatistics)

Sets the value of includeStatistics. The default value is false by default. If set to true, indicates that the service should return document and document batch statistics with the results of the operation.

Overrides:

AbstractiveSummaryOptions.setIncludeStatistics(boolean includeStatistics)

Parameters:

includeStatistics - If a boolean value was specified in the request this field will contain information about the document payload.

Returns:

The AbstractiveSummaryOptions object itself.

setModelVersion

public AbstractiveSummaryOptions setModelVersion(String modelVersion)

Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". If a model-version is not specified, the API will default to the latest, non-preview version.

Overrides:

AbstractiveSummaryOptions.setModelVersion(String modelVersion)

Parameters:

modelVersion - The model version.

Returns:

The AbstractiveSummaryOptions object itself.

setSentenceCount

public AbstractiveSummaryOptions setSentenceCount(Integer sentenceCount)

Set the sentenceCount property: It controls the approximate number of sentences in the output summaries.

Parameters:

sentenceCount - the sentenceCount value to set.

Returns:

The AbstractiveSummaryOptions object itself.

setServiceLogsDisabled

public AbstractiveSummaryOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Overrides:

AbstractiveSummaryOptions.setServiceLogsDisabled(boolean disableServiceLogs)

Parameters:

disableServiceLogs - The default value of this property is 'false', except for methods like 'beginAnalyzeHealthcareEntities' and 'recognizePiiEntities'. This means, Text Analytics 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.

Returns:

The AbstractiveSummaryOptions object itself.