[Frontend] Adding the "User Defined Custom Tool Calling" parser for the Llama models

examples/tool_chat_template_llama3.1_usr_def_tool_call.jinja

@@ -0,0 +1,131 @@
+{{- bos_token }}
+{%- if custom_tools is defined %}
+    {%- set tools = custom_tools %}
+{%- endif %}
+{%- if not tools_in_user_message is defined %}
+    {%- set tools_in_user_message = false %}
+{%- endif %}
+{%- if not date_string is defined %}
+    {%- set date_string = "26 Jul 2024" %}
+{%- endif %}
+
+{#- This block extracts the system message, so we can slot it into the right place. #}
+{%- if messages[0]['role'] == 'system' %}
+    {%- set system_message = messages[0]['content']|trim %}
+    {%- set messages = messages[1:] %}
+{%- else %}
+    {%- set system_message = "" %}
+{%- endif %}
+
+{#- System message + builtin tools #}
+{{- "<|start_header_id|>system<|end_header_id|>\n\n" }}
+{%- if builtin_tools is defined or tools is not none %}
+    {{- "Environment: ipython\n" }}
+{%- endif %}
+{%- if builtin_tools is defined %}
+    {{- "Tools: " + builtin_tools | reject('equalto', 'code_interpreter') | join(", ") + "\n\n"}}
+{%- endif %}
+{{- "Cutting Knowledge Date: December 2023\n" }}
+{{- "Today Date: " + date_string + "\n\n" }}
+
+{%- if builtin_tools is defined %}
+    {{- "# Tool Instructions\n"}}
+    {{- "- Always execute python code in messages that you share.\n"}}
+    {{- "- When looking for real time information use relevant functions if available else fallback to brave_search\n\n\n"}}
+{%- endif %}
+
+{%- if tools is not none and not tools_in_user_message %}
+    {{- "You have access to the following functions:\n\n"}}
+
+    {%- for t in tools %}
+        {%- if t.function is defined %}
+                {%- set t = t.function %}
+        {%- endif -%}
+        {{- "Use the function '"+t.name+"' to: "+t.description+"\n"}}
+        {{- t | tojson(indent=4) }}
+        {{- "\n\n" }}
+    {%- endfor %}
+    {{- "If a you choose to call a function ONLY reply in the following format:\n"}}
+    {{- "<{start_tag}={function_name}>{parameters}{end_tag}\n" }}
+    {{- "where\n\n"}}
+    {{- "start_tag => `<function`\n" }}
+    {{- "parameters => a JSON dict with the function argument name as key and function argument value as value.\n"}}
+    {{- "end_tag => `</function>`" }}
+    {{- "\n\n" }}
+    {{- "Here is an example,\n"}}
+    {{- "<function=example_function_name>{\"example_name\": \"example_value\"}</function>"}}
+    {{- "\n\n"  }}
+    {{- "Reminder:\n"}}
+    {{- "- Function calls MUST follow the specified format\n"}}
+    {{- "- Required parameters MUST be specified\n"}}
+    {{- "- Only call one function at a time\n"}}
+    {{- "- Put the entire function call reply on one line\n"}}
+    {{- "- Always use the information returned by the function to answer to the user\n"}}
+    {{- "- If there is no relevant function available, do NOT call any function: respond directly to the user\n\n"}}
+
+{%- endif %}
+{{- system_message }}
+{{- "<|eot_id|>" }}
+
+{#- Custom tools are passed in a user message with some extra guidance #}
+{%- if tools_in_user_message and not tools is none %}
+    {#- Extract the first user message so we can plug it in here #}
+    {%- if messages | length != 0 %}
+        {%- set first_user_message = messages[0]['content']|trim %}
+        {%- set messages = messages[1:] %}
+    {%- else %}
+        {{- raise_exception("Cannot put tools in the first user message when there's no first user message!") }}
+{%- endif %}
+    {{- '<|start_header_id|>user<|end_header_id|>\n\n' -}}
+    {{- "Given the following functions, please respond with a JSON for a function call " }}
+    {{- "with its proper arguments that best answers the given prompt.\n\n" }}
+    {{- 'Respond in the format {"name": function name, "parameters": dictionary of argument name and its value}.' }}
+    {{- "Do not use variables.\n\n" }}
+    {%- for t in tools %}
+        {{- t | tojson }}
+        {{- "\n\n" }}
+    {%- endfor %}
+    {{- first_user_message + "<|eot_id|>"}}
+{%- endif %}
+
+{%- for message in messages %}
+    {%- if not (message.role == 'ipython' or message.role == 'tool' or 'tool_calls' in message) %}
+        {{- '<|start_header_id|>' + message['role'] + '<|end_header_id|>\n\n'+ message['content'] | trim + '<|eot_id|>' }}
+    {%- elif 'tool_calls' in message %}
+        {%- if not message.tool_calls|length == 1 %}
+            {{- raise_exception("This model only supports single tool-calls at once!") }}
+        {%- endif %}
+        {%- set tool_call = message.tool_calls[0].function %}
+        {%- if builtin_tools is defined and tool_call.name in builtin_tools %}
+            {{- '<|start_header_id|>assistant<|end_header_id|>\n\n' -}}
+            {{- "<|python_tag|>" + tool_call.name + ".call(" }}
+            {%- for arg_name, arg_val in tool_call.arguments | items %}
+                {{- arg_name + '="' + arg_val + '"' }}
+                {%- if not loop.last %}
+                    {{- ", " }}
+                {%- endif %}
+                {%- endfor %}
+            {{- ")" }}
+        {%- else  %}
+            {{- '<|start_header_id|>assistant<|end_header_id|>\n\n' -}}
+            {{- '<function=' + tool_call.name + '>' + tool_call.arguments + '</function>'}}
+        {%- endif %}
+        {%- if builtin_tools is defined or tools is not none%}
+            {#- This means we're in ipython mode #}
+            {{- "<|eom_id|>" }}
+        {%- else %}
+            {{- "<|eot_id|>" }}
+        {%- endif %}
+    {%- elif message.role == "tool" or message.role == "ipython" %}
+        {{- "<|start_header_id|>ipython<|end_header_id|>\n\n" }}
+        {%- if message.content is mapping or message.content is iterable %}
+            {{- message.content | tojson }}
+        {%- else %}
+            {{- message.content }}
+        {%- endif %}
+        {{- "<|eot_id|>" }}
+    {%- endif %}
+{%- endfor %}
+{%- if add_generation_prompt %}
+    {{- '<|start_header_id|>assistant<|end_header_id|>\n\n' }}
+{%- endif %}

vllm/entrypoints/openai/tool_parsers/__init__.py

@@ -7,6 +7,7 @@
 from .internlm2_tool_parser import Internlm2ToolParser
 from .jamba_tool_parser import JambaToolParser
 from .llama_tool_parser import Llama3JsonToolParser
+from .llama_usr_defined_tool_parser import Llama3UserDefinedCustomToolParser
 from .mistral_tool_parser import MistralToolParser
 from .phi4mini_tool_parser import Phi4MiniJsonToolParser
 from .pythonic_tool_parser import PythonicToolParser
@@ -15,5 +16,6 @@
     "ToolParser", "ToolParserManager", "Granite20bFCToolParser",
     "GraniteToolParser", "Hermes2ProToolParser", "MistralToolParser",
     "Internlm2ToolParser", "Llama3JsonToolParser", "JambaToolParser",
-    "PythonicToolParser", "Phi4MiniJsonToolParser"
+    "PythonicToolParser", "Llama3UserDefinedCustomToolParser",
+    "Phi4MiniJsonToolParser"
 ]