Type Members

1.  sealed trait FunctionCall extends AnyRef

   function_call model

   function_call model

   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.

2.  final case class LogitBias(values: Map[String, Json]) extends DynamicObject[LogitBias] with Product with Serializable

   logit_bias model

   logit_bias model

   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.

   values

   The dynamic list of key-value pairs of the object

3.  sealed trait Model extends AnyRef

   model model

   model model

   ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API.

4.  type N = CreateChatCompletionRequest.N.Type

   n model

   n model

   How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

5.  final case class ResponseFormat(type: Optional[Type] = Optional.Absent) extends Product with Serializable

   response_format model

   response_format model

   An object specifying the format that the model must output. Compatible with [GPT-4 Turbo](/docs/models/gpt-4-and-gpt-4-turbo) and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.

   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 a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

   type

   Must be one of text or json_object.

6.  type Seed = CreateChatCompletionRequest.Seed.Type

   seed model

   seed model

   This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

7.  sealed trait Stop extends AnyRef

   stop model

   stop model

   Up to 4 sequences where the API will stop generating further tokens.

8.  type TopLogprobs = CreateChatCompletionRequest.TopLogprobs.Type

   top_logprobs model

   top_logprobs model

   An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.