2023-01-12 08:15:51 +03:00
### YamlMime:JavaType
uid : "com.azure.resourcemanager.machinelearning.models.TextNer"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer"
name : "TextNer"
nameWithType : "TextNer"
summary : "Text-NER task in AutoML NLP vertical."
inheritances :
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods :
- classRef : "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical&text=AutoMLVertical\" data-throw-if-not-resolved=\"False\" />"
methodsRef :
2024-08-23 08:07:14 +03:00
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.fromJson(com.azure.json.JsonReader)?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
2023-01-12 08:15:51 +03:00
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.logVerbosity()?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.logVerbosity&text=logVerbosity\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.targetColumnName()?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.targetColumnName&text=targetColumnName\" data-throw-if-not-resolved=\"False\" />"
2024-08-23 08:07:14 +03:00
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.taskType()?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.taskType&text=taskType\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.toJson(com.azure.json.JsonWriter)?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
2023-01-12 08:15:51 +03:00
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.trainingData()?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.trainingData&text=trainingData\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.validate()?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.validate&text=validate\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withLogVerbosity(com.azure.resourcemanager.machinelearning.models.LogVerbosity)?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withLogVerbosity&text=withLogVerbosity\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withTargetColumnName(java.lang.String)?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withTargetColumnName&text=withTargetColumnName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withTrainingData(com.azure.resourcemanager.machinelearning.models.MLTableJobInput)?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withTrainingData&text=withTrainingData\" data-throw-if-not-resolved=\"False\" />"
- classRef : "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef :
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax : "public final class **TextNer**</br> extends <xref href=\"com.azure.resourcemanager.machinelearning.models.AutoMLVertical?alt=com.azure.resourcemanager.machinelearning.models.AutoMLVertical&text=AutoMLVertical\" data-throw-if-not-resolved=\"False\" />"
constructors :
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.TextNer()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.TextNer()"
name : "TextNer()"
nameWithType : "TextNer.TextNer()"
summary : "Creates an instance of Text<wbr>Ner class."
syntax : "public TextNer()"
desc : "Creates an instance of TextNer class."
methods :
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.featurizationSettings()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.featurizationSettings()"
name : "featurizationSettings()"
nameWithType : "TextNer.featurizationSettings()"
summary : "Get the featurization<wbr>Settings property: Featurization inputs needed for AutoML job."
syntax : "public NlpVerticalFeaturizationSettings featurizationSettings()"
desc : "Get the featurizationSettings property: Featurization inputs needed for AutoML job."
returns :
description : "the featurizationSettings value."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.NlpVerticalFeaturizationSettings?alt=com.azure.resourcemanager.machinelearning.models.NlpVerticalFeaturizationSettings&text=NlpVerticalFeaturizationSettings\" data-throw-if-not-resolved=\"False\" />"
2024-08-23 08:07:14 +03:00
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.fromJson(com.azure.json.JsonReader)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.fromJson(JsonReader jsonReader)"
name : "fromJson(JsonReader jsonReader)"
nameWithType : "TextNer.fromJson(JsonReader jsonReader)"
summary : "Reads an instance of Text<wbr>Ner from the Json<wbr>Reader."
modifiers :
- "static"
parameters :
- description : "The JsonReader being read."
name : "jsonReader"
type : "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax : "public static TextNer fromJson(JsonReader jsonReader)"
exceptions :
- description : "If the deserialized JSON object was missing any required properties."
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc : "Reads an instance of TextNer from the JsonReader."
returns :
description : "An instance of TextNer if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
2023-01-12 08:15:51 +03:00
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.limitSettings()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.limitSettings()"
name : "limitSettings()"
nameWithType : "TextNer.limitSettings()"
summary : "Get the limit<wbr>Settings property: Execution constraints for Auto<wbr>MLJob."
syntax : "public NlpVerticalLimitSettings limitSettings()"
desc : "Get the limitSettings property: Execution constraints for AutoMLJob."
returns :
description : "the limitSettings value."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.NlpVerticalLimitSettings?alt=com.azure.resourcemanager.machinelearning.models.NlpVerticalLimitSettings&text=NlpVerticalLimitSettings\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.primaryMetric()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.primaryMetric()"
name : "primaryMetric()"
nameWithType : "TextNer.primaryMetric()"
summary : "Get the primary<wbr>Metric property: Primary metric for Text-NER task."
syntax : "public ClassificationPrimaryMetrics primaryMetric()"
desc : "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 :
description : "the primaryMetric value."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.ClassificationPrimaryMetrics?alt=com.azure.resourcemanager.machinelearning.models.ClassificationPrimaryMetrics&text=ClassificationPrimaryMetrics\" data-throw-if-not-resolved=\"False\" />"
2024-08-23 08:07:14 +03:00
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.taskType()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.taskType()"
name : "taskType()"
nameWithType : "TextNer.taskType()"
summary : "Get the task<wbr>Type property: \\[Required\\] Task type for Auto<wbr>MLJob."
overridden : "com.azure.resourcemanager.machinelearning.models.AutoMLVertical.taskType()"
syntax : "public TaskType taskType()"
desc : "Get the taskType property: \\[Required\\] Task type for AutoMLJob."
returns :
description : "the taskType value."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TaskType?alt=com.azure.resourcemanager.machinelearning.models.TaskType&text=TaskType\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.toJson(com.azure.json.JsonWriter)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.toJson(JsonWriter jsonWriter)"
name : "toJson(JsonWriter jsonWriter)"
nameWithType : "TextNer.toJson(JsonWriter jsonWriter)"
overridden : "com.azure.resourcemanager.machinelearning.models.AutoMLVertical.toJson(com.azure.json.JsonWriter)"
parameters :
- name : "jsonWriter"
type : "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax : "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions :
- type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns :
type : "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
2023-01-12 08:15:51 +03:00
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.validate()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.validate()"
name : "validate()"
nameWithType : "TextNer.validate()"
summary : "Validates the instance."
overridden : "com.azure.resourcemanager.machinelearning.models.AutoMLVertical.validate()"
syntax : "public void validate()"
desc : "Validates the instance."
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.validationData()"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.validationData()"
name : "validationData()"
nameWithType : "TextNer.validationData()"
summary : "Get the validation<wbr>Data property: Validation data inputs."
syntax : "public MLTableJobInput validationData()"
desc : "Get the validationData property: Validation data inputs."
returns :
description : "the validationData value."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.MLTableJobInput?alt=com.azure.resourcemanager.machinelearning.models.MLTableJobInput&text=MLTableJobInput\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.withFeaturizationSettings(com.azure.resourcemanager.machinelearning.models.NlpVerticalFeaturizationSettings)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)"
name : "withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)"
nameWithType : "TextNer.withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)"
summary : "Set the featurization<wbr>Settings property: Featurization inputs needed for AutoML job."
parameters :
- description : "the featurizationSettings value to set."
name : "featurizationSettings"
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.NlpVerticalFeaturizationSettings?alt=com.azure.resourcemanager.machinelearning.models.NlpVerticalFeaturizationSettings&text=NlpVerticalFeaturizationSettings\" data-throw-if-not-resolved=\"False\" />"
syntax : "public TextNer withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)"
desc : "Set the featurizationSettings property: Featurization inputs needed for AutoML job."
returns :
description : "the TextNer object itself."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.withLimitSettings(com.azure.resourcemanager.machinelearning.models.NlpVerticalLimitSettings)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.withLimitSettings(NlpVerticalLimitSettings limitSettings)"
name : "withLimitSettings(NlpVerticalLimitSettings limitSettings)"
nameWithType : "TextNer.withLimitSettings(NlpVerticalLimitSettings limitSettings)"
summary : "Set the limit<wbr>Settings property: Execution constraints for Auto<wbr>MLJob."
parameters :
- description : "the limitSettings value to set."
name : "limitSettings"
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.NlpVerticalLimitSettings?alt=com.azure.resourcemanager.machinelearning.models.NlpVerticalLimitSettings&text=NlpVerticalLimitSettings\" data-throw-if-not-resolved=\"False\" />"
syntax : "public TextNer withLimitSettings(NlpVerticalLimitSettings limitSettings)"
desc : "Set the limitSettings property: Execution constraints for AutoMLJob."
returns :
description : "the TextNer object itself."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.withLogVerbosity(com.azure.resourcemanager.machinelearning.models.LogVerbosity)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.withLogVerbosity(LogVerbosity logVerbosity)"
name : "withLogVerbosity(LogVerbosity logVerbosity)"
nameWithType : "TextNer.withLogVerbosity(LogVerbosity logVerbosity)"
summary : "Set the log<wbr>Verbosity property: Log verbosity for the job."
overridden : "com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withLogVerbosity(com.azure.resourcemanager.machinelearning.models.LogVerbosity)"
parameters :
- name : "logVerbosity"
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.LogVerbosity?alt=com.azure.resourcemanager.machinelearning.models.LogVerbosity&text=LogVerbosity\" data-throw-if-not-resolved=\"False\" />"
syntax : "public TextNer withLogVerbosity(LogVerbosity logVerbosity)"
desc : "Set the logVerbosity property: Log verbosity for the job."
returns :
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.withTargetColumnName(java.lang.String)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.withTargetColumnName(String targetColumnName)"
name : "withTargetColumnName(String targetColumnName)"
nameWithType : "TextNer.withTargetColumnName(String targetColumnName)"
summary : "Set the target<wbr>Column<wbr>Name property: Target column name: This is prediction values column."
overridden : "com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withTargetColumnName(java.lang.String)"
parameters :
- name : "targetColumnName"
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax : "public TextNer withTargetColumnName(String targetColumnName)"
desc : "Set the targetColumnName property: Target column name: This is prediction values column. Also known as label column name in context of classification tasks."
returns :
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.withTrainingData(com.azure.resourcemanager.machinelearning.models.MLTableJobInput)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.withTrainingData(MLTableJobInput trainingData)"
name : "withTrainingData(MLTableJobInput trainingData)"
nameWithType : "TextNer.withTrainingData(MLTableJobInput trainingData)"
summary : "Set the training<wbr>Data property: \\[Required\\] Training data input."
overridden : "com.azure.resourcemanager.machinelearning.models.AutoMLVertical.withTrainingData(com.azure.resourcemanager.machinelearning.models.MLTableJobInput)"
parameters :
- name : "trainingData"
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.MLTableJobInput?alt=com.azure.resourcemanager.machinelearning.models.MLTableJobInput&text=MLTableJobInput\" data-throw-if-not-resolved=\"False\" />"
syntax : "public TextNer withTrainingData(MLTableJobInput trainingData)"
desc : "Set the trainingData property: \\[Required\\] Training data input."
returns :
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.machinelearning.models.TextNer.withValidationData(com.azure.resourcemanager.machinelearning.models.MLTableJobInput)"
fullName : "com.azure.resourcemanager.machinelearning.models.TextNer.withValidationData(MLTableJobInput validationData)"
name : "withValidationData(MLTableJobInput validationData)"
nameWithType : "TextNer.withValidationData(MLTableJobInput validationData)"
summary : "Set the validation<wbr>Data property: Validation data inputs."
parameters :
- description : "the validationData value to set."
name : "validationData"
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.MLTableJobInput?alt=com.azure.resourcemanager.machinelearning.models.MLTableJobInput&text=MLTableJobInput\" data-throw-if-not-resolved=\"False\" />"
syntax : "public TextNer withValidationData(MLTableJobInput validationData)"
desc : "Set the validationData property: Validation data inputs."
returns :
description : "the TextNer object itself."
type : "<xref href=\"com.azure.resourcemanager.machinelearning.models.TextNer?alt=com.azure.resourcemanager.machinelearning.models.TextNer&text=TextNer\" data-throw-if-not-resolved=\"False\" />"
type : "class"
desc : "Text-NER task in AutoML NLP vertical. NER - Named Entity Recognition. NLP - Natural Language Processing."
metadata : {}
package : "com.azure.resourcemanager.machinelearning.models"
2024-08-23 08:07:14 +03:00
artifact : com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0