diff --git a/docs/agents.md b/docs/agents.md
index c723dff54..1da684b88 100644
--- a/docs/agents.md
+++ b/docs/agents.md
@@ -194,16 +194,16 @@ agent = Agent(
'gemini-1.5-flash', # (1)!
deps_type=str, # (2)!
system_prompt=(
- "You're a dice game, you should roll the dice and see if the number "
- "you got back matches the user's guess, if so tell them they're a winner. "
+ "You're a dice game, you should roll the die and see if the number "
+ "you get back matches the user's guess. If so, tell them they're a winner. "
"Use the player's name in the response."
),
)
@agent.retriever_plain # (3)!
-def roll_dice() -> str:
- """Roll a six-sided dice and return the result."""
+def roll_die() -> str:
+ """Roll a six-sided die and return the result."""
return str(random.randint(1, 6))
@@ -235,7 +235,7 @@ print(dice_result.all_messages())
"""
[
SystemPrompt(
- content="You're a dice game, you should roll the dice and see if the number you got back matches the user's guess, if so tell them they're a winner. Use the player's name in the response.",
+ content="You're a dice game, you should roll the die and see if the number you get back matches the user's guess. If so, tell them they're a winner. Use the player's name in the response.",
role='system',
),
UserPrompt(
@@ -246,14 +246,14 @@ print(dice_result.all_messages())
ModelStructuredResponse(
calls=[
ToolCall(
- tool_name='roll_dice', args=ArgsObject(args_object={}), tool_id=None
+ tool_name='roll_die', args=ArgsObject(args_object={}), tool_id=None
)
],
timestamp=datetime.datetime(...),
role='model-structured-response',
),
ToolReturn(
- tool_name='roll_dice',
+ tool_name='roll_die',
content='4',
tool_id=None,
timestamp=datetime.datetime(...),
@@ -286,10 +286,41 @@ print(dice_result.all_messages())
"""
```
-We can represent that as a flow diagram, thus:
-
-
-
+We can represent this with a diagram:
+
+```mermaid
+sequenceDiagram
+ participant Agent
+ participant LLM
+
+ Note over Agent: Send prompts
+ Agent ->> LLM: System: "You're a dice game..." User: "My guess is 4"
+ activate LLM
+ Note over LLM: LLM decides to use a retriever
+
+ LLM ->> Agent: Call retriever roll_die()
+ deactivate LLM
+ activate Agent
+ Note over Agent: Rolls a six-sided die
+
+ Agent -->> LLM: ToolReturn "4"
+ deactivate Agent
+ activate LLM
+ Note over LLM: LLM decides to use another retriever
+
+ LLM ->> Agent: Call retriever get_player_name()
+ deactivate LLM
+ activate Agent
+ Note over Agent: Retrieves player name
+ Agent -->> LLM: ToolReturn "Adam"
+ deactivate Agent
+ activate LLM
+ Note over LLM: LLM constructs final response
+
+ LLM ->> Agent: ModelTextResponse "Congratulations Adam, ..."
+ deactivate LLM
+ Note over Agent: Game session complete
+```
### Retrievers, tools, and schema
diff --git a/docs/img/dice-diagram-dark.svg b/docs/img/dice-diagram-dark.svg
deleted file mode 100644
index b0b77e93f..000000000
--- a/docs/img/dice-diagram-dark.svg
+++ /dev/null
@@ -1,11 +0,0 @@
-
diff --git a/docs/img/dice-diagram-light.svg b/docs/img/dice-diagram-light.svg
deleted file mode 100644
index 64856c934..000000000
--- a/docs/img/dice-diagram-light.svg
+++ /dev/null
@@ -1,11 +0,0 @@
-
diff --git a/tests/test_examples.py b/tests/test_examples.py
index 1ff0ed4ee..cc7e5d92d 100644
--- a/tests/test_examples.py
+++ b/tests/test_examples.py
@@ -149,7 +149,7 @@ async def async_http_request(url: str, **kwargs: Any) -> httpx.Response:
'What is the date?': 'Hello Frank, the date today is 2032-01-02.',
'Put my money on square eighteen': ToolCall(tool_name='roulette_wheel', args=ArgsObject({'square': 18})),
'I bet five is the winner': ToolCall(tool_name='roulette_wheel', args=ArgsObject({'square': 5})),
- 'My guess is 4': ToolCall(tool_name='roll_dice', args=ArgsObject({})),
+ 'My guess is 4': ToolCall(tool_name='roll_die', args=ArgsObject({})),
'Send a message to John Doe asking for coffee next week': ToolCall(
tool_name='get_user_by_name', args=ArgsObject({'name': 'John'})
),
@@ -186,7 +186,7 @@ async def model_logic(messages: list[Message], info: AgentInfo) -> ModelAnyRespo
elif m.role == 'tool-return' and m.tool_name == 'roulette_wheel':
win = m.content == 'winner'
return ModelStructuredResponse(calls=[ToolCall(tool_name='final_result', args=ArgsObject({'response': win}))])
- elif m.role == 'tool-return' and m.tool_name == 'roll_dice':
+ elif m.role == 'tool-return' and m.tool_name == 'roll_die':
return ModelStructuredResponse(calls=[ToolCall(tool_name='get_player_name', args=ArgsObject({}))])
elif m.role == 'tool-return' and m.tool_name == 'get_player_name':
return ModelTextResponse(content="Congratulations Adam, you guessed correctly! You're a winner!")