from letta.errors import LLMJSONParsingError from letta.helpers.json_helpers import json_dumps, json_loads from letta.local_llm.json_parser import clean_json from letta.local_llm.llm_chat_completion_wrappers.wrapper_base import LLMChatCompletionWrapper from letta.schemas.enums import MessageRole PREFIX_HINT = """# Reminders: # Important information about yourself and the user is stored in (limited) core memory # You can modify core memory with core_memory_replace # You can add to core memory with core_memory_append # Less important information is stored in (unlimited) archival memory # You can add to archival memory with archival_memory_insert # You can search archival memory with archival_memory_search # You will always see the statistics of archival memory, so you know if there is content inside it # If you receive new important information about the user (or yourself), you immediately update your memory with core_memory_replace, core_memory_append, or archival_memory_insert""" FIRST_PREFIX_HINT = """# Reminders: # This is your first interaction with the user! # Initial information about them is provided in the core memory user block # Make sure to introduce yourself to them # Your inner thoughts should be private, interesting, and creative # Do NOT use inner thoughts to communicate with the user # Use send_message to communicate with the user""" # Don't forget to use send_message, otherwise the user won't see your message""" class ChatMLInnerMonologueWrapper(LLMChatCompletionWrapper): """ChatML-style prompt formatter, tested for use with https://huggingface.co/ehartford/dolphin-2.5-mixtral-8x7b#training""" supports_first_message = True def __init__( self, json_indent=2, # simplify_json_content=True, simplify_json_content=False, clean_function_args=True, include_assistant_prefix=True, assistant_prefix_extra='\n{\n "function":', assistant_prefix_extra_first_message='\n{\n "function": "send_message",', allow_custom_roles=True, # allow roles outside user/assistant use_system_role_in_user=False, # use the system role on user messages that don't use "type: user_message" # allow_function_role=True, # use function role for function replies? allow_function_role=False, # use function role for function replies? no_function_role_role="assistant", # if no function role, which role to use? no_function_role_prefix="FUNCTION RETURN:\n", # if no function role, what prefix to use? # add a guiding hint assistant_prefix_hint=False, ): self.simplify_json_content = simplify_json_content self.clean_func_args = clean_function_args self.include_assistant_prefix = include_assistant_prefix self.assistant_prefix_extra = assistant_prefix_extra self.assistant_prefix_extra_first_message = assistant_prefix_extra_first_message self.assistant_prefix_hint = assistant_prefix_hint # role-based self.allow_custom_roles = allow_custom_roles self.use_system_role_in_user = use_system_role_in_user self.allow_function_role = allow_function_role # extras for when the function role is disallowed self.no_function_role_role = no_function_role_role self.no_function_role_prefix = no_function_role_prefix # how to set json in prompt self.json_indent = json_indent def _compile_function_description(self, schema, add_inner_thoughts=True) -> str: """Go from a JSON schema to a string description for a prompt""" # airorobos style func_str = "" func_str += f"{schema['name']}:" func_str += f"\n description: {schema['description']}" func_str += "\n params:" if add_inner_thoughts: from letta.local_llm.constants import INNER_THOUGHTS_KWARG, INNER_THOUGHTS_KWARG_DESCRIPTION func_str += f"\n {INNER_THOUGHTS_KWARG}: {INNER_THOUGHTS_KWARG_DESCRIPTION}" for param_k, param_v in schema["parameters"]["properties"].items(): # TODO we're ignoring type func_str += f"\n {param_k}: {param_v['description']}" # TODO we're ignoring schema['parameters']['required'] return func_str def _compile_function_block(self, functions) -> str: """functions dict -> string describing functions choices""" prompt = "" # prompt += f"\nPlease select the most suitable function and parameters from the list of available functions below, based on the user's input. Provide your response in JSON format." prompt += "Please select the most suitable function and parameters from the list of available functions below, based on the ongoing conversation. Provide your response in JSON format." prompt += "\nAvailable functions:" for function_dict in functions: prompt += f"\n{self._compile_function_description(function_dict)}" return prompt # NOTE: BOS/EOS chatml tokens are NOT inserted here def _compile_system_message(self, system_message, functions, function_documentation=None) -> str: """system prompt + memory + functions -> string""" prompt = "" prompt += system_message prompt += "\n" if function_documentation is not None: prompt += "Please select the most suitable function and parameters from the list of available functions below, based on the ongoing conversation. Provide your response in JSON format." prompt += "\nAvailable functions:\n" prompt += function_documentation else: prompt += self._compile_function_block(functions) return prompt def _compile_function_call(self, function_call, inner_thoughts=None): """Go from ChatCompletion to Airoboros style function trace (in prompt) ChatCompletion data (inside message['function_call']): "function_call": { "name": ... "arguments": { "arg1": val1, ... } Airoboros output: { "function": "send_message", "params": { "message": "Hello there! I am Sam, an AI developed by Liminal Corp. How can I assist you today?" } } """ airo_func_call = { "function": function_call["name"], "params": { "inner_thoughts": inner_thoughts, **json_loads(function_call["arguments"]), }, } return json_dumps(airo_func_call, indent=self.json_indent) # NOTE: BOS/EOS chatml tokens are NOT inserted here def _compile_assistant_message(self, message) -> str: """assistant message -> string""" prompt = "" # need to add the function call if there was one inner_thoughts = message["content"] if message.get("function_call"): prompt += f"\n{self._compile_function_call(message['function_call'], inner_thoughts=inner_thoughts)}" elif message.get("tool_calls"): for tool_call in message["tool_calls"]: prompt += f"\n{self._compile_function_call(tool_call['function'], inner_thoughts=inner_thoughts)}" else: # TODO should we format this into JSON somehow? prompt += inner_thoughts return prompt # NOTE: BOS/EOS chatml tokens are NOT inserted here def _compile_user_message(self, message) -> str: """user message (should be JSON) -> string""" prompt = "" if self.simplify_json_content: # Make user messages not JSON but plaintext instead try: user_msg_json = json_loads(message["content"]) user_msg_str = user_msg_json["message"] except Exception: user_msg_str = message["content"] else: # Otherwise just dump the full json try: user_msg_json = json_loads(message["content"]) user_msg_str = json_dumps(user_msg_json, indent=self.json_indent) except Exception: user_msg_str = message["content"] prompt += user_msg_str return prompt # NOTE: BOS/EOS chatml tokens are NOT inserted here def _compile_function_response(self, message) -> str: """function response message (should be JSON) -> string""" # TODO we should clean up send_message returns to avoid cluttering the prompt prompt = "" try: # indent the function replies function_return_dict = json_loads(message["content"]) function_return_str = json_dumps(function_return_dict, indent=0) except Exception: function_return_str = message["content"] prompt += function_return_str return prompt def chat_completion_to_prompt(self, messages, functions, first_message=False, function_documentation=None): """chatml-style prompt formatting, with implied support for multi-role""" prompt = "" # System insturctions go first assert messages[0]["role"] == "system" system_block = self._compile_system_message( system_message=messages[0]["content"], functions=functions, function_documentation=function_documentation ) prompt += f"<|im_start|>system\n{system_block.strip()}<|im_end|>" # Last are the user/assistant messages for message in messages[1:]: # check that message["role"] is a valid option for MessageRole # TODO: this shouldn't be necessary if we use pydantic in the future assert message["role"] in [role.value for role in MessageRole] if message["role"] == "user": # Support for AutoGen naming of agents role_str = message["name"].strip().lower() if (self.allow_custom_roles and "name" in message) else message["role"] msg_str = self._compile_user_message(message) if self.use_system_role_in_user: try: msg_json = json_loads(message["content"]) if msg_json["type"] != "user_message": role_str = "system" except Exception: pass prompt += f"\n<|im_start|>{role_str}\n{msg_str.strip()}<|im_end|>" elif message["role"] == "assistant": # Support for AutoGen naming of agents role_str = message["name"].strip().lower() if (self.allow_custom_roles and "name" in message) else message["role"] msg_str = self._compile_assistant_message(message) prompt += f"\n<|im_start|>{role_str}\n{msg_str.strip()}<|im_end|>" elif message["role"] == "system": role_str = "system" msg_str = self._compile_system_message( system_message=message["content"], functions=functions, function_documentation=function_documentation ) prompt += f"\n<|im_start|>{role_str}\n{msg_str.strip()}<|im_end|>" elif message["role"] in ["tool", "function"]: if self.allow_function_role: role_str = message["role"] msg_str = self._compile_function_response(message) prompt += f"\n<|im_start|>{role_str}\n{msg_str.strip()}<|im_end|>" else: # TODO figure out what to do with functions if we disallow function role role_str = self.no_function_role_role msg_str = self._compile_function_response(message) func_resp_prefix = self.no_function_role_prefix # NOTE whatever the special prefix is, it should also be a stop token prompt += f"\n<|im_start|>{role_str}\n{func_resp_prefix}{msg_str.strip()}<|im_end|>" else: raise ValueError(message) if self.include_assistant_prefix: prompt += "\n<|im_start|>assistant" if self.assistant_prefix_hint: prompt += f"\n{FIRST_PREFIX_HINT if first_message else PREFIX_HINT}" if self.supports_first_message and first_message: if self.assistant_prefix_extra_first_message: prompt += self.assistant_prefix_extra_first_message else: if self.assistant_prefix_extra: # assistant_prefix_extra='\n{\n "function":', prompt += self.assistant_prefix_extra return prompt def _clean_function_args(self, function_name, function_args): """Some basic Letta-specific cleaning of function args""" cleaned_function_name = function_name cleaned_function_args = function_args.copy() if function_args is not None else {} if function_name == "send_message": # strip request_heartbeat cleaned_function_args.pop("request_heartbeat", None) inner_thoughts = None if "inner_thoughts" in function_args: inner_thoughts = cleaned_function_args.pop("inner_thoughts") # TODO more cleaning to fix errors LLM makes return inner_thoughts, cleaned_function_name, cleaned_function_args def output_to_chat_completion_response(self, raw_llm_output, first_message=False): """Turn raw LLM output into a ChatCompletion style response with: "message" = { "role": "assistant", "content": ..., "function_call": { "name": ... "arguments": { "arg1": val1, ... } } } """ # if self.include_opening_brance_in_prefix and raw_llm_output[0] != "{": # raw_llm_output = "{" + raw_llm_output assistant_prefix = self.assistant_prefix_extra_first_message if first_message else self.assistant_prefix_extra if assistant_prefix and raw_llm_output[: len(assistant_prefix)] != assistant_prefix: # print(f"adding prefix back to llm, raw_llm_output=\n{raw_llm_output}") raw_llm_output = assistant_prefix + raw_llm_output # print(f"->\n{raw_llm_output}") try: function_json_output = clean_json(raw_llm_output) except Exception as e: raise Exception(f"Failed to decode JSON from LLM output:\n{raw_llm_output} - error\n{str(e)}") try: # NOTE: weird bug can happen where 'function' gets nested if the prefix in the prompt isn't abided by if isinstance(function_json_output["function"], dict): function_json_output = function_json_output["function"] # regular unpacking function_name = function_json_output["function"] function_parameters = function_json_output["params"] except KeyError as e: raise LLMJSONParsingError( f"Received valid JSON from LLM, but JSON was missing fields: {str(e)}. JSON result was:\n{function_json_output}" ) if self.clean_func_args: ( inner_thoughts, function_name, function_parameters, ) = self._clean_function_args(function_name, function_parameters) message = { "role": "assistant", "content": inner_thoughts, "function_call": { "name": function_name, "arguments": json_dumps(function_parameters), }, } return message class ChatMLOuterInnerMonologueWrapper(ChatMLInnerMonologueWrapper): """Moves the inner monologue outside the main function to allow the LLM to omit function calls NOTE: warning - this makes it easier for the agent to forget to call functions, so it is advised to use the function-forcing wrapper unless the LLM is very good ie instead of: { "function": "send_message", "params": { "inner_thoughts": "User has repeated the message. Recognizing repetition and taking a different approach.", "message": "It looks like you're repeating yourself, Chad. Is there something you're trying to express, or are you just testing me?" } } this wrapper does: { "inner_thoughts": "User has repeated the message. Recognizing repetition and taking a different approach.", "function": "send_message", "params": { "message": "It looks like you're repeating yourself, Chad. Is there something you're trying to express, or are you just testing me?" } } """ # TODO find a way to support forcing the first func call supports_first_message = False def __init__(self, **kwargs): # Set a different default for assistant_prefix_extra if not provided kwargs.setdefault("assistant_prefix_extra", '\n{\n "inner_thoughts":') super().__init__(**kwargs) def _compile_function_block(self, functions) -> str: """NOTE: modified to not include inner thoughts at all as extras""" prompt = "" prompt += " ".join( [ "Please select the most suitable function and parameters from the list of available functions below, based on the ongoing conversation.", "Provide your response in JSON format.", "You must always include inner thoughts, but you do not always have to call a function.", ] ) prompt += "\nAvailable functions:" for function_dict in functions: prompt += f"\n{self._compile_function_description(function_dict, add_inner_thoughts=False)}" return prompt def _compile_function_call(self, function_call, inner_thoughts=None): """NOTE: Modified to put inner thoughts outside the function""" airo_func_call = { "inner_thoughts": inner_thoughts, "function": function_call["name"], "params": { # "inner_thoughts": inner_thoughts, **json_loads(function_call["arguments"]), }, } return json_dumps(airo_func_call, indent=self.json_indent) def output_to_chat_completion_response(self, raw_llm_output, first_message=False): """NOTE: Modified to expect "inner_thoughts" outside the function Also, allow messages that have None/null function calls """ # If we used a prefex to guide generation, we need to add it to the output as a preefix assistant_prefix = ( self.assistant_prefix_extra_first_message if (self.supports_first_message and first_message) else self.assistant_prefix_extra ) if assistant_prefix and raw_llm_output[: len(assistant_prefix)] != assistant_prefix: raw_llm_output = assistant_prefix + raw_llm_output try: function_json_output = clean_json(raw_llm_output) except Exception as e: raise Exception(f"Failed to decode JSON from LLM output:\n{raw_llm_output} - error\n{str(e)}") try: # NOTE: main diff inner_thoughts = function_json_output["inner_thoughts"] # NOTE: also have to account for "function": null if ( "function" in function_json_output and function_json_output["function"] is not None and function_json_output["function"].strip().lower() != "none" ): # TODO apply lm studio nested bug patch? function_name = function_json_output["function"] function_parameters = function_json_output["params"] else: function_name = None function_parameters = None except KeyError as e: raise LLMJSONParsingError(f"Received valid JSON from LLM, but JSON was missing fields: {str(e)}") # TODO add some code to clean inner thoughts # e.g. fix this: """ 💭 I sense a new mind to engage with. Interesting... 🤖 Hello, I'm Sam. Welcome to our conversation. > Enter your message: what do you know about me? 💭 : I've been observing our previous conversations. I remember that your name is Chad. 🤖 I recall our previous interactions, Chad. How can I assist you today? > Enter your message: is that all you know about me? 💭 : I see you're curious about our connection. Let me do a quick search of my memory. """ if function_name is not None and self.clean_func_args: ( _inner_thoughts, # NOTE: main diff (ignore) function_name, function_parameters, ) = self._clean_function_args(function_name, function_parameters) message = { "role": "assistant", "content": inner_thoughts, # "function_call": { # "name": function_name, # "arguments": json_dumps(function_parameters), # }, } # Add the function if not none: if function_name is not None: message["function_call"] = { "name": function_name, "arguments": json_dumps(function_parameters), } return message