:i:SSKJr SSKJrJr SSKJr SSKJr SSK J r SSK J r J r JrJr SSKJrJr SSKJrJrJr "S S \\5r"S S \5r"S S\ \\5r"SS\\\\45rg))Enum)AnyGeneric)Field) MistralBase)BaseCompletionRequest)_check_openai_fields_names_is_openai_field_nameconvert_openai_messagesconvert_openai_tools) ChatMessageChatMessageType)Tool ToolChoiceToolTypec \rSrSrSrSrSrSrg)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____firstlineno____doc__rjson__static_attributes__rb/home/james-whalen/.local/lib/python3.13/site-packages/mistral_common/protocol/instruct/request.pyrrs D Drrc<\rSrSr%Sr\R r\\S'Sr g)ResponseFormat$zThe format of the response. Attributes: type: The type of the response. Examples: >>> response_format = ResponseFormat(type=ResponseFormats.text) typerN) rrrrrrrr$__annotations__rrrr r"r"$s,00D/0rr"cT\rSrSr%SrSr\S-\S'\\ \S'\ "\ S9r \ \S'Sr \\S-\S'\R r\\S 'S r\\S 'S r\\S 'S \S\\\\\\444Sjr\SS\\\\\\\\\\\4-4-4S\\\\4S-S \S \SS4 Sjj5rSrg)ChatCompletionRequest1aoRequest 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. 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, ... ) Nmodelmessages)default_factoryresponse_formattools tool_choiceFtruncate_for_context_lengthcontinue_final_messagekwargsreturnc `UR1SkSS9nURSS5nUbX2S'UR(a [S5eUHXnXB;a[ SU35eU[ R ;a[ S US 35e[U5(aMK[ S US 35e /nURH"nURUR55 M$ XRS 'URb-URVs/sHowR5PM snUS'URU5 U$s snf)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 = 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']}}}]} >r-r*r/Texclude exclude_none 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.r*r-) model_dumppopr/NotImplementedError ValueErrorr' model_fieldsr r*append to_openair-update)selfr1openai_requestr8kwargopenai_messagesmessagetools r rDChatCompletionRequest.to_openaiTs<J*.HW[*9*  !!-6  %)6 "  + +%&mn nE& #?w!GHH/<<< #4UG;Z![\\*511 #=eWDh!ijj}}G  " "7#4#4#6 7%&5z" :: !DHJJ&OJD~~'7J&ON7 #f% 'Ps9D+c ^SU;aSU;a [S5eURSS5=(d URSS5n[[URR 55[UR 555 [ U5nUb [U5OSnU"SUUUUS.UD6$)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. r8r7z-Cannot specify both `seed` and `random_seed`.N)r*r-r7r0r)rAr?r setrBkeysr r )clsr*r-r0r1r7converted_messagesconverted_toolss r from_openai!ChatCompletionRequest.from_openais* V   7LM Mjj.Q&**]D2Q "3s'7'7'<'<'>#?V[[]AST0G0Q9>9J.u5PT '!##9     rrNF)rrrrrr)strr%listrrr"r,r-rrautor.r/boolr0rdictrD classmethodrSrrrr r'r'1s$4E3:?##&+N&KO^K#E4: #(ooK-(--#(D(G#G$sDc3h4H/H*IGR.2', % tCtDcDcN6J1J,K'L!LLMN% DcN#d*% !% %  % ! % % rr'c"\rSrSr%Sr\\\S'Sr\ S-\S'Sr \\ S-\S'Sr \ S-\S'Sr\\S 'S \S \\ \\\ \444S jr\SS\\\ \ \\\ \ \\ \4-4-4S \\\ \4S-S \S \S S4 Sjj5rSrg)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. 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." ... ) r*N system_promptavailable_toolstruncate_at_max_tokensFr0r1r2c |UR1SkSS9nUHXnX2;a[SU35eU[R;a[SUS35e[ U5(aMK[SUS35e /nUR bUR S UR S .5 URH"nUR UR55 M$ XBS 'URb-URVs/sHofR5PM snUS 'URb [S 5eURU5 U$s snf)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']}}}]} >r*r`raTr4r9r:r;r<r=system)rolecontentr*r-z@Truncating at max tokens is not implemented for OpenAI requests.) r>rAr]rBr r_rCr*rDr`rar@rE)rFr1rGrHrIrJrKs r rDInstructRequest.to_openaisIN*.M\`*9* E& #?w!GHH/666 #4UG;Z![\\*511 #=eWDh!ijj13    )  " "HASAS#T U}}G  " "7#4#4#6 7%&5z"    +DHDXDX&YDXD~~'7DX&YN7 #  & & 2%&hi if%'Zs/D9r-c $SU;a UcURS5nO [S5e[[URR 55[UR 555 [ U5nUb [U5OSnU"SUUUS.UD6$)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`.)r*r`r0r)r?rAr rNrBrOr r )rPr*r-r0r1rQrRs r rSInstructRequest.from_openai's,  &} #45 !UVV"3s'7'7'<'<'>#?V[[]AST0G0Q9>9J.u5PT '+#9    rrrU)rrrrrrWrr%r_rVr`rraintr0rYrrZrDr[rSrrrr r]r]s  ?## $M3:$-1OT(^d*1)-C$J-#(D(H#H$sDc3h4H/H*IHT.2', & tCtDcDcN6J1J,K'L!LLMN& DcN#d*& !% &  &  & & rr]N)enumrtypingrrpydanticrmistral_common.basermistral_common.protocol.baser+mistral_common.protocol.instruct.convertersr r r r )mistral_common.protocol.instruct.messagesr r+mistral_common.protocol.instruct.tool_callsrrrrVrr"r'r]rrr rrsw+> SR c4  1[ 1R 17?3KR jH k7?H+D#EH r