TranscriptionDiarizationOptions Class

Package:
com.azure.ai.speech.transcription.models
Maven Artifact:
com.azure:azure-ai-speech-transcription:1.0.0
  • java.lang.Object
    • com.azure.ai.speech.transcription.models.TranscriptionDiarizationOptions

Implements

JsonSerializable<TranscriptionDiarizationOptions>

public final class TranscriptionDiarizationOptions
implements JsonSerializable<TranscriptionDiarizationOptions>

The Speaker Diarization settings. Diarization settings must be specified to enable speaker diarization.

Constructor Summary

Constructor Description
TranscriptionDiarizationOptions(boolean enabled)

Creates an instance of TranscriptionDiarizationOptions class.

Method Summary

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

Reads an instance of TranscriptionDiarizationOptions from the JsonReader.
Integer getMaxSpeakers()

Get the maxSpeakers property: Gets or sets a hint for the maximum number of speakers for diarization.
Boolean isEnabled()

Get the enabled property: whether speaker diarization is enabled for this transcription request.
TranscriptionDiarizationOptions setMaxSpeakers(Integer maxSpeakers)

Set the maxSpeakers property: Gets or sets a hint for the maximum number of speakers for diarization.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TranscriptionDiarizationOptions

public TranscriptionDiarizationOptions(boolean enabled)

Creates an instance of TranscriptionDiarizationOptions class.

Parameters:

enabled - whether speaker diarization is enabled for this transcription request.

Method Details

fromJson

public static TranscriptionDiarizationOptions fromJson(JsonReader jsonReader)

Reads an instance of TranscriptionDiarizationOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TranscriptionDiarizationOptions 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 TranscriptionDiarizationOptions.

getMaxSpeakers

public Integer getMaxSpeakers()

Get the maxSpeakers property: Gets or sets a hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36.

Returns:

the maxSpeakers value.

isEnabled

public Boolean isEnabled()

Get the enabled property: whether speaker diarization is enabled for this transcription request. The value is supplied via the constructor; the client does not auto-enable diarization when maxSpeakers is specified.

Returns:

the enabled value.

setMaxSpeakers

public TranscriptionDiarizationOptions setMaxSpeakers(Integer maxSpeakers)

Set the maxSpeakers property: Gets or sets a hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36.

Parameters:

maxSpeakers - the maxSpeakers value to set.

Returns:

the TranscriptionDiarizationOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to