Skip to content

GitLab

Unverified Commit 9195dbdb authored by Travis Johnson's avatar Travis Johnson Committed by GitHub
Browse files

[Bugfix][Frontend] Update Llama Chat Templates to also support Non-Tool use (#10164) 


Signed-off-by: default avatarTravis Johnson <tsjohnso@us.ibm.com>
parent d559979c
Hide whitespace changes
Inline Side-by-side
Showing with 110 additions and 36 deletions
examples/tool_chat_template_llama3.1_json.jinja
View file @ 9195dbdb
...@@ -19,10 +19,18 @@ ...@@ -19,10 +19,18 @@
{#- This block extracts the system message, so we can slot it into the right place. #} {#- This block extracts the system message, so we can slot it into the right place. #}
{%- if messages[0]['role'] == 'system' %} {%- if messages[0]['role'] == 'system' %}
{%- set system_message = messages[0]['content']|trim %} {%- if messages[0]['content'] is string %}
{%- set system_message = messages[0]['content']|trim %}
{%- else %}
{%- set system_message = messages[0]['content'][0]['text']|trim %}
{%- endif %}
{%- set messages = messages[1:] %} {%- set messages = messages[1:] %}
{%- else %} {%- else %}
{%- set system_message = "You are a helpful assistant with tool calling capabilities. Only reply with a tool call if the function exists in the library provided by the user. If it doesn't exist, just reply directly in natural language. When you receive a tool call response, use the output to format an answer to the original user question." %} {%- if tools is not none %}
{%- set system_message = "You are a helpful assistant with tool calling capabilities. Only reply with a tool call if the function exists in the library provided by the user. If it doesn't exist, just reply directly in natural language. When you receive a tool call response, use the output to format an answer to the original user question." %}
{%- else %}
{%- set system_message = "" %}
{%- endif %}
{%- endif %} {%- endif %}
{#- System message #} {#- System message #}
...@@ -33,8 +41,8 @@ ...@@ -33,8 +41,8 @@
{{- "Cutting Knowledge Date: December 2023\n" }} {{- "Cutting Knowledge Date: December 2023\n" }}
{{- "Today Date: " + date_string + "\n\n" }} {{- "Today Date: " + date_string + "\n\n" }}
{%- if tools is not none and not tools_in_user_message %} {%- if tools is not none and not tools_in_user_message %}
{{- "You have access to the following functions. To call a function, please respond with JSON for a function call." }} {{- "You have access to the following functions. To call a function, please respond with JSON for a function call. " }}
{{- 'Respond in the format {"name": function name, "parameters": dictionary of argument name and its value}.' }} {{- 'Respond in the format {"name": function name, "parameters": dictionary of argument name and its value}. ' }}
{{- "Do not use variables.\n\n" }} {{- "Do not use variables.\n\n" }}
{%- for t in tools %} {%- for t in tools %}
{{- t | tojson(indent=4) }} {{- t | tojson(indent=4) }}
...@@ -48,7 +56,11 @@ ...@@ -48,7 +56,11 @@
{%- if tools_in_user_message and not tools is none %} {%- if tools_in_user_message and not tools is none %}
{#- Extract the first user message so we can plug it in here #} {#- Extract the first user message so we can plug it in here #}
{%- if messages | length != 0 %} {%- if messages | length != 0 %}
{%- set first_user_message = messages[0]['content']|trim %} {%- if messages[0]['content'] is string %}
{%- set first_user_message = messages[0]['content']|trim %}
{%- else %}
{%- set first_user_message = messages[0]['content'] | selectattr('type', 'equalto', 'text') | map(attribute='text') | map('trim') | join('\n') %}
{%- endif %}
{%- set messages = messages[1:] %} {%- set messages = messages[1:] %}
{%- else %} {%- else %}
{{- raise_exception("Cannot put tools in the first user message when there's no first user message!") }} {{- raise_exception("Cannot put tools in the first user message when there's no first user message!") }}
...@@ -56,7 +68,7 @@ ...@@ -56,7 +68,7 @@
{{- '<|start_header_id|>user<|end_header_id|>\n\n' -}} {{- '<|start_header_id|>user<|end_header_id|>\n\n' -}}
{{- "Given the following functions, please respond with a JSON for a function call " }} {{- "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" }} {{- "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}.' }} {{- 'Respond in the format {"name": function name, "parameters": dictionary of argument name and its value}. ' }}
{{- "Do not use variables.\n\n" }} {{- "Do not use variables.\n\n" }}
{%- for t in tools %} {%- for t in tools %}
{{- t | tojson(indent=4) }} {{- t | tojson(indent=4) }}
...@@ -67,7 +79,17 @@ ...@@ -67,7 +79,17 @@
{%- for message in messages %} {%- for message in messages %}
{%- if not (message.role == 'ipython' or message.role == 'tool' or 'tool_calls' in message) %} {%- 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|>' }} {{- '<|start_header_id|>' + message['role'] + '<|end_header_id|>\n\n' }}
{%- if message['content'] is string %}
{{- message['content'] | trim}}
{%- else %}
{%- for content in message['content'] %}
{%- if content['type'] == 'text' %}
{{- content['text'] | trim }}
{%- endif %}
{%- endfor %}
{%- endif %}
{{- '<|eot_id|>' }}
{%- elif 'tool_calls' in message %} {%- elif 'tool_calls' in message %}
{%- if not message.tool_calls|length == 1 %} {%- if not message.tool_calls|length == 1 %}
{{- raise_exception("This model only supports single tool-calls at once!") }} {{- raise_exception("This model only supports single tool-calls at once!") }}
...@@ -81,10 +103,14 @@ ...@@ -81,10 +103,14 @@
{{- "<|eot_id|>" }} {{- "<|eot_id|>" }}
{%- elif message.role == "tool" or message.role == "ipython" %} {%- elif message.role == "tool" or message.role == "ipython" %}
{{- "<|start_header_id|>ipython<|end_header_id|>\n\n" }} {{- "<|start_header_id|>ipython<|end_header_id|>\n\n" }}
{%- if message.content is mapping %} {%- if message.content is string %}
{{- message.content | tojson }}
{%- else %}
{{- { "output": message.content } | tojson }} {{- { "output": message.content } | tojson }}
{%- else %}
{%- for content in message['content'] %}
{%- if content['type'] == 'text' %}
{{- { "output": content['text'] } | tojson }}
{%- endif %}
{%- endfor %}
{%- endif %} {%- endif %}
{{- "<|eot_id|>" }} {{- "<|eot_id|>" }}
{%- endif %} {%- endif %}
......
examples/tool_chat_template_llama3.2_json.jinja
View file @ 9195dbdb
...@@ -16,38 +16,70 @@ ...@@ -16,38 +16,70 @@
{%- set tools = none %} {%- set tools = none %}
{%- endif %} {%- endif %}
{#- Find out if there are any images #}
{% set image_ns = namespace(has_images=false) %}
{%- for message in messages %}
{%- for content in message['content'] %}
{%- if content['type'] == 'image' %}
{%- set image_ns.has_images = true %}
{%- endif %}
{%- endfor %}
{%- endfor %}
{#- This block extracts the system message, so we can slot it into the right place. #} {#- This block extracts the system message, so we can slot it into the right place. #}
{%- if messages[0]['role'] == 'system' %} {%- if messages[0]['role'] == 'system' %}
{%- set system_message = messages[0]['content']|trim %} {%- if messages[0]['content'] is string %}
{%- set system_message = messages[0]['content']|trim %}
{%- else %}
{#- Support vLLM's transforming of a content string to JSON. #}
{%- set system_message = messages[0]['content'][0]['text']|trim %}
{%- endif %}
{%- set messages = messages[1:] %} {%- set messages = messages[1:] %}
{%- else %} {%- else %}
{%- set system_message = "You are a helpful assistant with tool calling capabilities. Only reply with a tool call if the function exists in the library provided by the user. If it doesn't exist, just reply directly in natural language. When you receive a tool call response, use the output to format an answer to the original user question." %} {%- if tools is not none %}
{%- set system_message = "You are a helpful assistant with tool calling capabilities. Only reply with a tool call if the function exists in the library provided by the user. If it doesn't exist, just reply directly in natural language. When you receive a tool call response, use the output to format an answer to the original user question." %}
{%- else %}
{%- set system_message = "" %}
{%- endif %}
{%- endif %} {%- endif %}
{#- System message #} {#- Including an image is not compatible with a system message #}
{{- "<|start_header_id|>system<|end_header_id|>\n\n" }} {%- if image_ns.has_images and not system_message == "" %}
{%- if tools is not none %} {{- raise_exception("Prompting with images is incompatible with system messages and tool use.") }}
{{- "Environment: ipython\n" }}
{%- endif %} {%- endif %}
{{- "Cutting Knowledge Date: December 2023\n" }}
{{- "Today Date: " + date_string + "\n\n" }}
{%- if tools is not none and not tools_in_user_message %} {#- System message, if there are no images #}
{{- "You have access to the following functions. To call a function, please respond with JSON for a function call." }} {%- if not image_ns.has_images %}
{{- 'Respond in the format {"name": function name, "parameters": dictionary of argument name and its value}.' }} {{- "<|start_header_id|>system<|end_header_id|>\n\n" }}
{{- "Do not use variables.\n\n" }} {%- if tools is not none %}
{%- for t in tools %} {{- "Environment: ipython\n" }}
{{- t | tojson(indent=4) }} {%- endif %}
{{- "\n\n" }} {{- "Cutting Knowledge Date: December 2023\n" }}
{%- endfor %} {{- "Today Date: " + date_string + "\n\n" }}
{%- if tools is not none and not tools_in_user_message %}
{{- "You have access to the following functions. To call a function, please respond with JSON for a function call. " }}
{{- '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(indent=4) }}
{{- "\n\n" }}
{%- endfor %}
{%- endif %}
{{- system_message }}
{{- "<|eot_id|>" }}
{%- endif %} {%- endif %}
{{- system_message }}
{{- "<|eot_id|>" }}
{#- Custom tools are passed in a user message with some extra guidance #} {#- Custom tools are passed in a user message with some extra guidance #}
{%- if tools_in_user_message and not tools is none %} {%- if tools_in_user_message and not tools is none %}
{#- Extract the first user message so we can plug it in here #} {#- Extract the first user message so we can plug it in here #}
{%- if messages | length != 0 %} {%- if messages | length != 0 %}
{%- set first_user_message = messages[0]['content']|trim %} {%- if messages[0]['content'] is string %}
{%- set first_user_message = messages[0]['content']|trim %}
{%- else %}
{%- set first_user_message = messages[0]['content'] | selectattr('type', 'equalto', 'text') | map(attribute='text') | map('trim') | join('\n') %}
{%- endif %}
{%- set messages = messages[1:] %} {%- set messages = messages[1:] %}
{%- else %} {%- else %}
{{- raise_exception("Cannot put tools in the first user message when there's no first user message!") }} {{- raise_exception("Cannot put tools in the first user message when there's no first user message!") }}
...@@ -55,7 +87,7 @@ ...@@ -55,7 +87,7 @@
{{- '<|start_header_id|>user<|end_header_id|>\n\n' -}} {{- '<|start_header_id|>user<|end_header_id|>\n\n' -}}
{{- "Given the following functions, please respond with a JSON for a function call " }} {{- "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" }} {{- "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}.' }} {{- 'Respond in the format {"name": function name, "parameters": dictionary of argument name and its value}. ' }}
{{- "Do not use variables.\n\n" }} {{- "Do not use variables.\n\n" }}
{%- for t in tools %} {%- for t in tools %}
{{- t | tojson(indent=4) }} {{- t | tojson(indent=4) }}
...@@ -66,7 +98,19 @@ ...@@ -66,7 +98,19 @@
{%- for message in messages %} {%- for message in messages %}
{%- if not (message.role == 'ipython' or message.role == 'tool' or 'tool_calls' in message) %} {%- 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|>' }} {{- '<|start_header_id|>' + message['role'] + '<|end_header_id|>\n\n' }}
{%- if message['content'] is string %}
{{- message['content'] | trim}}
{%- else %}
{%- for content in message['content'] %}
{%- if content['type'] == 'image' %}
{{- '<|image|>' }}
{%- elif content['type'] == 'text' %}
{{- content['text'] | trim }}
{%- endif %}
{%- endfor %}
{%- endif %}
{{- '<|eot_id|>' }}
{%- elif 'tool_calls' in message %} {%- elif 'tool_calls' in message %}
{%- if not message.tool_calls|length == 1 %} {%- if not message.tool_calls|length == 1 %}
{{- raise_exception("This model only supports single tool-calls at once!") }} {{- raise_exception("This model only supports single tool-calls at once!") }}
...@@ -80,10 +124,14 @@ ...@@ -80,10 +124,14 @@
{{- "<|eot_id|>" }} {{- "<|eot_id|>" }}
{%- elif message.role == "tool" or message.role == "ipython" %} {%- elif message.role == "tool" or message.role == "ipython" %}
{{- "<|start_header_id|>ipython<|end_header_id|>\n\n" }} {{- "<|start_header_id|>ipython<|end_header_id|>\n\n" }}
{%- if message.content is mapping %} {%- if message.content is string %}
{{- message.content | tojson }}
{%- else %}
{{- { "output": message.content } | tojson }} {{- { "output": message.content } | tojson }}
{%- else %}
{%- for content in message['content'] %}
{%- if content['type'] == 'text' %}
{{- { "output": content['text'] } | tojson }}
{%- endif %}
{%- endfor %}
{%- endif %} {%- endif %}
{{- "<|eot_id|>" }} {{- "<|eot_id|>" }}
{%- endif %} {%- endif %}
......
tests/entrypoints/test_chat_utils.py
View file @ 9195dbdb
...@@ -766,8 +766,8 @@ def test_resolve_content_format_hf_defined(model, expected_format): ...@@ -766,8 +766,8 @@ def test_resolve_content_format_hf_defined(model, expected_format):
("tool_chat_template_granite_20b_fc.jinja", "string"), ("tool_chat_template_granite_20b_fc.jinja", "string"),
("tool_chat_template_hermes.jinja", "string"), ("tool_chat_template_hermes.jinja", "string"),
("tool_chat_template_internlm2_tool.jinja", "string"), ("tool_chat_template_internlm2_tool.jinja", "string"),
("tool_chat_template_llama3.1_json.jinja", "string"), ("tool_chat_template_llama3.1_json.jinja", "openai"),
("tool_chat_template_llama3.2_json.jinja", "string"), ("tool_chat_template_llama3.2_json.jinja", "openai"),
("tool_chat_template_mistral_parallel.jinja", "string"), ("tool_chat_template_mistral_parallel.jinja", "string"),
("tool_chat_template_mistral.jinja", "string")], ("tool_chat_template_mistral.jinja", "string")],
) )
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment