Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 32.9 KB

chatcompletionrequest.md

File metadata and controls

37 lines (32 loc) · 32.9 KB

ChatCompletionRequest

Example Usage

import { ChatCompletionRequest } from "@mistralai/mistralai/models/components";

let value: ChatCompletionRequest = {
  model: "mistral-small-latest",
  messages: [
    {
      content: "Who is the best French painter? Answer in one short sentence.",
      role: "user",
    },
  ],
};

Fields

Field Type Required Description Example
model string ✔️ ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions. mistral-small-latest
temperature number ➖ What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 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. The default value varies depending on the model you are targeting. Call the /models endpoint to retrieve the appropriate value.
topP number ➖ 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.
maxTokens number ➖ The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.
stream boolean ➖ Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
stop components.Stop ➖ Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
randomSeed number ➖ The seed to use for random sampling. If set, different calls will generate deterministic results.
messages components.Messages[] ✔️ The prompt(s) to generate completions for, encoded as a list of dict with role and content. [
{
"role": "user",
"content": "Who is the best French painter? Answer in one short sentence."
}
]
responseFormat components.ResponseFormat ➖ N/A
tools components.Tool[] ➖ N/A
toolChoice components.ChatCompletionRequestToolChoice ➖ N/A
presencePenalty number ➖ presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
frequencyPenalty number ➖ frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
n number ➖ Number of completions to return for each request, input tokens are only billed once.
safePrompt boolean ➖ Whether to inject a safety prompt before all conversations.