ChatRequestBody

Value parameters

frequencyPenalty

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.

logitBias

Modify the likelihood of specified tokens appearing in the completion.

maxTokens

The maximum number of tokens to generate in the chat completion.

messages

A list of messages describing the conversation so far.

model

ID of the model to use.

n

How many chat completion choices to generate for each input message.

presencePenalty

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.

responseFormat

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.

seed

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.

stop

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

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.

toolChoice

Controls which (if any) function is called by the model.

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.

topP

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.

user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Attributes

Companion

object

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Supertypes

trait Product

trait Mirror

class Object

trait Matchable

class Any

Self type

ChatBody.type

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class CustomChatCompletionModel

object GPT35Turbo

object GPT35Turbo0301

object GPT4

object GPT40314

object GPT432k

object GPT432k0314

object GPT4Turbo

object GPT4TurboVision

Show all

Attributes

Companion

class

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

ChatCompletionModel.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

ResponseFormat.type

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object JsonObject

object Text