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

public final class AbstractiveSummaryAction

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

Constructor Summary

Constructor	Description
AbstractiveSummaryAction()	Constructs a AbstractiveSummaryAction model.

Method Summary

Modifier and Type	Method and Description
String	getActionName() Get the name of action.
String	getModelVersion() Gets the version of the text analytics model used by this operation.
Integer	getSentenceCount() Get the sentenceCount property: It controls the approximate number of sentences in the output summaries.
boolean	isServiceLogsDisabled() Gets the value of service logs disable status.
AbstractiveSummaryAction	setActionName(String actionName) Set the custom name for the action.
AbstractiveSummaryAction	setModelVersion(String modelVersion) Sets the model version.
AbstractiveSummaryAction	setSentenceCount(Integer sentenceCount) Set the sentenceCount property: It controls the approximate number of sentences in the output summaries.
AbstractiveSummaryAction	setServiceLogsDisabled(boolean disableServiceLogs) Sets the value of service logs disable status.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AbstractiveSummaryAction

public AbstractiveSummaryAction()

Constructs a AbstractiveSummaryAction model.

Method Details

getActionName

public String getActionName()

Get the name of action.

Returns:

the name of action.

getModelVersion

public String getModelVersion()

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

Returns:

The model version.

getSentenceCount

public Integer getSentenceCount()

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

Returns:

the sentenceCount value.

isServiceLogsDisabled

public boolean isServiceLogsDisabled()

Gets the value of service logs disable status. The default value of this property is 'true'. This means, Text Analytics service won't log your input text. Setting this property to 'false', enables logging your input text for 48 hours, solely to allow for troubleshooting issues.

Returns:

true if service logging of input text is disabled.

setActionName

public AbstractiveSummaryAction setActionName(String actionName)

Set the custom name for the action.

Parameters:

actionName - the custom name for the action.

Returns:

The AbstractiveSummaryAction object itself.

setModelVersion

public AbstractiveSummaryAction 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.

Parameters:

modelVersion - The model version.

Returns:

The AbstractiveSummaryAction object itself.

setSentenceCount

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

setServiceLogsDisabled

public AbstractiveSummaryAction setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Parameters:

disableServiceLogs - The default value of this property is 'true'. This means, Text Analytics service won't log your input text. Setting this property to 'false', enables logging your input text for 48 hours, solely to allow for troubleshooting issues.

Returns:

The AbstractiveSummaryAction object itself.