Package com.azure.resourcemanager.machinelearning.models

Class TextNer

java.lang.Object
com.azure.resourcemanager.machinelearning.models.AutoMLVertical
com.azure.resourcemanager.machinelearning.models.TextNer
All Implemented Interfaces:
com.azure.json.JsonSerializable<AutoMLVertical>
public final class TextNer extends AutoMLVertical
Text-NER task in AutoML NLP vertical. NER - Named Entity Recognition. NLP - Natural Language Processing.

  • Constructor Details

    • TextNer

      public TextNer()
      Creates an instance of TextNer class.

  • Method Details

    • taskType

      public TaskType taskType()
      Get the taskType property: [Required] Task type for AutoMLJob.
      Overrides:
      taskType in class AutoMLVertical
      Returns:
      the taskType value.

    • primaryMetric

      public ClassificationPrimaryMetrics primaryMetric()
      Get the primaryMetric property: Primary metric for Text-NER task. Only 'Accuracy' is supported for Text-NER, so user need not set this explicitly.
      Returns:
      the primaryMetric value.

    • limitSettings

      public NlpVerticalLimitSettings limitSettings()
      Get the limitSettings property: Execution constraints for AutoMLJob.
      Returns:
      the limitSettings value.

    • withLimitSettings

      public TextNer withLimitSettings(NlpVerticalLimitSettings limitSettings)
      Set the limitSettings property: Execution constraints for AutoMLJob.
      Parameters:
      limitSettings - the limitSettings value to set.
      Returns:
      the TextNer object itself.

    • featurizationSettings

      public NlpVerticalFeaturizationSettings featurizationSettings()
      Get the featurizationSettings property: Featurization inputs needed for AutoML job.
      Returns:
      the featurizationSettings value.

    • withFeaturizationSettings

      public TextNer withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)
      Set the featurizationSettings property: Featurization inputs needed for AutoML job.
      Parameters:
      featurizationSettings - the featurizationSettings value to set.
      Returns:
      the TextNer object itself.

    • validationData

      public MLTableJobInput validationData()
      Get the validationData property: Validation data inputs.
      Returns:
      the validationData value.

    • withValidationData

      public TextNer withValidationData(MLTableJobInput validationData)
      Set the validationData property: Validation data inputs.
      Parameters:
      validationData - the validationData value to set.
      Returns:
      the TextNer object itself.

    • withLogVerbosity

      public TextNer withLogVerbosity(LogVerbosity logVerbosity)
      Set the logVerbosity property: Log verbosity for the job.
      Overrides:
      withLogVerbosity in class AutoMLVertical
      Parameters:
      logVerbosity - the logVerbosity value to set.
      Returns:
      the AutoMLVertical object itself.

    • withTrainingData

      public TextNer withTrainingData(MLTableJobInput trainingData)
      Set the trainingData property: [Required] Training data input.
      Overrides:
      withTrainingData in class AutoMLVertical
      Parameters:
      trainingData - the trainingData value to set.
      Returns:
      the AutoMLVertical object itself.

    • withTargetColumnName

      public TextNer withTargetColumnName(String targetColumnName)
      Set the targetColumnName property: Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
      Overrides:
      withTargetColumnName in class AutoMLVertical
      Parameters:
      targetColumnName - the targetColumnName value to set.
      Returns:
      the AutoMLVertical object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class AutoMLVertical
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AutoMLVertical>
      Overrides:
      toJson in class AutoMLVertical
      Throws:
      IOException

    • fromJson

      public static TextNer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TextNer from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TextNer if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the TextNer.