chatgpt / Exports / openai / CreateChatCompletionRequest
openai.CreateChatCompletionRequest
Export
CreateChatCompletionRequest
- frequency_penalty
- logit_bias
- max_tokens
- messages
- model
- n
- presence_penalty
- stop
- stream
- temperature
- top_p
- user
• 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
• 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
• 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
• messages: ChatCompletionRequestMessage
[]
The messages to generate chat completions for, in the chat format.
Memberof
CreateChatCompletionRequest
• model: string
ID of the model to use. Currently, only gpt-3.5-turbo
and gpt-3.5-turbo-0301
are supported.
Memberof
CreateChatCompletionRequest
• Optional
n: number
How many chat completion choices to generate for each input message.
Memberof
CreateChatCompletionRequest
• 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
• Optional
stop: CreateChatCompletionRequestStop
Memberof
CreateChatCompletionRequest
• 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
• 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
• 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
• Optional
user: string
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
Memberof
CreateChatCompletionRequest