View Source OpenAi.Response (OpenAI REST API Client v1.0.0)

Provides struct and type for a Response

Summary

Types

@type t() :: %OpenAi.Response{
  created_at: number() | nil,
  error: OpenAi.Response.Error.t() | nil,
  id: String.t() | nil,
  incomplete_details: OpenAi.Response.IncompleteDetails.t() | nil,
  instructions: String.t() | nil,
  max_output_tokens: integer() | nil,
  metadata: map() | nil,
  model: String.t() | nil,
  object: String.t() | nil,
  output:
    [
      OpenAi.Response.Computer.ToolCall.t()
      | OpenAi.Response.FileSearch.Tool.Call.t()
      | OpenAi.Response.Function.ToolCall.t()
      | OpenAi.Response.Output.Message.t()
      | OpenAi.Response.Reasoning.Item.t()
      | OpenAi.Response.WebSearch.ToolCall.t()
    ]
    | nil,
  output_text: String.t() | nil,
  parallel_tool_calls: boolean() | nil,
  previous_response_id: String.t() | nil,
  reasoning: OpenAi.Response.Reasoning.t() | nil,
  service_tier: String.t() | nil,
  status: String.t() | nil,
  temperature: number() | nil,
  text: map() | nil,
  tool_choice:
    OpenAi.Tool.Choice.Function.t()
    | OpenAi.Tool.Choice.Types.t()
    | String.t()
    | nil,
  tools:
    [
      OpenAi.Response.Computer.UsePreviewTool.t()
      | OpenAi.Response.FileSearch.Tool.t()
      | OpenAi.Response.Function.Tool.t()
      | OpenAi.Response.WebSearch.PreviewTool.t()
    ]
    | nil,
  top_p: number() | nil,
  truncation: String.t() | nil,
  usage: OpenAi.Response.Usage.t() | nil,
  user: String.t() | nil
}