LanguageDetectionSkill Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.9.0-beta.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.SearchIndexerSkill
  • • com.azure.search.documents.indexes.models.LanguageDetectionSkill

public final class LanguageDetectionSkill
extends SearchIndexerSkill

A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis.

Constructor Summary

Constructor	Description
LanguageDetectionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)	Creates an instance of LanguageDetectionSkill class.

Method Summary

Modifier and Type	Method and Description
static LanguageDetectionSkill	fromJson(JsonReader jsonReader) Reads an instance of LanguageDetectionSkill from the JsonReader.
String	getDefaultCountryHint() Get the defaultCountryHint property: A country code to use as a hint to the language detection model if it cannot disambiguate the language.
String	getModelVersion() Get the modelVersion property: The version of the model to use when calling the Text Analytics service.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
LanguageDetectionSkill	setContext(String context) Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content).
LanguageDetectionSkill	setDefaultCountryHint(String defaultCountryHint) Set the defaultCountryHint property: A country code to use as a hint to the language detection model if it cannot disambiguate the language.
LanguageDetectionSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
LanguageDetectionSkill	setModelVersion(String modelVersion) Set the modelVersion property: The version of the model to use when calling the Text Analytics service.
LanguageDetectionSkill	setName(String name) Set the name property: The name of the skill which uniquely identifies it within the skillset.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from SearchIndexerSkill

fromJson getContext getDescription getInputs getName getOdataType getOutputs setContext setDescription setName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LanguageDetectionSkill

public LanguageDetectionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of LanguageDetectionSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

fromJson

public static LanguageDetectionSkill fromJson(JsonReader jsonReader)

Reads an instance of LanguageDetectionSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LanguageDetectionSkill if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getDefaultCountryHint

public String getDefaultCountryHint()

Get the defaultCountryHint property: A country code to use as a hint to the language detection model if it cannot disambiguate the language.

Returns:

the defaultCountryHint value.

getModelVersion

public String getModelVersion()

Get the modelVersion property: The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.

Returns:

the modelVersion value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.

Overrides:

LanguageDetectionSkill.getOdataType()

Returns:

the odataType value.

setContext

public LanguageDetectionSkill setContext(String context)

Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

Overrides:

LanguageDetectionSkill.setContext(String context)

Parameters:

context

setDefaultCountryHint

public LanguageDetectionSkill setDefaultCountryHint(String defaultCountryHint)

Set the defaultCountryHint property: A country code to use as a hint to the language detection model if it cannot disambiguate the language.

Parameters:

defaultCountryHint - the defaultCountryHint value to set.

Returns:

the LanguageDetectionSkill object itself.

setDescription

public LanguageDetectionSkill setDescription(String description)

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.

Overrides:

LanguageDetectionSkill.setDescription(String description)

Parameters:

description

setModelVersion

public LanguageDetectionSkill setModelVersion(String modelVersion)

Set the modelVersion property: The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.

Parameters:

modelVersion - the modelVersion value to set.

Returns:

the LanguageDetectionSkill object itself.

setName

public LanguageDetectionSkill setName(String name)

Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

Overrides:

LanguageDetectionSkill.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

LanguageDetectionSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException