View Source OpenAi.Chat.Completion.CreateRequest (OpenAI REST API Client v1.0.1)

Provides struct and type for a Chat.Completion.CreateRequest

Summary

Types

@type t() :: %OpenAi.Chat.Completion.CreateRequest{
  audio: OpenAi.Chat.Completion.CreateRequest.Audio.t() | nil,
  frequency_penalty: number() | nil,
  function_call:
    OpenAi.Chat.Completion.FunctionCallOption.t() | String.t() | nil,
  functions: [OpenAi.Chat.Completion.Function.t()] | nil,
  logit_bias: OpenAi.Chat.Completion.CreateRequest.LogitBias.t() | nil,
  logprobs: boolean() | nil,
  max_completion_tokens: integer() | nil,
  max_tokens: integer() | nil,
  messages:
    [
      OpenAi.Chat.Completion.Request.AssistantMessage.t()
      | OpenAi.Chat.Completion.Request.DeveloperMessage.t()
      | OpenAi.Chat.Completion.Request.FunctionMessage.t()
      | OpenAi.Chat.Completion.Request.SystemMessage.t()
      | OpenAi.Chat.Completion.Request.ToolMessage.t()
      | OpenAi.Chat.Completion.Request.UserMessage.t()
    ]
    | nil,
  metadata: map() | nil,
  modalities: [String.t()] | nil,
  model: String.t() | nil,
  n: integer() | nil,
  parallel_tool_calls: boolean() | nil,
  prediction: OpenAi.Chat.Completion.PredictionContent.t() | nil,
  presence_penalty: number() | nil,
  reasoning_effort: String.t() | nil,
  response_format:
    OpenAi.Response.Format.Json.t()
    | OpenAi.Response.Format.JsonSchema.t()
    | OpenAi.Response.Format.Text.t()
    | nil,
  seed: integer() | nil,
  service_tier: String.t() | nil,
  stop: String.t() | [String.t()] | nil,
  store: boolean() | nil,
  stream: boolean() | nil,
  stream_options: OpenAi.Chat.Completion.Stream.Options.t() | nil,
  temperature: number() | nil,
  tool_choice: OpenAi.Chat.Completion.NamedTool.Choice.t() | String.t() | nil,
  tools: [OpenAi.Chat.Completion.Tool.t()] | nil,
  top_logprobs: integer() | nil,
  top_p: number() | nil,
  user: String.t() | nil,
  web_search_options: OpenAi.Response.WebSearch.t() | nil
}