Package com.azure.ai.textanalytics.models

Class DynamicClassificationOptions

java.lang.Object
com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
com.azure.ai.textanalytics.models.DynamicClassificationOptions
public final class DynamicClassificationOptions extends TextAnalyticsRequestOptions
The DynamicClassificationOptions model.

  • Constructor Details

    • DynamicClassificationOptions

      public DynamicClassificationOptions()

  • Method Details

    • setModelVersion

      public DynamicClassificationOptions 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.
      Overrides:
      setModelVersion in class TextAnalyticsRequestOptions
      Parameters:
      modelVersion - The model version.
      Returns:
      The DynamicClassificationOptions object itself.

    • setIncludeStatistics

      public DynamicClassificationOptions setIncludeStatistics(boolean includeStatistics)
      Sets the value of includeStatistics. The default value is false by default. If set to true, indicates that the service should return document and document batch statistics with the results of the operation.
      Overrides:
      setIncludeStatistics in class TextAnalyticsRequestOptions
      Parameters:
      includeStatistics - If a boolean value was specified in the request this field will contain information about the document payload.
      Returns:
      The DynamicClassificationOptions object itself.

    • setServiceLogsDisabled

      public DynamicClassificationOptions setServiceLogsDisabled(boolean disableServiceLogs)
      Sets the value of service logs disable status.
      Overrides:
      setServiceLogsDisabled in class TextAnalyticsRequestOptions
      Parameters:
      disableServiceLogs - The default value of this property is 'false', except for methods like 'beginAnalyzeHealthcareEntities' and 'recognizePiiEntities'. 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 DynamicClassificationOptions object itself.

    • getCategories

      public Iterable<String> getCategories()
      Gets the value of categories. A list of categories to which input is classified to.
      Returns:
      The value of categories.

    • setCategories

      public DynamicClassificationOptions setCategories(String... categories)
      Sets the value of categories. A list of categories to which input is classified to.
      Parameters:
      categories - A list of categories to which input is classified to.
      Returns:
      The DynamicClassificationOptions object itself.

    • getClassificationType

      public ClassificationType getClassificationType()
      Get the classificationType property: Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document.
      Returns:
      the classificationType value.

    • setClassificationType

      public DynamicClassificationOptions setClassificationType(ClassificationType classificationType)
      Set the classificationType property: Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document.
      Parameters:
      classificationType - the classificationType value to set.
      Returns:
      the DynamicClassificationOptions object itself.