mistralai 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

mistralai/chat.py

@@ -16,10 +16,9 @@ class Chat(BaseSDK):
         *,
         model: Nullable[str],
         messages: Union[List[models.Messages], List[models.MessagesTypedDict]],
-        temperature: Optional[float] = 0.7,
+        temperature: OptionalNullable[float] = UNSET,
         top_p: Optional[float] = 1,
         max_tokens: OptionalNullable[int] = UNSET,
-        min_tokens: OptionalNullable[int] = UNSET,
         stream: Optional[bool] = False,
         stop: Optional[Union[models.Stop, models.StopTypedDict]] = None,
         random_seed: OptionalNullable[int] = UNSET,
@@ -35,6 +34,9 @@ class Chat(BaseSDK):
                 models.ChatCompletionRequestToolChoiceTypedDict,
             ]
         ] = None,
+        presence_penalty: Optional[float] = 0,
+        frequency_penalty: Optional[float] = 0,
+        n: OptionalNullable[int] = UNSET,
         safe_prompt: Optional[bool] = False,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -44,16 +46,18 @@ class Chat(BaseSDK):
 
         :param model: ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions.
         :param messages: The prompt(s) to generate completions for, encoded as a list of dict with role and content.
-        :param temperature: 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.
+        :param temperature: 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.
         :param top_p: 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.
         :param max_tokens: 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.
-        :param min_tokens: The minimum number of tokens to generate in the completion.
         :param stream: 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.
         :param stop: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
         :param random_seed: The seed to use for random sampling. If set, different calls will generate deterministic results.
         :param response_format:
         :param tools:
         :param tool_choice:
+        :param presence_penalty: 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.
+        :param frequency_penalty: 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.
+        :param n: Number of completions to return for each request, input tokens are only billed once.
         :param safe_prompt: Whether to inject a safety prompt before all conversations.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -72,7 +76,6 @@ class Chat(BaseSDK):
             temperature=temperature,
             top_p=top_p,
             max_tokens=max_tokens,
-            min_tokens=min_tokens,
             stream=stream,
             stop=stop,
             random_seed=random_seed,
@@ -84,6 +87,9 @@ class Chat(BaseSDK):
             tool_choice=utils.get_pydantic_model(
                 tool_choice, Optional[models.ChatCompletionRequestToolChoice]
             ),
+            presence_penalty=presence_penalty,
+            frequency_penalty=frequency_penalty,
+            n=n,
             safe_prompt=safe_prompt,
         )
 
@@ -135,15 +141,17 @@ class Chat(BaseSDK):
             data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
             raise models.HTTPValidationError(data=data)
         if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
             raise models.SDKError(
-                "API error occurred", http_res.status_code, http_res.text, http_res
+                "API error occurred", http_res.status_code, http_res_text, http_res
             )
 
         content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
         raise models.SDKError(
             f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
             http_res.status_code,
-            http_res.text,
+            http_res_text,
             http_res,
         )
 
@@ -152,10 +160,9 @@ class Chat(BaseSDK):
         *,
         model: Nullable[str],
         messages: Union[List[models.Messages], List[models.MessagesTypedDict]],
-        temperature: Optional[float] = 0.7,
+        temperature: OptionalNullable[float] = UNSET,
         top_p: Optional[float] = 1,
         max_tokens: OptionalNullable[int] = UNSET,
-        min_tokens: OptionalNullable[int] = UNSET,
         stream: Optional[bool] = False,
         stop: Optional[Union[models.Stop, models.StopTypedDict]] = None,
         random_seed: OptionalNullable[int] = UNSET,
@@ -171,6 +178,9 @@ class Chat(BaseSDK):
                 models.ChatCompletionRequestToolChoiceTypedDict,
             ]
         ] = None,
+        presence_penalty: Optional[float] = 0,
+        frequency_penalty: Optional[float] = 0,
+        n: OptionalNullable[int] = UNSET,
         safe_prompt: Optional[bool] = False,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -180,16 +190,18 @@ class Chat(BaseSDK):
 
         :param model: ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions.
         :param messages: The prompt(s) to generate completions for, encoded as a list of dict with role and content.
