Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/openai_deno/mod.ts>CreateChatParams

OpenAI API wrapper for deno.
Latest
interface CreateChatParams
Re-export
import { type CreateChatParams } from "https://deno.land/x/openai_deno@v0.9.8/mod.ts";

Properties

optional
functions: Function[]

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

optional
functionCall: ChatFunctionCall | 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.

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.

OpenAI generally recommend altering this or topP but not both.

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.

OpenAI generally recommend altering this or temperature but not both.

optional
count: number

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

optional
stop: string | string[] | null

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

optional
maxTokens: number

The maximum number of tokens to generate in the completion. The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting 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.

See more information about frequency and presence penalties.

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.

See more information about frequency and presence penalties.

optional
logitBias: { [key: string]: number; } | null

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.

optional
user: string

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