enum

OpenAI::AudioResponseFormat

Inherits Enum < Comparable < Value < Object

The format of the output, in one of these options: json, text, srt, verbose_json, vtt, or diarized_json. For gpt-4o-transcribe and gpt-4o-mini-transcribe, the only supported format is json. For gpt-4o-transcribe-diarize, the supported formats are json, text, and diarized_json, with diarized_json required to receive speaker annotations.

Constants

Json = 0

Text = 1

Srt = 2

VerboseJson = 3

Vtt = 4

DiarizedJson = 5

Constructors

new(pull : JSON::PullParser) : self

Source

Instance methods

diarized_json?

Returns true if this enum value equals DiarizedJson

Source

json?

Returns true if this enum value equals Json

Source

srt?

Returns true if this enum value equals Srt

Source

text?

Returns true if this enum value equals Text

Source

to_json(json : JSON::Builder) : Nil

Serializes this enum member by name.

For non-flags enums, the serialization is a JSON string. The value is the member name (see #to_s) transformed with String#underscore.

enum Stages
  INITIAL
  SECOND_STAGE
end

Stages::INITIAL.to_json      # => %("initial")
Stages::SECOND_STAGE.to_json # => %("second_stage")

For flags enums, the serialization is a JSON array including every flagged member individually serialized in the same way as a member of a non-flags enum. None is serialized as an empty array, All as an array containing all members.

@[Flags]
enum Sides
  LEFT
  RIGHT
end

Sides::LEFT.to_json                  # => %(["left"])
(Sides::LEFT | Sides::RIGHT).to_json # => %(["left","right"])
Sides::All.to_json                   # => %(["left","right"])
Sides::None.to_json                  # => %([])

ValueConverter.to_json offers a different serialization strategy based on the member value.

Source

verbose_json?

Returns true if this enum value equals VerboseJson

Source

vtt?

Returns true if this enum value equals Vtt

Source