Share via


RecognizeEntitiesAction Class

  • java.lang.Object
    • com.azure.ai.textanalytics.models.RecognizeEntitiesAction

public final class RecognizeEntitiesAction

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

Constructor Summary

Constructor Description
RecognizeEntitiesAction()

Constructs a RecognizeEntitiesAction 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.

boolean isServiceLogsDisabled()

Gets the value of service logs disable status.

RecognizeEntitiesAction setActionName(String actionName)

Set the custom name for the action.

RecognizeEntitiesAction setModelVersion(String modelVersion)

Sets the model version.

RecognizeEntitiesAction setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Methods inherited from java.lang.Object

Constructor Details

RecognizeEntitiesAction

public RecognizeEntitiesAction()

Constructs a RecognizeEntitiesAction 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.

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 RecognizeEntitiesAction setActionName(String actionName)

Set the custom name for the action.

Parameters:

actionName - the custom name for the action.

Returns:

The RecognizeEntitiesAction object itself.

setModelVersion

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

setServiceLogsDisabled

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

Applies to