Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 23.2 KB

fimcompletionrequest.md

File metadata and controls

28 lines (23 loc) · 23.2 KB

FIMCompletionRequest

Example Usage

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

let value: FIMCompletionRequest = {
  model: "codestral-2405",
  prompt: "def",
  suffix: "return a+b",
};

Fields

Field Type Required Description Example
model string ✔️ ID of the model to use. Only compatible for now with:
- codestral-2405
- codestral-latest		 codestral-2405
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.FIMCompletionRequestStop ➖ 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.
prompt string ✔️ The text/code to complete. def
suffix string ➖ Optional text/code that adds more context for the model. When given a prompt and a suffix the model will fill what is between them. When suffix is not provided, the model will simply execute completion starting with prompt. return a+b
minTokens number ➖ The minimum number of tokens to generate in the completion.