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

Emitted when there is an additional text delta.

Fields

  • :content_index - required - integer()
    The index of the content part that the text delta was added to.

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

  • :item_id - required - String.t()
    The ID of the output item that the text delta was added to.

  • :logprobs - required - [ExOpenAI.Components.ResponseLogProb.t()]
    The log probabilities of the tokens in the delta.

  • :output_index - required - integer()
    The index of the output item that the text delta was added to.

  • :sequence_number - required - integer()
    The sequence number for this event.

  • :type - required - :"response.output_text.delta"
    The type of the event. Always response.output_text.delta.
    Allowed values: "response.output_text.delta"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.ResponseTextDeltaEvent{
  content_index: integer(),
  delta: String.t(),
  item_id: String.t(),
  logprobs: [ExOpenAI.Components.ResponseLogProb.t()],
  output_index: integer(),
  sequence_number: integer(),
  type: :"response.output_text.delta"
}