Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/src/types.ts>ChatCompletionOptions

Unofficial Deno wrapper for the Open Ai api
Extremely Popular
Go to Latest
interface ChatCompletionOptions
import { type ChatCompletionOptions } from "https://deno.land/x/openai@1.4.3/src/types.ts";

Properties

model: string

ID of the model to use. Currently gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301 are supported. https://platform.openai.com/docs/api-reference/chat/create#chat/create-model

The messages to generate chat completions for, in the chat format.The messages to generate chat completions for, in the chat format. https://platform.openai.com/docs/api-reference/chat/create#chat/create-messages

optional
temperature: number

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. https://platform.openai.com/docs/api-reference/chat/create#chat/create-temperature

optional
topP: number

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. https://platform.openai.com/docs/api-reference/chat/create#chat/create-top_p

optional
n: number

How many chat completion choices to generate for each input message. https://platform.openai.com/docs/api-reference/chat/create#chat/create-n

optional
stop: string | string[]

Up to 4 sequences where the API will stop generating further tokens. https://platform.openai.com/docs/api-reference/chat/create#chat/create-stop

optional
maxTokens: number

The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). https://platform.openai.com/docs/api-reference/chat/create#chat/create-max_tokens

optional
presencePenalty: number

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. https://platform.openai.com/docs/api-reference/chat/create#chat/create-presence_penalty

optional
frequencyPenalty: number

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. https://platform.openai.com/docs/api-reference/chat/create#chat/create-frequency_penalty

optional
logitBias: Record<string, number>

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. https://platform.openai.com/docs/api-reference/chat/create#chat/create-logit_bias

optional
user: string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. https://platform.openai.com/docs/api-reference/chat/create#chat/create-user

optional
functions: ChatCompletionOptionsFunction[]

A list of functions the model may generate JSON inputs for. https://platform.openai.com/docs/api-reference/chat/create#chat/create-functions

optional
function_call: "none" | "auto" | { name: string; }

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. https://platform.openai.com/docs/api-reference/chat/create#chat/create-function_call