Package com.azure.ai.openai.models

Class AudioTranscriptionFormat

java.lang.Object

com.azure.core.util.ExpandableStringEnum<AudioTranscriptionFormat>

com.azure.ai.openai.models.AudioTranscriptionFormat

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class AudioTranscriptionFormat
extends com.azure.core.util.ExpandableStringEnum<AudioTranscriptionFormat>

Defines available options for the underlying response format of output transcription information.

Field Summary

Fields

Modifier and Type	Field	Description
static final AudioTranscriptionFormat	JSON	Use a response body that is a JSON object containing a single 'text' field for the transcription.
static final AudioTranscriptionFormat	SRT	Use a response body that is plain text in SubRip (SRT) format that also includes timing information.
static final AudioTranscriptionFormat	TEXT	Use a response body that is plain text containing the raw, unannotated transcription.
static final AudioTranscriptionFormat	VERBOSE_JSON	Use a response body that is a JSON object containing transcription text along with timing, segments, and other metadata.
static final AudioTranscriptionFormat	VTT	Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information.

Constructor Summary

Constructors

Constructor	Description
AudioTranscriptionFormat()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static AudioTranscriptionFormat	fromString(String name)	Creates or finds a AudioTranscriptionFormat from its string representation.
static Collection<AudioTranscriptionFormat>	values()	Gets known AudioTranscriptionFormat values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON

public static final AudioTranscriptionFormat JSON

Use a response body that is a JSON object containing a single 'text' field for the transcription.

VERBOSE_JSON

public static final AudioTranscriptionFormat VERBOSE_JSON

Use a response body that is a JSON object containing transcription text along with timing, segments, and other metadata.

TEXT

public static final AudioTranscriptionFormat TEXT

Use a response body that is plain text containing the raw, unannotated transcription.

SRT

public static final AudioTranscriptionFormat SRT

Use a response body that is plain text in SubRip (SRT) format that also includes timing information.

VTT

public static final AudioTranscriptionFormat VTT

Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information.

Constructor Details

AudioTranscriptionFormat

@Deprecated
public AudioTranscriptionFormat()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of AudioTranscriptionFormat value.

Method Details

fromString

public static AudioTranscriptionFormat fromString(String name)

Creates or finds a AudioTranscriptionFormat from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding AudioTranscriptionFormat.

values

public static Collection<AudioTranscriptionFormat> values()

Gets known AudioTranscriptionFormat values.

Returns:

known AudioTranscriptionFormat values.