Share via


PhraseListOptions Class

  • java.lang.Object
    • com.azure.ai.speech.transcription.models.PhraseListOptions

Implements

public final class PhraseListOptions
implements JsonSerializable<PhraseListOptions>

Phrase list properties for transcription.

Constructor Summary

Constructor Description
PhraseListOptions()

Creates an instance of PhraseListOptions class.

Method Summary

Modifier and Type Method and Description
static PhraseListOptions fromJson(JsonReader jsonReader)

Reads an instance of PhraseListOptions from the JsonReader.

Double getBiasingWeight()

Get the biasingWeight property: Biasing weight for phrase list (0.0-2.0).

List<String> getPhrases()

Get the phrases property: List of phrases for recognition.

PhraseListOptions setBiasingWeight(Double biasingWeight)

Set the biasingWeight property: Biasing weight for phrase list (0.0-2.0).

PhraseListOptions setPhrases(List<String> phrases)

Set the phrases property: List of phrases for recognition.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

PhraseListOptions

public PhraseListOptions()

Creates an instance of PhraseListOptions class.

Method Details

fromJson

public static PhraseListOptions fromJson(JsonReader jsonReader)

Reads an instance of PhraseListOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the PhraseListOptions.

getBiasingWeight

public Double getBiasingWeight()

Get the biasingWeight property: Biasing weight for phrase list (0.0-2.0).

Returns:

the biasingWeight value.

getPhrases

public List<String> getPhrases()

Get the phrases property: List of phrases for recognition.

Returns:

the phrases value.

setBiasingWeight

public PhraseListOptions setBiasingWeight(Double biasingWeight)

Set the biasingWeight property: Biasing weight for phrase list (0.0-2.0).

Parameters:

biasingWeight - the biasingWeight value to set.

Returns:

the PhraseListOptions object itself.

setPhrases

public PhraseListOptions setPhrases(List<String> phrases)

Set the phrases property: List of phrases for recognition.

Parameters:

phrases - the phrases value to set.

Returns:

the PhraseListOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to