-        :param temperature: 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.
+        :param temperature: 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.
         :param top_p: 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.
         :param max_tokens: 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.
-        :param min_tokens: The minimum number of tokens to generate in the completion.
         :param stream: 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.
         :param stop: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
         :param random_seed: The seed to use for random sampling. If set, different calls will generate deterministic results.
         :param response_format:
         :param tools:
         :param tool_choice:
+        :param presence_penalty: 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.
+        :param frequency_penalty: 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.
+        :param n: Number of completions to return for each request, input tokens are only billed once.
         :param safe_prompt: Whether to inject a safety prompt before all conversations.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -208,7 +220,6 @@ class Chat(BaseSDK):
             temperature=temperature,
             top_p=top_p,
             max_tokens=max_tokens,
-            min_tokens=min_tokens,
             stream=stream,
             stop=stop,
             random_seed=random_seed,
@@ -220,6 +231,9 @@ class Chat(BaseSDK):
             tool_choice=utils.get_pydantic_model(
                 tool_choice, Optional[models.ChatCompletionRequestToolChoice]
             ),
+            presence_penalty=presence_penalty,
+            frequency_penalty=frequency_penalty,
+            n=n,
             safe_prompt=safe_prompt,
         )
 
@@ -271,15 +285,17 @@ class Chat(BaseSDK):
             data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
             raise models.HTTPValidationError(data=data)
         if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
             raise models.SDKError(
-                "API error occurred", http_res.status_code, http_res.text, http_res
+                "API error occurred", http_res.status_code, http_res_text, http_res
             )
 
         content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
         raise models.SDKError(
             f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
             http_res.status_code,
-            http_res.text,
+            http_res_text,
             http_res,
         )
 
@@ -291,10 +307,9 @@ class Chat(BaseSDK):
             List[models.ChatCompletionStreamRequestMessages],
             List[models.ChatCompletionStreamRequestMessagesTypedDict],
         ],
-        temperature: Optional[float] = 0.7,
+        temperature: OptionalNullable[float] = UNSET,
         top_p: Optional[float] = 1,
         max_tokens: OptionalNullable[int] = UNSET,
-        min_tokens: OptionalNullable[int] = UNSET,
         stream: Optional[bool] = True,
         stop: Optional[
             Union[
@@ -315,6 +330,9 @@ class Chat(BaseSDK):
                 models.ChatCompletionStreamRequestToolChoiceTypedDict,
             ]
         ] = None,
+        presence_penalty: Optional[float] = 0,
+        frequency_penalty: Optional[float] = 0,
+        n: OptionalNullable[int] = UNSET,
         safe_prompt: Optional[bool] = False,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -326,16 +344,18 @@ class Chat(BaseSDK):
 
         :param model: ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions.
         :param messages: The prompt(s) to generate completions for, encoded as a list of dict with role and content.
-        :param temperature: 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.
+        :param temperature: 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.
         :param top_p: 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.
         :param max_tokens: 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.
-        :param min_tokens: The minimum number of tokens to generate in the completion.
         :param stream:
         :param stop: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
         :param random_seed: The seed to use for random sampling. If set, different calls will generate deterministic results.
         :param response_format:
         :param tools:
         :param tool_choice:
+        :param presence_penalty: 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.
+        :param frequency_penalty: 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.
+        :param n: Number of completions to return for each request, input tokens are only billed once.
         :param safe_prompt: Whether to inject a safety prompt before all conversations.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -354,7 +374,6 @@ class Chat(BaseSDK):
             temperature=temperature,
             top_p=top_p,
             max_tokens=max_tokens,
-            min_tokens=min_tokens,
             stream=stream,
             stop=stop,
             random_seed=random_seed,
@@ -368,6 +387,9 @@ class Chat(BaseSDK):
             tool_choice=utils.get_pydantic_model(
                 tool_choice, Optional[models.ChatCompletionStreamRequestToolChoice]
             ),
