# ChatStreamCompletionCreateParams

Chat completion request parameters


## Fields

| Field                                                                                                                                    | Type                                                                                                                                     | Required                                                                                                                                 | Description                                                                                                                              | Example                                                                                                                                  |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `messages`                                                                                                                               | List[[models.ChatCompletionMessageParam](../models/chatcompletionmessageparam.md)]                                                       | :heavy_check_mark:                                                                                                                       | List of messages for the conversation                                                                                                    | [<br/>{<br/>"role": "user",<br/>"content": "Hello, how are you?"<br/>}<br/>]                                                             |
| `model`                                                                                                                                  | *Optional[str]*                                                                                                                          | :heavy_minus_sign:                                                                                                                       | Model to use for completion                                                                                                              |                                                                                                                                          |
| `frequency_penalty`                                                                                                                      | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Frequency penalty (-2.0 to 2.0)                                                                                                          |                                                                                                                                          |
| `logit_bias`                                                                                                                             | Dict[str, *float*]                                                                                                                       | :heavy_minus_sign:                                                                                                                       | Token logit bias adjustments                                                                                                             |                                                                                                                                          |
| `logprobs`                                                                                                                               | *OptionalNullable[bool]*                                                                                                                 | :heavy_minus_sign:                                                                                                                       | Return log probabilities                                                                                                                 |                                                                                                                                          |
| `top_logprobs`                                                                                                                           | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Number of top log probabilities to return (0-20)                                                                                         |                                                                                                                                          |
| `max_completion_tokens`                                                                                                                  | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Maximum tokens in completion                                                                                                             |                                                                                                                                          |
| `max_tokens`                                                                                                                             | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Maximum tokens (deprecated, use max_completion_tokens)                                                                                   |                                                                                                                                          |
| `metadata`                                                                                                                               | Dict[str, *str*]                                                                                                                         | :heavy_minus_sign:                                                                                                                       | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values)                                          |                                                                                                                                          |
| `presence_penalty`                                                                                                                       | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Presence penalty (-2.0 to 2.0)                                                                                                           |                                                                                                                                          |
| `reasoning`                                                                                                                              | [OptionalNullable[models.ChatStreamCompletionCreateParamsReasoning]](../models/chatstreamcompletioncreateparamsreasoning.md)             | :heavy_minus_sign:                                                                                                                       | Reasoning configuration                                                                                                                  |                                                                                                                                          |
| `response_format`                                                                                                                        | [Optional[models.ChatStreamCompletionCreateParamsResponseFormatUnion]](../models/chatstreamcompletioncreateparamsresponseformatunion.md) | :heavy_minus_sign:                                                                                                                       | Response format configuration                                                                                                            |                                                                                                                                          |
| `seed`                                                                                                                                   | *OptionalNullable[int]*                                                                                                                  | :heavy_minus_sign:                                                                                                                       | Random seed for deterministic outputs                                                                                                    |                                                                                                                                          |
| `stop`                                                                                                                                   | [OptionalNullable[models.ChatStreamCompletionCreateParamsStop]](../models/chatstreamcompletioncreateparamsstop.md)                       | :heavy_minus_sign:                                                                                                                       | Stop sequences (up to 4)                                                                                                                 |                                                                                                                                          |
| `stream`                                                                                                                                 | *Optional[bool]*                                                                                                                         | :heavy_minus_sign:                                                                                                                       | Enable streaming response                                                                                                                |                                                                                                                                          |
| `stream_options`                                                                                                                         | [OptionalNullable[models.ChatStreamCompletionCreateParamsStreamOptions]](../models/chatstreamcompletioncreateparamsstreamoptions.md)     | :heavy_minus_sign:                                                                                                                       | N/A                                                                                                                                      |                                                                                                                                          |
| `temperature`                                                                                                                            | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Sampling temperature (0-2)                                                                                                               |                                                                                                                                          |
| `tool_choice`                                                                                                                            | [Optional[models.ChatCompletionToolChoiceOption]](../models/chatcompletiontoolchoiceoption.md)                                           | :heavy_minus_sign:                                                                                                                       | Tool choice configuration                                                                                                                |                                                                                                                                          |
| `tools`                                                                                                                                  | List[[models.ChatCompletionTool](../models/chatcompletiontool.md)]                                                                       | :heavy_minus_sign:                                                                                                                       | Available tools for function calling                                                                                                     |                                                                                                                                          |
| `top_p`                                                                                                                                  | *OptionalNullable[float]*                                                                                                                | :heavy_minus_sign:                                                                                                                       | Nucleus sampling parameter (0-1)                                                                                                         |                                                                                                                                          |
| `user`                                                                                                                                   | *Optional[str]*                                                                                                                          | :heavy_minus_sign:                                                                                                                       | Unique user identifier                                                                                                                   |                                                                                                                                          |
| `models_llm`                                                                                                                             | List[*str*]                                                                                                                              | :heavy_minus_sign:                                                                                                                       | Order of models to fallback to for this request                                                                                          |                                                                                                                                          |
| `reasoning_effort`                                                                                                                       | [OptionalNullable[models.ChatStreamCompletionCreateParamsReasoningEffort]](../models/chatstreamcompletioncreateparamsreasoningeffort.md) | :heavy_minus_sign:                                                                                                                       | Reasoning effort                                                                                                                         |                                                                                                                                          |
| `provider`                                                                                                                               | [OptionalNullable[models.ChatStreamCompletionCreateParamsProvider]](../models/chatstreamcompletioncreateparamsprovider.md)               | :heavy_minus_sign:                                                                                                                       | When multiple model providers are available, optionally indicate your routing preference.                                                |                                                                                                                                          |
| `plugins`                                                                                                                                | List[[models.ChatStreamCompletionCreateParamsPluginUnion](../models/chatstreamcompletioncreateparamspluginunion.md)]                     | :heavy_minus_sign:                                                                                                                       | Plugins you want to enable for this request, including their settings.                                                                   |                                                                                                                                          |