o c۷iC@sddlmZddlmZmZddlmZddlmZddl m Z ddl m Z m Z mZmZddlmZmZddlmZmZmZGd d d eeZGd d d eeZGd ddeZGdddeZGddde eeZGdddeeeefZdS))Enum)AnyGeneric)Field) MistralBase)BaseCompletionRequest)_check_openai_fields_names_is_openai_field_nameconvert_openai_messagesconvert_openai_tools) ChatMessageChatMessageType)Tool ToolChoiceToolTypec@eZdZdZdZdZdS)ResponseFormatszEnum of the different formats of an instruct response. Attributes: text: The response is a plain text. json: The response is a JSON object. Examples: >>> response_format = ResponseFormats.text text json_objectN)__name__ __module__ __qualname____doc__rjsonrr^/home/ubuntu/vllm_env/lib/python3.10/site-packages/mistral_common/protocol/instruct/request.pyrs rc@r)ReasoningEffortzControls how much reasoning effort the model should apply. Attributes: none: No additional reasoning effort. high: High reasoning effort for complex tasks. nonehighN)rrrrrrrrrrr$src@s\eZdZUdZdZedBed<ed ddZde e e ffddZ e d e ddfd d ZdS) ModelSettingsaModel configuration settings for instruct requests. This class encapsulates various model configuration options that can be passed to the model during inference. Currently supports reasoning effort configuration, but can be extended with additional settings in the future. Attributes: reasoning_effort: Controls how much reasoning effort the model should apply when generating responses. Supported for tokenizer >= v15 and not supported for earlier versions. Nreasoning_effortreturncCstS)z;Create a ModelSettings instance with default (None) values.)rrrrrr>szModelSettings.nonecCs |jddS)z@Convert ModelSettings to OpenAI API format with non-None values.T) exclude_none) model_dump)selfrrr to_openaiCs zModelSettings.to_openaikwargscKs t|S)z5Create ModelSettings from OpenAI keywords API format.)rmodel_validate)clsr&rrr from_openaiGs zModelSettings.from_openai)r!r)rrrrr r__annotations__ staticmethodrdictstrrr% classmethodr)rrrrr0s   rc@s eZdZUdZejZeed<dS)ResponseFormatzThe format of the response. Attributes: type: The type of the response. Examples: >>> response_format = ResponseFormat(type=ResponseFormats.text) typeN)rrrrrrr0r*rrrrr/Ms  r/c@seZdZUdZdZedBed<eeed<e e dZ e ed<dZ ee dBed<ejZeed<d Zeed <d Zeed <dZedBed <d edeeeeeefffddZe  ddeeeeeeeeeeefBfBfdeeeefdBd ed eddf ddZdS)ChatCompletionRequestaRequest for a chat completion. Attributes: model: The model to use for the chat completion. messages: The messages to use for the chat completion. response_format: The format of the response. tools: The tools to use for the chat completion. tool_choice: The tool choice to use for the chat completion. truncate_for_context_length: Whether to truncate the messages for the context length. continue_final_message: Whether to continue the final message. reasoning_effort: Controls how much reasoning effort the model should apply. Examples: >>> from mistral_common.protocol.instruct.messages import UserMessage, AssistantMessage >>> from mistral_common.protocol.instruct.tool_calls import ToolTypes, Function >>> request = ChatCompletionRequest( ... messages=[ ... UserMessage(content="Hello!"), ... AssistantMessage(content="Hi! How can I help you?"), ... ], ... response_format=ResponseFormat(type=ResponseFormats.text), ... tools=[Tool(type=ToolTypes.function, function=Function(name="get_weather", parameters={}))], ... tool_choice=ToolChoice.auto, ... truncate_for_context_length=True, ... ) Nmodelmessagesdefault_factoryresponse_formattools tool_choiceFtruncate_for_context_lengthcontinue_final_messager r&r!cKs|jhddd}|dd}|dur||d<|jrtd|D]&}||vr-td||tjvr:td |d t|sFtd |d q g}|jD] }| | qL||d <|j duridd|j D|d<| ||S)a Convert the request messages and tools into the OpenAI format. Args: kwargs: Additional parameters to be added to the request. Returns: The request in the OpenAI format. Examples: >>> from mistral_common.protocol.instruct.messages import UserMessage >>> from mistral_common.protocol.instruct.tool_calls import Tool, Function >>> request = ChatCompletionRequest(messages=[UserMessage(content="Hello, how are you?")], temperature=0.15) >>> request.to_openai(stream=True) {'temperature': 0.15, 'top_p': 1.0, 'response_format': {'type': 'text'}, 'tool_choice': 'auto', 'continue_final_message': False, 'messages': [{'role': 'user', 'content': 'Hello, how are you?'}], 'stream': True} >>> request = ChatCompletionRequest(messages=[UserMessage(content="Hello, how are you?")], tools=[ ... Tool(function=Function( ... name="get_current_weather", ... description="Get the current weather in a given location", ... parameters={ ... "type": "object", ... "properties": { ... "location": { ... "type": "string", ... "description": "The city and state, e.g. San Francisco, CA", ... }, ... "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}, ... }, ... "required": ["location"], ... }, ... ), ... )]) >>> request.to_openai() {'temperature': 0.7, 'top_p': 1.0, 'response_format': {'type': 'text'}, 'tool_choice': 'auto', 'continue_final_message': False, 'messages': [{'role': 'user', 'content': 'Hello, how are you?'}], 'tools': [{'type': 'function', 'function': {'name': 'get_current_weather', 'description': 'Get the current weather in a given location', 'parameters': {'type': 'object', 'properties': {'location': {'type': 'string', 'description': 'The city and state, e.g. San Francisco, CA'}, 'unit': {'type': 'string', 'enum': ['celsius', 'fahrenheit']}}, 'required': ['location']}, 'strict': False}}]} >r7r3r9Texcluder" random_seedNseedzETruncating for context length is not implemented for OpenAI requests.Duplicate keyword argument: Keyword argument  is already set in the request.Invalid keyword argument: $, it should be an OpenAI field name.r3cSg|]}|qSrr%.0toolrrr z3ChatCompletionRequest.to_openai..r7) r#popr9NotImplementedError ValueErrorr1 model_fieldsr r3appendr%r7update)r$r&openai_requestr>kwargopenai_messagesmessagerrrr%s0%     zChatCompletionRequest.to_openaicKsd|vr d|vr td|ddp|dd}tt|jt|t|}|dur2t|nd}|d||||d|S)aCreate a chat completion request from the OpenAI format. Args: messages: The messages in the OpenAI format. tools: The tools in the OpenAI format. continue_final_message: Whether to continue the final message. **kwargs: Additional keyword arguments to pass to the constructor. These should be the same as the fields of the request class or the OpenAI API equivalent. Returns: The chat completion request. r>r=z-Cannot specify both `seed` and `random_seed`.N)r3r7r=r:r)rMrKrsetrNkeysr r )r(r3r7r:r&r=converted_messagesconverted_toolsrrrr)sz!ChatCompletionRequest.from_openaiNF)rrrrr2r-r*listr rr/r6r7rrautor8r9boolr:r rrr,r%r.r)rrrrr1Zs2    &I*r1c@seZdZUdZeeed<dZedBed<dZ ee dBed<dZ e dBed<dZ eed<eejd Zeed <d ed eeeeeefffd dZe  ddeeeeeeeeeeefBfBfdeeeefdBded ed df ddZdS)InstructRequestaA valid Instruct request to be tokenized. Attributes: messages: The history of the conversation. system_prompt: The system prompt to be used for the conversation. available_tools: The tools available to the assistant. truncate_at_max_tokens: The maximum number of tokens to truncate the conversation at. continue_final_message: Whether to continue the final message. settings: Model configuration settings for the request. Examples: >>> from mistral_common.protocol.instruct.messages import UserMessage, SystemMessage >>> request = InstructRequest( ... messages=[UserMessage(content="Hello, how are you?")], system_prompt="You are a helpful assistant." ... ) r3N system_promptavailable_toolstruncate_at_max_tokensFr:r4settingsr&r!cKs|jhddd}|D]&}||vrtd||tjvr%td|dt|s1td|dq g}|jd urB|d |jd |jD] }||qE||d <|j d urbd d|j D|d<|j d urkt d| ||j di|j |S)aConvert the request messages and tools into the OpenAI format. Args: kwargs: Additional parameters to be added to the request. Returns: The request in the OpenAI format. Examples: >>> from mistral_common.protocol.instruct.messages import UserMessage >>> from mistral_common.protocol.instruct.tool_calls import Tool, Function >>> request = InstructRequest(messages=[UserMessage(content="Hello, how are you?")]) >>> request.to_openai(temperature=0.15, stream=True) {'continue_final_message': False, 'messages': [{'role': 'user', 'content': 'Hello, how are you?'}], 'temperature': 0.15, 'stream': True} >>> request = InstructRequest( ... messages=[UserMessage(content="Hello, how are you?")], ... available_tools=[ ... Tool(function=Function( ... name="get_current_weather", ... description="Get the current weather in a given location", ... parameters={ ... "type": "object", ... "properties": { ... "location": { ... "type": "string", ... "description": "The city and state, e.g. San Francisco, CA", ... }, ... "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}, ... }, ... "required": ["location"], ... }, ... ), ... )]) >>> request.to_openai() {'continue_final_message': False, 'messages': [{'role': 'user', 'content': 'Hello, how are you?'}], 'tools': [{'type': 'function', 'function': {'name': 'get_current_weather', 'description': 'Get the current weather in a given location', 'parameters': {'type': 'object', 'properties': {'location': {'type': 'string', 'description': 'The city and state, e.g. San Francisco, CA'}, 'unit': {'type': 'string', 'enum': ['celsius', 'fahrenheit']}}, 'required': ['location']}, 'strict': False}}]} >r3rar_r`Tr;r?r@rArBrCNsystem)rolecontentr3cSrDrrErFrrrrIKrJz-InstructRequest.to_openai..r7z@Truncating at max tokens is not implemented for OpenAI requests.r)r#rMr]rNr r^rOr3r%r_r`rLrPra)r$r&rQrRrSrTrrrr% s0'      zInstructRequest.to_openair7c  sd|vr|dur|d}ntdtj|j}|s%Jd|B}t|t|t|}|dur>t |nd}tj d ifdd| D} fdd| D} |d |||| d| S) aCreate an instruct request from the OpenAI format. Args: messages: The messages in the OpenAI format. tools: The tools in the OpenAI format. continue_final_message: Whether to continue the final message. **kwargs: Additional keyword arguments to pass to the constructor. These should be the same as the fields of the request class or the OpenAI API equivalent. Returns: The instruct request. r_Nz2Cannot specify both `tools` and `available_tools`.zDModelSettings fields should not overlap with InstructRequest fields.csi|] \}}|vr||qSrrrGkvmodel_settings_fieldsrr }z/InstructRequest.from_openai..csi|] \}}|vr||qSrrrerhrrrj~rk)r3r_r:rar) rKrMrrNrV isdisjointrrUr r r)items) r(r3r7r:r&instruct_request_fields valid_fieldsrWrXmodel_settings other_kwargsrrhrr)Us.    "zInstructRequest.from_openairY)rrrrrZr r*r^r-r_rr`intr:r\rrrrarr,r%r.r)rrrrr]s.   &K*r]N)enumrtypingrrpydanticrmistral_common.basermistral_common.protocol.baser+mistral_common.protocol.instruct.convertersrr r r )mistral_common.protocol.instruct.messagesr r +mistral_common.protocol.instruct.tool_callsrrrr-rrrr/r1r]rrrrs