OpenAi.Chat.Completion.CreateRequest (OpenAI REST API Client v0.2.1)

Provides struct and type for a Chat.Completion.CreateRequest

Summary

Types

@type t() :: %OpenAi.Chat.Completion.CreateRequest{
  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_tokens: integer() | nil,
  messages: [
    OpenAi.Chat.Completion.Request.AssistantMessage.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()
  ],
  model: String.t(),
  n: integer() | nil,
  parallel_tool_calls: boolean() | nil,
  presence_penalty: number() | nil,
  response_format:
    OpenAi.Chat.Completion.Request.CreateResponseFormat.t() | nil,
  seed: integer() | nil,
  service_tier: String.t() | nil,
  stop: String.t() | [String.t()] | nil,
  stream: boolean() | nil,
  stream_options: OpenAi.Chat.Completion.StreamOptions.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
}