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

public final class ExtractKeyPhrasesAction

Configurations that allow callers to specify details about how to execute a key phrases extraction action in a set of documents.

Constructor Summary

Constructor	Description
ExtractKeyPhrasesAction()	Constructs a ExtractKeyPhrasesAction object.

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.
boolean	isServiceLogsDisabled() Gets the value of service logs disable status.
ExtractKeyPhrasesAction	setActionName(String actionName) Set the custom name for the action.
ExtractKeyPhrasesAction	setModelVersion(String modelVersion) Sets the model version.
ExtractKeyPhrasesAction	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

ExtractKeyPhrasesAction

public ExtractKeyPhrasesAction()

Constructs a ExtractKeyPhrasesAction object.

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.

isServiceLogsDisabled

public boolean isServiceLogsDisabled()

Gets the value of service logs disable status. 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:

true if service logging of input text is disabled.

setActionName

public ExtractKeyPhrasesAction setActionName(String actionName)

Set the custom name for the action.

Parameters:

actionName - the custom name for the action.

Returns:

The ExtractKeyPhrasesAction object itself.

setModelVersion

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

setServiceLogsDisabled

public ExtractKeyPhrasesAction setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

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