View Source ExOpenAI.Components.TranscriptTextDeltaEvent (ex_openai.ex v2.0.0-beta2)

Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you create a transcription with the Stream parameter set to true.

Fields

  • :delta - required - String.t()
    The text delta that was additionally transcribed.

  • :logprobs - optional - [{:%{}, [], [{{:optional, [], [:bytes]}, {:list, [], [{:integer, [], []}]}}, {{:optional, [], [:logprob]}, {:number, [], []}}, {{:optional, [], [:token]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}]
    The log probabilities of the delta. Only included if you create a transcription with the include[] parameter set to logprobs.

  • :segment_id - optional - String.t()
    Identifier of the diarized segment that this delta belongs to. Only present when using gpt-4o-transcribe-diarize.

  • :type - required - :"transcript.text.delta"
    The type of the event. Always transcript.text.delta.
    Allowed values: "transcript.text.delta"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.TranscriptTextDeltaEvent{
  delta: String.t(),
  logprobs:
    [
      %{
        optional(:bytes) => [integer()],
        optional(:logprob) => number(),
        optional(:token) => String.t()
      }
    ]
    | nil,
  segment_id: String.t() | nil,
  type: :"transcript.text.delta"
}