openai.createchatcompletionprops
Home > @runlightyear/openai > CreateChatCompletionProps
CreateChatCompletionProps interface
Signature:interface CreateChatCompletionProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| messages | Array<ChatMessage> | The messages to generate chat completions for, in the chat format. | |
| model | string | ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| 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. Defaults to 0 | |
| logitBias? | object | Defaults to 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. | |
| maxTokens? | number | 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. Defaults to inf | |
| n? | number | How many chat completion choices to generate for each input message. Defaults to 1 | |
| 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. Defaults to 0 | |
| stop? | string | Up to 4 sequences where the API will stop generating further tokens. Defaults to null | |
| 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. See the OpenAI Cookbook for example code. Defaults to false | |
| 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. Defaults to 1 | |
| 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. Defaults to 1 | |
| user? | string | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more. |