mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-31 09:33:54 +00:00
7027b537e0
# What does this PR do?
This PR proposes updates to the tools API in Inference and Agent.
Goals:
1. Agent's tool specification should be consistent with Inference's tool spec, but with add-ons.
2. Formal types should be defined for built in tools. Currently Agent tools args are untyped, e.g. how does one know that `builtin::rag_tool` takes a `vector_db_ids` param or even how to know 'builtin::rag_tool' is even available (in code, outside of docs)?
Inference:
1. BuiltinTool is to be removed and replaced by a formal `type` parameter.
2. 'brave_search' is replaced by 'web_search' to be more generic. It will still be translated back to brave_search when the prompt is constructed to be consistent with model training.
3. I'm not sure what `photogen` is. Maybe it can be removed?
Agent:
1. Uses the same format as in Inference for builtin tools.
2. New tools types are added, i.e. knowledge_sesarch (currently rag_tool), and MCP tool.
3. Toolgroup as a concept will be removed since it's really only used for MCP.
4. Instead MCPTool is its own type and available tools provided by the server will be expanded by default. Users can specify a subset of tool names if desired.
Example snippet:
```
agent = Agent(
client,
model=model_id,
instructions="You are a helpful assistant. Use the tools you have access to for providing relevant answers.",
tools=[
KnowledgeSearchTool(vector_store_id="1234"),
KnowledgeSearchTool(vector_store_id="5678", name="paper_search", description="Search research papers"),
KnowledgeSearchTool(vector_store_id="1357", name="wiki_search", description="Search wiki pages"),
# no need to register toolgroup, just pass in the server uri
# all available tools will be used
MCPTool(server_uri="http://localhost:8000/sse"),
# can specify a subset of available tools
MCPTool(server_uri="http://localhost:8000/sse", tool_names=["list_directory"]),
MCPTool(server_uri="http://localhost:8000/sse", tool_names=["list_directory"]),
# custom tool
my_custom_tool,
]
)
```
## Test Plan
# What does this PR do?
## Test Plan
# What does this PR do?
## Test Plan
82 lines
2.7 KiB
Python
82 lines
2.7 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# top-level folder for each specific model found within the models/ directory at
|
|
# the top-level of this source tree.
|
|
|
|
import textwrap
|
|
import unittest
|
|
from datetime import datetime
|
|
|
|
from llama_stack.models.llama.llama3.prompt_templates import (
|
|
BuiltinToolGenerator,
|
|
FunctionTagCustomToolGenerator,
|
|
JsonCustomToolGenerator,
|
|
PythonListCustomToolGenerator,
|
|
SystemDefaultGenerator,
|
|
)
|
|
|
|
|
|
class PromptTemplateTests(unittest.TestCase):
|
|
def check_generator_output(self, generator):
|
|
for example in generator.data_examples():
|
|
pt = generator.gen(example)
|
|
text = pt.render()
|
|
# print(text) # debugging
|
|
if not example:
|
|
continue
|
|
for tool in example:
|
|
assert tool.name in text
|
|
|
|
def test_system_default(self):
|
|
generator = SystemDefaultGenerator()
|
|
today = datetime.now().strftime("%d %B %Y")
|
|
expected_text = f"Cutting Knowledge Date: December 2023\nToday Date: {today}"
|
|
assert expected_text.strip("\n") == generator.gen(generator.data_examples()[0]).render()
|
|
|
|
def test_system_builtin_only(self):
|
|
generator = BuiltinToolGenerator()
|
|
expected_text = textwrap.dedent(
|
|
"""
|
|
Environment: ipython
|
|
Tools: brave_search, wolfram_alpha
|
|
"""
|
|
)
|
|
assert expected_text.strip("\n") == generator.gen(generator.data_examples()[0]).render()
|
|
|
|
def test_system_custom_only(self):
|
|
self.maxDiff = None
|
|
generator = JsonCustomToolGenerator()
|
|
self.check_generator_output(generator)
|
|
|
|
def test_system_custom_function_tag(self):
|
|
self.maxDiff = None
|
|
generator = FunctionTagCustomToolGenerator()
|
|
self.check_generator_output(generator)
|
|
|
|
def test_llama_3_2_system_zero_shot(self):
|
|
generator = PythonListCustomToolGenerator()
|
|
self.check_generator_output(generator)
|
|
|
|
def test_llama_3_2_provided_system_prompt(self):
|
|
generator = PythonListCustomToolGenerator()
|
|
user_system_prompt = textwrap.dedent(
|
|
"""
|
|
Overriding message.
|
|
|
|
{{ function_description }}
|
|
"""
|
|
)
|
|
example = generator.data_examples()[0]
|
|
|
|
pt = generator.gen(example, user_system_prompt)
|
|
text = pt.render()
|
|
assert "Overriding message." in text
|
|
assert '"name": "get_weather"' in text
|