ExtractiveSummaryOptions 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.ExtractiveSummaryOptions

public final class ExtractiveSummaryOptions
extends TextAnalyticsRequestOptions

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

Constructor Summary

Constructor	Description
ExtractiveSummaryOptions()	Constructs a ExtractiveSummaryOptions model.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Gets display name of the operation.
Integer	getMaxSentenceCount() Gets the maximum extractive summarization sentences number to be returned in the response.
ExtractiveSummarySentencesOrder	getOrderBy() Gets the order in which the summary sentences will be presented by.
ExtractiveSummaryOptions	setDisplayName(String displayName) Sets display name of the operation.
ExtractiveSummaryOptions	setIncludeStatistics(boolean includeStatistics) Sets the value of includeStatistics.
ExtractiveSummaryOptions	setMaxSentenceCount(Integer maxSentenceCount) Sets the maximum extractive summarization sentences number to be returned in the response.
ExtractiveSummaryOptions	setModelVersion(String modelVersion) Sets the model version.
ExtractiveSummaryOptions	setOrderBy(ExtractiveSummarySentencesOrder orderBy) Sets the order in which the summary sentences will be presented by.
ExtractiveSummaryOptions	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

ExtractiveSummaryOptions

public ExtractiveSummaryOptions()

Constructs a ExtractiveSummaryOptions model.

Method Details

getDisplayName

public String getDisplayName()

Gets display name of the operation.

Returns:

Display name of the operation.

getMaxSentenceCount

public Integer getMaxSentenceCount()

Gets the maximum extractive summarization sentences number to be returned in the response. If 'null' or not specified, a default value of 3 will be used as the maximum sentences number in the service side.

Returns:

The maximum extractive summarization sentences number to be returned in the response.

getOrderBy

public ExtractiveSummarySentencesOrder getOrderBy()

Gets the order in which the summary sentences will be presented by.

Returns:

The order in which the summary sentences will be presented by.

setDisplayName

public ExtractiveSummaryOptions setDisplayName(String displayName)

Sets display name of the operation.

Parameters:

displayName - Display name of the operation.

Returns:

The ExtractiveSummaryOptions object itself.

setIncludeStatistics

public ExtractiveSummaryOptions 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:

ExtractiveSummaryOptions.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 ExtractiveSummaryOptions object itself.

setMaxSentenceCount

public ExtractiveSummaryOptions setMaxSentenceCount(Integer maxSentenceCount)

Sets the maximum extractive summarization sentences number to be returned in the response. If 'null' or not specified, a default value of 3 will be used as the maximum sentences number in the service side.

Parameters:

maxSentenceCount - The maximum extractive summarization sentences number to be returned in the response.

Returns:

The ExtractiveSummaryOptions object itself.

setModelVersion

public ExtractiveSummaryOptions 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:

ExtractiveSummaryOptions.setModelVersion(String modelVersion)

Parameters:

modelVersion - The model version.

Returns:

The ExtractiveSummaryOptions object itself.

setOrderBy

public ExtractiveSummaryOptions setOrderBy(ExtractiveSummarySentencesOrder orderBy)

Sets the order in which the summary sentences will be presented by. Defaults to OFFSET if not specified.

Parameters:

orderBy - The type of summary sentences order. Defaults to OFFSET if not specified.

Returns:

The ExtractiveSummaryOptions object itself.

setServiceLogsDisabled

public ExtractiveSummaryOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Overrides:

ExtractiveSummaryOptions.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 ExtractiveSummaryOptions object itself.