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

public final class ExtractiveSummaryAction

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

Constructor Summary

Constructor	Description
ExtractiveSummaryAction()	Constructs a ExtractiveSummaryAction model.

Method Summary

Modifier and Type	Method and Description
String	getActionName() Get the name of action.
Integer	getMaxSentenceCount() Gets the maximum extractive summarization sentences number to be returned in the response.
String	getModelVersion() Gets the version of the text analytics model used by this operation.
ExtractiveSummarySentencesOrder	getOrderBy() Gets the order in which the summary sentences will be presented by.
boolean	isServiceLogsDisabled() Gets the value of disableServiceLogs.
ExtractiveSummaryAction	setActionName(String actionName) Set the custom name for the action.
ExtractiveSummaryAction	setMaxSentenceCount(Integer maxSentenceCount) Sets the maximum extractive summarization sentences number to be returned in the response.
ExtractiveSummaryAction	setModelVersion(String modelVersion) Set the model version.
ExtractiveSummaryAction	setOrderBy(ExtractiveSummarySentencesOrder orderBy) Sets the order in which the summary sentences will be presented by.
ExtractiveSummaryAction	setServiceLogsDisabled(boolean disableServiceLogs) Sets the value of disableServiceLogs.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ExtractiveSummaryAction

public ExtractiveSummaryAction()

Constructs a ExtractiveSummaryAction model.

Method Details

getActionName

public String getActionName()

Get the name of action.

Returns:

the name of action.

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.

getModelVersion

public String getModelVersion()

Gets the version of the text analytics model used by this operation.

Returns:

The model version.

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.

isServiceLogsDisabled

public boolean isServiceLogsDisabled()

Gets the value of disableServiceLogs.

Returns:

The value of disableServiceLogs. The default value of this property is 'false'. 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.

setActionName

public ExtractiveSummaryAction setActionName(String actionName)

Set the custom name for the action.

Parameters:

actionName - the custom name for the action.

Returns:

The ExtractiveSummaryAction object itself.

setMaxSentenceCount

public ExtractiveSummaryAction 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 ExtractiveSummaryAction object itself.

setModelVersion

public ExtractiveSummaryAction setModelVersion(String modelVersion)

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

Parameters:

modelVersion - The model version.

Returns:

The ExtractiveSummaryAction object itself.

setOrderBy

public ExtractiveSummaryAction 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 ExtractiveSummaryAction object itself.

setServiceLogsDisabled

public ExtractiveSummaryAction setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of disableServiceLogs.

Parameters:

disableServiceLogs - The default value of this property is 'false'. 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 ExtractiveSummaryAction object itself.