View Source ExOpenAI.Chat (ex_openai.ex v1.4.0)

Modules for interacting with the chat group of OpenAI APIs

API Reference:



Creates a model response for the given chat conversation.


Link to this function

create_chat_completion(messages, model, opts \\ [])

View Source
@spec create_chat_completion(
   | :"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")
  | String.t(),
  openai_organization_key: String.t(),
  openai_api_key: String.t(),
  user: String.t(),
  top_p: float(),
  tools: [ExOpenAI.Components.ChatCompletionTool.t()],
  tool_choice: ExOpenAI.Components.ChatCompletionToolChoiceOption.t(),
  temperature: float(),
  stream: boolean(),
  stop: [String.t()] | String.t(),
  seed: integer(),
  response_format: %{type: :json_object | :text},
  presence_penalty: float(),
  n: integer(),
  max_tokens: integer(),
  logit_bias: map(),
  functions: [ExOpenAI.Components.ChatCompletionFunctions.t()],
    ExOpenAI.Components.ChatCompletionFunctionCallOption.t() | :auto | :none,
  frequency_penalty: float(),
  stream_to: (... -> any()) | pid()
) ::
  {:ok, ExOpenAI.Components.CreateChatCompletionResponse.t()} | {:error, any()}

Creates a model response for the given chat conversation.


Method: POST


Required Arguments:

Optional Arguments:

  • stream_to: PID or function of where to stream content to

  • frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

See more information about frequency and presence penalties.

  • function_call: Deprecated in favor of tool_choice.

Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via {"name": "my_function"} forces the model to call that function.

none is the default when no functions are present. auto`` is the default if functions are present. -functions: Deprecated in favor oftools. A list of functions the model may generate JSON inputs for. -logit_bias: Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. -max_tokens: The maximum number of [tokens]( to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code]( for counting tokens. -n: How many chat completion choices to generate for each input message. *Example*:1-presence_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. [See more information about frequency and presence penalties.]( -response_format: An object specifying the format that the model must output. Setting to{ "type": "json_object" }enables JSON mode, which guarantees the message the model generates is valid JSON. **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in increased latency and appearance of a "stuck" request. Also note that the message content may be partially cut off iffinish_reason="length", which indicates the generation exceededmax_tokensor the conversation exceeded the max context length. -seed: This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the sameseedand parameters should return the same result. Determinism is not guaranteed, and you should refer to thesystem_fingerprintresponse parameter to monitor changes in the backend. -stop: Up to 4 sequences where the API will stop generating further tokens. -stream: If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events]( as they become available, with the stream terminated by adata: [DONE]message. [Example Python code]( -temperature: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this ortop_pbut not both. *Example*:1-tool_choice: -tools: A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. -top_p: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this ortemperaturebut not both. *Example*:1-user: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more]( *Example*:"user-1234"-openai_api_key: OpenAI API key to pass directly. If this is specified, it will override theapi_keyconfig value. -openai_organization_key: OpenAI API key to pass directly. If this is specified, it will override theorganization_key` config value.