+            presence_penalty=presence_penalty,
+            frequency_penalty=frequency_penalty,
+            n=n,
             safe_prompt=safe_prompt,
         )
 
@@ -419,18 +441,21 @@ class Chat(BaseSDK):
                 sentinel="[DONE]",
             )
         if utils.match_response(http_res, "422", "application/json"):
-            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            http_res_text = utils.stream_to_text(http_res)
+            data = utils.unmarshal_json(http_res_text, models.HTTPValidationErrorData)
             raise models.HTTPValidationError(data=data)
         if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
             raise models.SDKError(
-                "API error occurred", http_res.status_code, http_res.text, http_res
+                "API error occurred", http_res.status_code, http_res_text, http_res
             )
 
         content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
         raise models.SDKError(
             f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
             http_res.status_code,
-            http_res.text,
+            http_res_text,
             http_res,
         )
 
@@ -442,10 +467,9 @@ class Chat(BaseSDK):
             List[models.ChatCompletionStreamRequestMessages],
             List[models.ChatCompletionStreamRequestMessagesTypedDict],
         ],
-        temperature: Optional[float] = 0.7,
+        temperature: OptionalNullable[float] = UNSET,
         top_p: Optional[float] = 1,
         max_tokens: OptionalNullable[int] = UNSET,
-        min_tokens: OptionalNullable[int] = UNSET,
         stream: Optional[bool] = True,
         stop: Optional[
             Union[
@@ -466,6 +490,9 @@ class Chat(BaseSDK):
                 models.ChatCompletionStreamRequestToolChoiceTypedDict,
             ]
         ] = None,
+        presence_penalty: Optional[float] = 0,
+        frequency_penalty: Optional[float] = 0,
+        n: OptionalNullable[int] = UNSET,
         safe_prompt: Optional[bool] = False,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -477,16 +504,18 @@ class Chat(BaseSDK):
 
         :param model: ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions.
         :param messages: The prompt(s) to generate completions for, encoded as a list of dict with role and content.
-        :param temperature: 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.
+        :param temperature: 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.
         :param top_p: 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.
         :param max_tokens: 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.
-        :param min_tokens: The minimum number of tokens to generate in the completion.
         :param stream:
         :param stop: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
         :param random_seed: The seed to use for random sampling. If set, different calls will generate deterministic results.
         :param response_format:
         :param tools:
         :param tool_choice:
+        :param presence_penalty: 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.
+        :param frequency_penalty: 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.
+        :param n: Number of completions to return for each request, input tokens are only billed once.
         :param safe_prompt: Whether to inject a safety prompt before all conversations.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -505,7 +534,6 @@ class Chat(BaseSDK):
             temperature=temperature,
             top_p=top_p,
             max_tokens=max_tokens,
-            min_tokens=min_tokens,
             stream=stream,
             stop=stop,
             random_seed=random_seed,
@@ -519,6 +547,9 @@ class Chat(BaseSDK):
             tool_choice=utils.get_pydantic_model(
                 tool_choice, Optional[models.ChatCompletionStreamRequestToolChoice]
             ),
+            presence_penalty=presence_penalty,
+            frequency_penalty=frequency_penalty,
+            n=n,
             safe_prompt=safe_prompt,
         )
 
@@ -570,17 +601,20 @@ class Chat(BaseSDK):
                 sentinel="[DONE]",
             )
         if utils.match_response(http_res, "422", "application/json"):
-            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            http_res_text = await utils.stream_to_text_async(http_res)
+            data = utils.unmarshal_json(http_res_text, models.HTTPValidationErrorData)
             raise models.HTTPValidationError(data=data)
         if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
             raise models.SDKError(
-                "API error occurred", http_res.status_code, http_res.text, http_res
+                "API error occurred", http_res.status_code, http_res_text, http_res
             )
 
         content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
         raise models.SDKError(
             f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
             http_res.status_code,
-            http_res.text,
+            http_res_text,
             http_res,
         )