View Source ExOpenAI.Components.CreateChatCompletionRequest (ex_openai.ex v1.7.0)

Schema representing a CreateChatCompletionRequest within the OpenAI API

Summary

Types

@type t() :: %ExOpenAI.Components.CreateChatCompletionRequest{
  frequency_penalty: float() | nil,
  function_call:
    (ExOpenAI.Components.ChatCompletionFunctionCallOption.t() | :auto | :none)
    | nil,
  functions: [ExOpenAI.Components.ChatCompletionFunctions.t()] | nil,
  logit_bias: map() | nil,
  logprobs: boolean() | nil,
  max_tokens: integer() | nil,
  messages: [ExOpenAI.Components.ChatCompletionRequestMessage.t()],
  model:
    (:"gpt-3.5-turbo-16k-0613"
     | :"gpt-3.5-turbo-0125"
     | :"gpt-3.5-turbo-1106"
     | :"gpt-3.5-turbo-0613"
     | :"gpt-3.5-turbo-0301"
     | :"gpt-3.5-turbo-16k"
     | :"gpt-3.5-turbo"
     | :"gpt-4-32k-0613"
     | :"gpt-4-32k-0314"
     | :"gpt-4-32k"
     | :"gpt-4-0613"
     | :"gpt-4-0314"
     | :"gpt-4"
     | :"gpt-4-vision-preview"
     | :"gpt-4-1106-preview"
     | :"gpt-4-turbo-preview"
     | :"gpt-4-0125-preview"
     | :"gpt-4-turbo-2024-04-09"
     | :"gpt-4-turbo"
     | :"gpt-4o-2024-05-13"
     | :"gpt-4o")
    | String.t(),
  n: integer() | nil,
  parallel_tool_calls: ExOpenAI.Components.ParallelToolCalls.t() | nil,
  presence_penalty: float() | nil,
  response_format: %{type: :json_object | :text} | nil,
  seed: integer() | nil,
  service_tier: (:default | :auto) | nil,
  stop: ([String.t()] | String.t()) | nil,
  stream: boolean() | nil,
  stream_options: ExOpenAI.Components.ChatCompletionStreamOptions.t() | nil,
  temperature: float() | nil,
  tool_choice: ExOpenAI.Components.ChatCompletionToolChoiceOption.t() | nil,
  tools: [ExOpenAI.Components.ChatCompletionTool.t()] | nil,
  top_logprobs: integer() | nil,
  top_p: float() | nil,
  user: String.t() | nil
}