Share via


RecognizeCustomEntitiesAction Class

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

public final class RecognizeCustomEntitiesAction

Configurations that allow callers to specify details about how to execute a custom entities recognition action in a set of documents. See the service documentation for regional support of custom entities recognition: custom entity recognition

Constructor Summary

Constructor Description
RecognizeCustomEntitiesAction(String projectName, String deploymentName)

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

Method Summary

Modifier and Type Method and Description
String getActionName()

Get the name of action.

String getDeploymentName()

Gets the name of the deployment being consumed.

String getProjectName()

Gets the name of the project which owns the model being consumed.

boolean isServiceLogsDisabled()

Gets the value of disableServiceLogs.

RecognizeCustomEntitiesAction setActionName(String actionName)

Set the custom name for the action.

RecognizeCustomEntitiesAction setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of disableServiceLogs.

Methods inherited from java.lang.Object

Constructor Details

RecognizeCustomEntitiesAction

public RecognizeCustomEntitiesAction(String projectName, String deploymentName)

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

Parameters:

projectName - The name of the project which owns the model being consumed.
deploymentName - The name of the deployment being consumed.

Method Details

getActionName

public String getActionName()

Get the name of action.

Returns:

the name of action.

getDeploymentName

public String getDeploymentName()

Gets the name of the deployment being consumed.

Returns:

The name of the deployment being consumed.

getProjectName

public String getProjectName()

Gets the name of the project which owns the model being consumed.

Returns:

The name of the project which owns the model being consumed.

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

Set the custom name for the action.

Parameters:

actionName - the custom name for the action.

Returns:

The RecognizeCustomEntitiesAction object itself.

setServiceLogsDisabled

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

Applies to