View Source ExOpenAI.Components.CreateChatCompletionStreamResponse (ex_openai.ex v1.8.0-beta)

Schema representing a CreateChatCompletionStreamResponse within the OpenAI API

Summary

Types

@type t() :: %ExOpenAI.Components.CreateChatCompletionStreamResponse{
  choices: [
    %{
      delta: ExOpenAI.Components.ChatCompletionStreamResponseDelta.t(),
      finish_reason:
        :function_call | :content_filter | :tool_calls | :length | :stop,
      index: integer(),
      logprobs: %{
        content: [ExOpenAI.Components.ChatCompletionTokenLogprob.t()],
        refusal: [ExOpenAI.Components.ChatCompletionTokenLogprob.t()]
      }
    }
  ],
  created: integer(),
  id: String.t(),
  model: String.t(),
  object: :"chat.completion.chunk",
  service_tier: (:default | :scale) | nil,
  system_fingerprint: String.t() | nil,
  usage:
    %{
      completion_tokens: integer(),
      prompt_tokens: integer(),
      total_tokens: integer()
    }
    | nil
}