| Field | Type | Required | Description | Example |
|---|---|---|---|---|
model |
Nullable[str] | ✔️ | 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 |
messages |
List[models.ChatCompletionStreamRequestMessages] | ✔️ | 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." } ] |
temperature |
Optional[float] | ➖ | What sampling temperature to use, between 0.0 and 1.0. 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. |
|
top_p |
Optional[float] | ➖ | 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. |
|
max_tokens |
OptionalNullable[int] | ➖ | 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. |
|
min_tokens |
OptionalNullable[int] | ➖ | The minimum number of tokens to generate in the completion. | |
stream |
Optional[bool] | ➖ | N/A | |
stop |
Optional[models.ChatCompletionStreamRequestStop] | ➖ | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | |
random_seed |
OptionalNullable[int] | ➖ | The seed to use for random sampling. If set, different calls will generate deterministic results. | |
response_format |
Optional[models.ResponseFormat] | ➖ | N/A | |
tools |
List[models.Tool] | ➖ | N/A | |
tool_choice |
Optional[models.ChatCompletionStreamRequestToolChoice] | ➖ | N/A | |
safe_prompt |
Optional[bool] | ➖ | Whether to inject a safety prompt before all conversations. |