Package com.azure.ai.textanalytics.models

Class AnalyzeSentimentAction

java.lang.Object
com.azure.ai.textanalytics.models.AnalyzeSentimentAction
public final class AnalyzeSentimentAction extends Object
Configurations that allow callers to specify details about how to execute an sentiment analysis action in a set of documents.

  • Constructor Details

    • AnalyzeSentimentAction

      public AnalyzeSentimentAction()

  • Method Details

    • getActionName

      public String getActionName()
      Get the name of action.
      Returns:
      the name of action.

    • setActionName

      public AnalyzeSentimentAction setActionName(String actionName)
      Set the custom name for the action.
      Parameters:
      actionName - the custom name for the action.
      Returns:
      The AnalyzeSentimentAction object itself.

    • getModelVersion

      public String getModelVersion()
      Gets the version of the text analytics model used by this operation.
      Returns:
      The model version.

    • setModelVersion

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

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

    • setServiceLogsDisabled

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

    • isIncludeOpinionMining

      public boolean isIncludeOpinionMining()
      Gets the value of includeOpinionMining. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get a opinions property on SentenceSentiment. It is provided by service v3.1 and later.
      Returns:
      The value of includeOpinionMining.

    • setIncludeOpinionMining

      public AnalyzeSentimentAction setIncludeOpinionMining(boolean includeOpinionMining)
      Sets the value of includeOpinionMining. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get a opinions property on SentenceSentiment. It is provided by service v3.1 and later.
      Parameters:
      includeOpinionMining - The boolean indicator to include opinion mining data in the returned result.
      Returns:
      The AnalyzeSentimentAction object itself.