AudioTranscriptionFormat Class

Package:

com.azure.ai.openai.models

Maven Artifact:

com.azure:azure-ai-openai:1.0.0-beta.12

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.openai.models.AudioTranscriptionFormat

public final class AudioTranscriptionFormat
extends ExpandableStringEnum<AudioTranscriptionFormat>

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

Field Summary

Modifier and Type	Field and 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

Constructor	Description
AudioTranscriptionFormat()	Deprecated Use the fromString(String name) factory method. Creates a new instance of AudioTranscriptionFormat value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from 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.

SRT

public static final AudioTranscriptionFormat SRT

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

TEXT

public static final AudioTranscriptionFormat TEXT

Use a response body that is plain text containing the raw, unannotated 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.

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 name) 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 values()

Gets known AudioTranscriptionFormat values.

Returns:

known AudioTranscriptionFormat values.