Skip to content

Latest commit

 

History

History
216 lines (114 loc) · 6.24 KB

openai.CreateChatCompletionRequest.md

File metadata and controls

216 lines (114 loc) · 6.24 KB

chatgpt / Exports / openai / CreateChatCompletionRequest

Interface: CreateChatCompletionRequest

openai.CreateChatCompletionRequest

Export

CreateChatCompletionRequest

Table of contents

Properties

Properties

frequency_penalty

Optional frequency_penalty: 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.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:333


logit_bias

Optional logit_bias: object

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.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:339


max_tokens

Optional max_tokens: 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).

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:321


messages

messages: ChatCompletionRequestMessage[]

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

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:285


model

model: string

ID of the model to use. Currently, only gpt-3.5-turbo and gpt-3.5-turbo-0301 are supported.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:279


n

Optional n: number

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

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:303


presence_penalty

Optional presence_penalty: 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.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:327


stop

Optional stop: CreateChatCompletionRequestStop

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:315


stream

Optional stream: boolean

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.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:309


temperature

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.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:291


top_p

Optional top_p: 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.

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:297


user

Optional user: string

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

Memberof

CreateChatCompletionRequest

Defined in

src/types.ts:345