Interface CreateChatCompletionRequest

Your OpenAI API key.

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.

Default

0
Copy

See

Create Chat Completion Request Body - frequency_penalty

Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user 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.

See

Create Chat Completion Request Body - function_call

A list of functions the model may generate JSON inputs for.

See

Create Chat Completion Request Body - functions

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.

Default

null
Copy

See

Create Chat Completion Request Body - logit_bias

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.

Default

inf
Copy

See

Create Chat Completion Request Body - max_tokens

The messages to generate chat completions for, in the chat format.

See

Create Chat Completion Request Body - messages

ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

See

Create Chat Completion Request Body - model

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.

Default

0
Copy

See

Create Chat Completion Request Body - presence_penalty

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

Default

null
Copy

See

Create Chat Completion Request Body - stop

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 a data: [DONE] message. See the OpenAI Cookbook for example code.

Default

false
Copy

See

Create Chat Completion Request Body - stream

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 or top_p but not both.

Default

1
Copy

See

Create Chat Completion Request Body - temperature

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 or temperature but not both.

Default

1
Copy

See

Create Chat Completion Request Body - top_p

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

See

Create Chat Completion Request Body - user