feat: Add MaxCountPerStepToolRule (#1319)

This commit is contained in:
Matthew Zhou
2025-03-17 17:23:14 -07:00
committed by GitHub
parent 8f91a19332
commit a7759fb514
7 changed files with 519 additions and 477 deletions

View File

@@ -5,14 +5,14 @@ import pytest
from letta import create_client
from letta.schemas.letta_message import ToolCallMessage
from letta.schemas.tool_rule import ChildToolRule, ConditionalToolRule, ContinueToolRule, InitToolRule, TerminalToolRule
from letta.schemas.tool_rule import ChildToolRule, ContinueToolRule, InitToolRule, MaxCountPerStepToolRule, TerminalToolRule
from tests.helpers.endpoints_helper import (
assert_invoked_function_call,
assert_invoked_send_message_with_keyword,
assert_sanity_checks,
setup_agent,
)
from tests.helpers.utils import cleanup
from tests.helpers.utils import cleanup, retry_until_success
# Generate uuid for agent name for this example
namespace = uuid.NAMESPACE_DNS
@@ -85,25 +85,6 @@ def flip_coin():
return "hj2hwibbqm"
def flip_coin_hard():
"""
Call this to retrieve the password to the secret word, which you will need to output in a send_message later.
If it returns an empty string, try flipping again!
Returns:
str: The password or an empty string
"""
import random
# Flip a coin with 50% chance
result = random.random()
if result < 0.5:
return ""
if result < 0.75:
return "START_OVER"
return "hj2hwibbqm"
def can_play_game():
"""
Call this to start the tool chain.
@@ -345,320 +326,243 @@ def test_agent_no_structured_output_with_one_child_tool(mock_e2b_api_key_none):
cleanup(client=client, agent_uuid=agent_uuid)
@pytest.mark.timeout(60) # Sets a 60-second timeout for the test since this could loop infinitely
def test_agent_conditional_tool_easy(mock_e2b_api_key_none):
"""
Test the agent with a conditional tool that has a child tool.
Tool Flow:
-------
| |
| v
-- flip_coin
|
v
reveal_secret_word
"""
client = create_client()
cleanup(client=client, agent_uuid=agent_uuid)
coin_flip_name = "flip_coin"
secret_word_tool = "fourth_secret_word"
flip_coin_tool = client.create_or_update_tool(flip_coin)
reveal_secret = client.create_or_update_tool(fourth_secret_word)
# Make tool rules
tool_rules = [
InitToolRule(tool_name=coin_flip_name),
ConditionalToolRule(
tool_name=coin_flip_name,
default_child=coin_flip_name,
child_output_mapping={
"hj2hwibbqm": secret_word_tool,
},
),
TerminalToolRule(tool_name=secret_word_tool),
]
tools = [flip_coin_tool, reveal_secret]
config_file = "tests/configs/llm_model_configs/claude-3-5-sonnet.json"
agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
response = client.user_message(agent_id=agent_state.id, message="flip a coin until you get the secret word")
# Make checks
assert_sanity_checks(response)
# Assert the tools were called
assert_invoked_function_call(response.messages, "flip_coin")
assert_invoked_function_call(response.messages, "fourth_secret_word")
# Check ordering of tool calls
found_secret_word = False
for m in response.messages:
if isinstance(m, ToolCallMessage):
if m.tool_call.name == secret_word_tool:
# Should be the last tool call
found_secret_word = True
else:
# Before finding secret_word, only flip_coin should be called
assert m.tool_call.name == coin_flip_name
assert not found_secret_word
# Ensure we found the secret word exactly once
assert found_secret_word
print(f"Got successful response from client: \n\n{response}")
cleanup(client=client, agent_uuid=agent_uuid)
# @pytest.mark.timeout(60) # Sets a 60-second timeout for the test since this could loop infinitely
# def test_agent_conditional_tool_easy(mock_e2b_api_key_none):
# """
# Test the agent with a conditional tool that has a child tool.
#
# Tool Flow:
#
# -------
# | |
# | v
# -- flip_coin
# |
# v
# reveal_secret_word
# """
#
# client = create_client()
# cleanup(client=client, agent_uuid=agent_uuid)
#
# coin_flip_name = "flip_coin"
# secret_word_tool = "fourth_secret_word"
# flip_coin_tool = client.create_or_update_tool(flip_coin)
# reveal_secret = client.create_or_update_tool(fourth_secret_word)
#
# # Make tool rules
# tool_rules = [
# InitToolRule(tool_name=coin_flip_name),
# ConditionalToolRule(
# tool_name=coin_flip_name,
# default_child=coin_flip_name,
# child_output_mapping={
# "hj2hwibbqm": secret_word_tool,
# },
# ),
# TerminalToolRule(tool_name=secret_word_tool),
# ]
# tools = [flip_coin_tool, reveal_secret]
#
# config_file = "tests/configs/llm_model_configs/claude-3-5-sonnet.json"
# agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
# response = client.user_message(agent_id=agent_state.id, message="flip a coin until you get the secret word")
#
# # Make checks
# assert_sanity_checks(response)
#
# # Assert the tools were called
# assert_invoked_function_call(response.messages, "flip_coin")
# assert_invoked_function_call(response.messages, "fourth_secret_word")
#
# # Check ordering of tool calls
# found_secret_word = False
# for m in response.messages:
# if isinstance(m, ToolCallMessage):
# if m.tool_call.name == secret_word_tool:
# # Should be the last tool call
# found_secret_word = True
# else:
# # Before finding secret_word, only flip_coin should be called
# assert m.tool_call.name == coin_flip_name
# assert not found_secret_word
#
# # Ensure we found the secret word exactly once
# assert found_secret_word
#
# print(f"Got successful response from client: \n\n{response}")
# cleanup(client=client, agent_uuid=agent_uuid)
@pytest.mark.timeout(90) # Longer timeout since this test has more steps
def test_agent_conditional_tool_hard(mock_e2b_api_key_none):
"""
Test the agent with a complex conditional tool graph
Tool Flow:
can_play_game <---+
| |
v |
flip_coin -----+
|
v
fourth_secret_word
"""
client = create_client()
cleanup(client=client, agent_uuid=agent_uuid)
# Create tools
play_game = "can_play_game"
coin_flip_name = "flip_coin_hard"
final_tool = "fourth_secret_word"
play_game_tool = client.create_or_update_tool(can_play_game)
flip_coin_tool = client.create_or_update_tool(flip_coin_hard)
reveal_secret = client.create_or_update_tool(fourth_secret_word)
# Make tool rules - chain them together with conditional rules
tool_rules = [
InitToolRule(tool_name=play_game),
ConditionalToolRule(
tool_name=play_game,
default_child=play_game, # Keep trying if we can't play
child_output_mapping={True: coin_flip_name}, # Only allow access when can_play_game returns True
),
ConditionalToolRule(
tool_name=coin_flip_name, default_child=coin_flip_name, child_output_mapping={"hj2hwibbqm": final_tool, "START_OVER": play_game}
),
TerminalToolRule(tool_name=final_tool),
]
# Setup agent with all tools
tools = [play_game_tool, flip_coin_tool, reveal_secret]
config_file = "tests/configs/llm_model_configs/claude-3-5-sonnet.json"
agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
# Ask agent to try to get all secret words
response = client.user_message(agent_id=agent_state.id, message="hi")
# Make checks
assert_sanity_checks(response)
# Assert all tools were called
assert_invoked_function_call(response.messages, play_game)
assert_invoked_function_call(response.messages, final_tool)
# Check ordering of tool calls
found_words = []
for m in response.messages:
if isinstance(m, ToolCallMessage):
name = m.tool_call.name
if name in [play_game, coin_flip_name]:
# Before finding secret_word, only can_play_game and flip_coin should be called
assert name in [play_game, coin_flip_name]
else:
# Should find secret words in order
expected_word = final_tool
assert name == expected_word, f"Found {name} but expected {expected_word}"
found_words.append(name)
# Ensure we found all secret words in order
assert found_words == [final_tool]
print(f"Got successful response from client: \n\n{response}")
cleanup(client=client, agent_uuid=agent_uuid)
# @pytest.mark.timeout(60)
# def test_agent_conditional_tool_without_default_child(mock_e2b_api_key_none):
# """
# Test the agent with a conditional tool that allows any child tool to be called if a function returns None.
#
# Tool Flow:
#
# return_none
# |
# v
# any tool... <-- When output doesn't match mapping, agent can call any tool
# """
# client = create_client()
# cleanup(client=client, agent_uuid=agent_uuid)
#
# # Create tools - we'll make several available to the agent
# tool_name = "return_none"
#
# tool = client.create_or_update_tool(return_none)
# secret_word = client.create_or_update_tool(first_secret_word)
#
# # Make tool rules - only map one output, let others be free choice
# tool_rules = [
# InitToolRule(tool_name=tool_name),
# ConditionalToolRule(
# tool_name=tool_name,
# default_child=None, # Allow any tool to be called if output doesn't match
# child_output_mapping={"anything but none": "first_secret_word"},
# ),
# ]
# tools = [tool, secret_word]
#
# # Setup agent with all tools
# agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
#
# # Ask agent to try different tools based on the game output
# response = client.user_message(agent_id=agent_state.id, message="call a function, any function. then call send_message")
#
# # Make checks
# assert_sanity_checks(response)
#
# # Assert return_none was called
# assert_invoked_function_call(response.messages, tool_name)
#
# # Assert any base function called afterward
# found_any_tool = False
# found_return_none = False
# for m in response.messages:
# if isinstance(m, ToolCallMessage):
# if m.tool_call.name == tool_name:
# found_return_none = True
# elif found_return_none and m.tool_call.name:
# found_any_tool = True
# break
#
# assert found_any_tool, "Should have called any tool after return_none"
#
# print(f"Got successful response from client: \n\n{response}")
# cleanup(client=client, agent_uuid=agent_uuid)
@pytest.mark.timeout(60)
def test_agent_conditional_tool_without_default_child(mock_e2b_api_key_none):
"""
Test the agent with a conditional tool that allows any child tool to be called if a function returns None.
Tool Flow:
return_none
|
v
any tool... <-- When output doesn't match mapping, agent can call any tool
"""
client = create_client()
cleanup(client=client, agent_uuid=agent_uuid)
# Create tools - we'll make several available to the agent
tool_name = "return_none"
tool = client.create_or_update_tool(return_none)
secret_word = client.create_or_update_tool(first_secret_word)
# Make tool rules - only map one output, let others be free choice
tool_rules = [
InitToolRule(tool_name=tool_name),
ConditionalToolRule(
tool_name=tool_name,
default_child=None, # Allow any tool to be called if output doesn't match
child_output_mapping={"anything but none": "first_secret_word"},
),
]
tools = [tool, secret_word]
# Setup agent with all tools
agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
# Ask agent to try different tools based on the game output
response = client.user_message(agent_id=agent_state.id, message="call a function, any function. then call send_message")
# Make checks
assert_sanity_checks(response)
# Assert return_none was called
assert_invoked_function_call(response.messages, tool_name)
# Assert any base function called afterward
found_any_tool = False
found_return_none = False
for m in response.messages:
if isinstance(m, ToolCallMessage):
if m.tool_call.name == tool_name:
found_return_none = True
elif found_return_none and m.tool_call.name:
found_any_tool = True
break
assert found_any_tool, "Should have called any tool after return_none"
print(f"Got successful response from client: \n\n{response}")
cleanup(client=client, agent_uuid=agent_uuid)
# @pytest.mark.timeout(60)
# def test_agent_reload_remembers_function_response(mock_e2b_api_key_none):
# """
# Test that when an agent is reloaded, it remembers the last function response for conditional tool chaining.
#
# Tool Flow:
#
# flip_coin
# |
# v
# fourth_secret_word <-- Should remember coin flip result after reload
# """
# client = create_client()
# cleanup(client=client, agent_uuid=agent_uuid)
#
# # Create tools
# flip_coin_name = "flip_coin"
# secret_word = "fourth_secret_word"
# flip_coin_tool = client.create_or_update_tool(flip_coin)
# secret_word_tool = client.create_or_update_tool(fourth_secret_word)
#
# # Make tool rules - map coin flip to fourth_secret_word
# tool_rules = [
# InitToolRule(tool_name=flip_coin_name),
# ConditionalToolRule(
# tool_name=flip_coin_name,
# default_child=flip_coin_name, # Allow any tool to be called if output doesn't match
# child_output_mapping={"hj2hwibbqm": secret_word},
# ),
# TerminalToolRule(tool_name=secret_word),
# ]
# tools = [flip_coin_tool, secret_word_tool]
#
# # Setup initial agent
# agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
#
# # Call flip_coin first
# response = client.user_message(agent_id=agent_state.id, message="flip a coin")
# assert_invoked_function_call(response.messages, flip_coin_name)
# assert_invoked_function_call(response.messages, secret_word)
# found_fourth_secret = False
# for m in response.messages:
# if isinstance(m, ToolCallMessage) and m.tool_call.name == secret_word:
# found_fourth_secret = True
# break
#
# assert found_fourth_secret, "Reloaded agent should remember coin flip result and call fourth_secret_word if True"
#
# # Reload the agent
# reloaded_agent = client.server.load_agent(agent_id=agent_state.id, actor=client.user)
# assert reloaded_agent.last_function_response is not None
#
# print(f"Got successful response from client: \n\n{response}")
# cleanup(client=client, agent_uuid=agent_uuid)
@pytest.mark.timeout(60)
def test_agent_reload_remembers_function_response(mock_e2b_api_key_none):
"""
Test that when an agent is reloaded, it remembers the last function response for conditional tool chaining.
Tool Flow:
flip_coin
|
v
fourth_secret_word <-- Should remember coin flip result after reload
"""
client = create_client()
cleanup(client=client, agent_uuid=agent_uuid)
# Create tools
flip_coin_name = "flip_coin"
secret_word = "fourth_secret_word"
flip_coin_tool = client.create_or_update_tool(flip_coin)
secret_word_tool = client.create_or_update_tool(fourth_secret_word)
# Make tool rules - map coin flip to fourth_secret_word
tool_rules = [
InitToolRule(tool_name=flip_coin_name),
ConditionalToolRule(
tool_name=flip_coin_name,
default_child=flip_coin_name, # Allow any tool to be called if output doesn't match
child_output_mapping={"hj2hwibbqm": secret_word},
),
TerminalToolRule(tool_name=secret_word),
]
tools = [flip_coin_tool, secret_word_tool]
# Setup initial agent
agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
# Call flip_coin first
response = client.user_message(agent_id=agent_state.id, message="flip a coin")
assert_invoked_function_call(response.messages, flip_coin_name)
assert_invoked_function_call(response.messages, secret_word)
found_fourth_secret = False
for m in response.messages:
if isinstance(m, ToolCallMessage) and m.tool_call.name == secret_word:
found_fourth_secret = True
break
assert found_fourth_secret, "Reloaded agent should remember coin flip result and call fourth_secret_word if True"
# Reload the agent
reloaded_agent = client.server.load_agent(agent_id=agent_state.id, actor=client.user)
assert reloaded_agent.last_function_response is not None
print(f"Got successful response from client: \n\n{response}")
cleanup(client=client, agent_uuid=agent_uuid)
@pytest.mark.timeout(60) # Sets a 60-second timeout for the test since this could loop infinitely
def test_simple_tool_rule(mock_e2b_api_key_none):
"""
Test a simple tool rule where fourth_secret_word must be called after flip_coin.
Tool Flow:
flip_coin
|
v
fourth_secret_word
"""
client = create_client()
cleanup(client=client, agent_uuid=agent_uuid)
# Create tools
flip_coin_name = "flip_coin"
secret_word = "fourth_secret_word"
random_tool = "can_play_game"
flip_coin_tool = client.create_or_update_tool(flip_coin)
secret_word_tool = client.create_or_update_tool(fourth_secret_word)
another_secret_word_tool = client.create_or_update_tool(first_secret_word)
random_tool = client.create_or_update_tool(can_play_game)
tools = [flip_coin_tool, secret_word_tool, another_secret_word_tool, random_tool]
# Create tool rule: after flip_coin, must call fourth_secret_word
tool_rule = ConditionalToolRule(
tool_name=flip_coin_name,
default_child=secret_word,
child_output_mapping={"*": secret_word},
)
# Set up agent with the tool rule
agent_state = setup_agent(
client, config_file, agent_uuid, tool_rules=[tool_rule], tool_ids=[t.id for t in tools], include_base_tools=False
)
# Start conversation
response = client.user_message(agent_id=agent_state.id, message="Help me test the tools.")
# Verify the tool calls
tool_calls = [msg for msg in response.messages if isinstance(msg, ToolCallMessage)]
assert len(tool_calls) >= 2 # Should have at least flip_coin and fourth_secret_word calls
assert_invoked_function_call(response.messages, flip_coin_name)
assert_invoked_function_call(response.messages, secret_word)
# Find the flip_coin call
flip_coin_call = next((call for call in tool_calls if call.tool_call.name == "flip_coin"), None)
# Verify that fourth_secret_word was called after flip_coin
flip_coin_call_index = tool_calls.index(flip_coin_call)
assert tool_calls[flip_coin_call_index + 1].tool_call.name == secret_word, "Fourth secret word should be called after flip_coin"
cleanup(client, agent_uuid=agent_state.id)
# @pytest.mark.timeout(60) # Sets a 60-second timeout for the test since this could loop infinitely
# def test_simple_tool_rule(mock_e2b_api_key_none):
# """
# Test a simple tool rule where fourth_secret_word must be called after flip_coin.
#
# Tool Flow:
# flip_coin
# |
# v
# fourth_secret_word
# """
# client = create_client()
# cleanup(client=client, agent_uuid=agent_uuid)
#
# # Create tools
# flip_coin_name = "flip_coin"
# secret_word = "fourth_secret_word"
# flip_coin_tool = client.create_or_update_tool(flip_coin)
# secret_word_tool = client.create_or_update_tool(fourth_secret_word)
# another_secret_word_tool = client.create_or_update_tool(first_secret_word)
# random_tool = client.create_or_update_tool(can_play_game)
# tools = [flip_coin_tool, secret_word_tool, another_secret_word_tool, random_tool]
#
# # Create tool rule: after flip_coin, must call fourth_secret_word
# tool_rule = ConditionalToolRule(
# tool_name=flip_coin_name,
# default_child=secret_word,
# child_output_mapping={"*": secret_word},
# )
#
# # Set up agent with the tool rule
# agent_state = setup_agent(
# client, config_file, agent_uuid, tool_rules=[tool_rule], tool_ids=[t.id for t in tools], include_base_tools=False
# )
#
# # Start conversation
# response = client.user_message(agent_id=agent_state.id, message="Help me test the tools.")
#
# # Verify the tool calls
# tool_calls = [msg for msg in response.messages if isinstance(msg, ToolCallMessage)]
# assert len(tool_calls) >= 2 # Should have at least flip_coin and fourth_secret_word calls
# assert_invoked_function_call(response.messages, flip_coin_name)
# assert_invoked_function_call(response.messages, secret_word)
#
# # Find the flip_coin call
# flip_coin_call = next((call for call in tool_calls if call.tool_call.name == "flip_coin"), None)
#
# # Verify that fourth_secret_word was called after flip_coin
# flip_coin_call_index = tool_calls.index(flip_coin_call)
# assert tool_calls[flip_coin_call_index + 1].tool_call.name == secret_word, "Fourth secret word should be called after flip_coin"
#
# cleanup(client, agent_uuid=agent_state.id)
def test_init_tool_rule_always_fails_one_tool():
@@ -768,3 +672,56 @@ def test_continue_tool_rule():
if call.tool_call.name == "core_memory_append":
core_memory_append_call_index = i
assert send_message_call_index < core_memory_append_call_index, "send_message should have been called before core_memory_append"
@pytest.mark.timeout(60)
@retry_until_success(max_attempts=3, sleep_time_seconds=2)
def test_max_count_per_step_tool_rule_integration(mock_e2b_api_key_none):
"""
Test an agent with MaxCountPerStepToolRule to ensure a tool can only be called a limited number of times.
Tool Flow:
repeatable_tool (max 2 times)
|
v
send_message
"""
client = create_client()
cleanup(client=client, agent_uuid=agent_uuid)
# Create tools
repeatable_tool_name = "first_secret_word"
final_tool_name = "send_message"
repeatable_tool = client.create_or_update_tool(first_secret_word)
send_message_tool = client.get_tool(client.get_tool_id(final_tool_name)) # Assume send_message is a default tool
# Define tool rules
tool_rules = [
InitToolRule(tool_name=repeatable_tool_name),
MaxCountPerStepToolRule(tool_name=repeatable_tool_name, max_count_limit=2),
TerminalToolRule(tool_name=final_tool_name),
]
tools = [repeatable_tool, send_message_tool]
# Setup agent
agent_state = setup_agent(client, config_file, agent_uuid=agent_uuid, tool_ids=[t.id for t in tools], tool_rules=tool_rules)
# Start conversation
response = client.user_message(
agent_id=agent_state.id, message=f"Keep calling {repeatable_tool_name} nonstop without calling ANY other tool."
)
# Make checks
assert_sanity_checks(response)
# Ensure the repeatable tool is only called twice
count = sum(1 for m in response.messages if isinstance(m, ToolCallMessage) and m.tool_call.name == repeatable_tool_name)
assert count == 2, f"Expected 'first_secret_word' to be called exactly 2 times, but got {count}"
# Ensure send_message was eventually called
assert_invoked_function_call(response.messages, final_tool_name)
print(f"Got successful response from client: \n\n{response}")
cleanup(client=client, agent_uuid=agent_uuid)