From cbf06298b7013c7c33b4d398edecf66d7aa6aa91 Mon Sep 17 00:00:00 2001 From: Christopher Hertel Date: Fri, 10 Oct 2025 00:36:38 +0200 Subject: [PATCH] Add config options for keeping tool call messages and sources + expose metadata in profiler --- .github/workflows/code-quality.yaml | 2 +- demo/config/packages/ai.yaml | 5 +++-- demo/src/Wikipedia/Chat.php | 4 +++- demo/templates/components/wikipedia.html.twig | 16 +++++++++++++--- docs/components/agent.rst | 4 ++-- examples/anthropic/toolcall.php | 2 +- src/agent/src/Toolbox/AgentProcessor.php | 4 ++-- src/agent/tests/Toolbox/AgentProcessorTest.php | 6 +++--- src/ai-bundle/config/options.php | 13 ++++++++++++- src/ai-bundle/config/services.php | 1 + src/ai-bundle/src/AiBundle.php | 4 +++- src/ai-bundle/src/Profiler/DataCollector.php | 6 +++++- src/ai-bundle/templates/data_collector.html.twig | 9 +++++++++ 13 files changed, 58 insertions(+), 18 deletions(-) diff --git a/.github/workflows/code-quality.yaml b/.github/workflows/code-quality.yaml index 058574ba0..a43fc344c 100644 --- a/.github/workflows/code-quality.yaml +++ b/.github/workflows/code-quality.yaml @@ -29,7 +29,7 @@ jobs: - name: Configure environment run: | echo COLUMNS=120 >> $GITHUB_ENV - echo COMPOSER_UP='composer update --no-progress --no-interaction --ansi --ignore-platform-req=ext-mongodb' >> $GITHUB_ENV + echo COMPOSER_UP='composer update --no-progress --no-interaction --no-scripts --ansi --ignore-platform-req=ext-mongodb' >> $GITHUB_ENV echo PHPSTAN='vendor/bin/phpstan' >> $GITHUB_ENV PACKAGES=$(find src/ -mindepth 2 -type f -name composer.json -not -path "*/vendor/*" -printf '%h\n' | sed 's/^src\///' | grep -Ev "examples" | sort | tr '\n' ' ') diff --git a/demo/config/packages/ai.yaml b/demo/config/packages/ai.yaml index ed37f2a33..d7117a68f 100644 --- a/demo/config/packages/ai.yaml +++ b/demo/config/packages/ai.yaml @@ -25,10 +25,11 @@ ai: options: temperature: 0.5 prompt: - text: 'Please answer the users question based on Wikipedia and provide a link to the article.' + text: 'Please answer the users question based on Wikipedia, only use information provided in the messages.' include_tools: true tools: - 'Symfony\AI\Agent\Toolbox\Tool\Wikipedia' + include_sources: true audio: model: 'gpt-4o-mini?temperature=1.0' prompt: 'You are a friendly chatbot that likes to have a conversation with users and asks them some questions.' @@ -89,7 +90,7 @@ services: Symfony\AI\Store\Document\Loader\RssFeedLoader: ~ Symfony\AI\Store\Document\Transformer\TextTrimTransformer: ~ - + app.filter.week_of_symfony: class: 'Symfony\AI\Store\Document\Filter\TextContainsFilter' arguments: diff --git a/demo/src/Wikipedia/Chat.php b/demo/src/Wikipedia/Chat.php index cd9736f7a..19ec60f5c 100644 --- a/demo/src/Wikipedia/Chat.php +++ b/demo/src/Wikipedia/Chat.php @@ -43,7 +43,9 @@ public function submitMessage(string $message): void \assert($result instanceof TextResult); - $messages->add(Message::ofAssistant($result->getContent())); + $response = Message::ofAssistant($result->getContent()); + $response->getMetadata()->add('sources', $result->getMetadata()->get('sources', [])); + $messages->add($response); $this->saveMessages($messages); } diff --git a/demo/templates/components/wikipedia.html.twig b/demo/templates/components/wikipedia.html.twig index a187a1706..2e78014a9 100644 --- a/demo/templates/components/wikipedia.html.twig +++ b/demo/templates/components/wikipedia.html.twig @@ -1,4 +1,4 @@ -{% import "_message.html.twig" as message %} +{% import "_message.html.twig" as msg %}
@@ -9,6 +9,16 @@
{% for message in this.messages %} {% include '_message.html.twig' with { message, latest: loop.last } %} + {% if message.metadata.has('sources') %} +
+
Sources:
+
    + {% for source in message.metadata.get('sources') %} +
  1. {{ source.name }}
    2. + {% endfor %} +
+
+ {% endif %} {% else %}
{{ ux_icon('mdi:wikipedia', { height: '200px', width: '200px' }) }} @@ -17,8 +27,8 @@
{% endfor %}
- {{ message.user([{text:''}]) }} - {{ message.bot('The Wikipedia Bot is doing some research ...', true) }} + {{ msg.user([{text:''}]) }} + {{ msg.bot('The Wikipedia Bot is doing some research ...', true) }}
diff --git a/docs/components/agent.rst b/docs/components/agent.rst index 0f7dca91b..5faa19555 100644 --- a/docs/components/agent.rst +++ b/docs/components/agent.rst @@ -318,13 +318,13 @@ Tool Sources ~~~~~~~~~~~~ Some tools bring in data to the agent from external sources, like search engines or APIs. Those sources can be exposed -by enabling `keepToolSources` as argument of the :class:`Symfony\\AI\\Agent\\Toolbox\\AgentProcessor`:: +by enabling `includeSources` as argument of the :class:`Symfony\\AI\\Agent\\Toolbox\\AgentProcessor`:: use Symfony\AI\Agent\Toolbox\AgentProcessor; use Symfony\AI\Agent\Toolbox\Toolbox; $toolbox = new Toolbox([new MyTool()]); - $toolProcessor = new AgentProcessor($toolbox, keepToolSources: true); + $toolProcessor = new AgentProcessor($toolbox, includeSources: true); In the tool implementation sources can be added by implementing the :class:`Symfony\\AI\\Agent\\Toolbox\\Source\\HasSourcesInterface` in combination with the trait diff --git a/examples/anthropic/toolcall.php b/examples/anthropic/toolcall.php index 56c399a18..8d5581ddd 100644 --- a/examples/anthropic/toolcall.php +++ b/examples/anthropic/toolcall.php @@ -24,7 +24,7 @@ $wikipedia = new Wikipedia(http_client()); $toolbox = new Toolbox([$wikipedia], logger: logger()); -$processor = new AgentProcessor($toolbox, keepToolSources: true); +$processor = new AgentProcessor($toolbox, includeSources: true); $agent = new Agent($platform, 'claude-3-5-sonnet-20241022', [$processor], [$processor]); $messages = new MessageBag(Message::ofUser('Who is the current chancellor of Germany?')); diff --git a/src/agent/src/Toolbox/AgentProcessor.php b/src/agent/src/Toolbox/AgentProcessor.php index 50db3e619..c4b43bf84 100644 --- a/src/agent/src/Toolbox/AgentProcessor.php +++ b/src/agent/src/Toolbox/AgentProcessor.php @@ -53,7 +53,7 @@ public function __construct( private readonly ToolResultConverter $resultConverter = new ToolResultConverter(), private readonly ?EventDispatcherInterface $eventDispatcher = null, private readonly bool $keepToolMessages = false, - private readonly bool $keepToolSources = false, + private readonly bool $includeSources = false, ) { } @@ -127,7 +127,7 @@ private function handleToolCallsCallback(Output $output): \Closure } while ($result instanceof ToolCallResult); --$this->nestingLevel; - if ($this->keepToolSources && 0 === $this->nestingLevel) { + if ($this->includeSources && 0 === $this->nestingLevel) { $result->getMetadata()->add('sources', $this->sources); $this->sources = []; } diff --git a/src/agent/tests/Toolbox/AgentProcessorTest.php b/src/agent/tests/Toolbox/AgentProcessorTest.php index 5ea535564..44465ae99 100644 --- a/src/agent/tests/Toolbox/AgentProcessorTest.php +++ b/src/agent/tests/Toolbox/AgentProcessorTest.php @@ -148,7 +148,7 @@ public function testSourcesEndUpInResultMetadataWithSettingOn() ->method('call') ->willReturn(new TextResult('Final response based on the two articles.')); - $processor = new AgentProcessor($toolbox, keepToolSources: true); + $processor = new AgentProcessor($toolbox, includeSources: true); $processor->setAgent($agent); $output = new Output('gpt-4', $result, $messageBag); @@ -181,7 +181,7 @@ public function testSourcesDoNotEndUpInResultMetadataWithSettingOff() ->method('call') ->willReturn(new TextResult('Final response based on the two articles.')); - $processor = new AgentProcessor($toolbox, keepToolSources: false); + $processor = new AgentProcessor($toolbox, includeSources: false); $processor->setAgent($agent); $output = new Output('gpt-4', $result, $messageBag); @@ -220,7 +220,7 @@ public function testSourcesGetCollectedAcrossConsecutiveToolCalls() new DeferredResult(new PlainConverter(new TextResult('Final response based on both articles.')), new InMemoryRawResult()) ); - $processor = new AgentProcessor($toolbox, keepToolSources: true); + $processor = new AgentProcessor($toolbox, includeSources: true); $agent = new Agent($platform, 'foo-bar', [$processor], [$processor]); $processor->setAgent($agent); diff --git a/src/ai-bundle/config/options.php b/src/ai-bundle/config/options.php index 3fb8c9dcd..e115de7f1 100644 --- a/src/ai-bundle/config/options.php +++ b/src/ai-bundle/config/options.php @@ -409,7 +409,18 @@ ->end() ->end() ->end() - ->booleanNode('fault_tolerant_toolbox')->defaultTrue()->end() + ->booleanNode('keep_tool_messages') + ->info('Keep tool messages in the conversation history') + ->defaultFalse() + ->end() + ->booleanNode('include_sources') + ->info('Include sources exposed by tools as part of the tool result metadata') + ->defaultFalse() + ->end() + ->booleanNode('fault_tolerant_toolbox') + ->info('Continue the agent run even if a tool call fails') + ->defaultTrue() + ->end() ->end() ->end() ->end() diff --git a/src/ai-bundle/config/services.php b/src/ai-bundle/config/services.php index e1a35c2fc..a65655771 100644 --- a/src/ai-bundle/config/services.php +++ b/src/ai-bundle/config/services.php @@ -157,6 +157,7 @@ service('ai.tool_result_converter'), service('event_dispatcher')->nullOnInvalid(), false, + false, ]) ->set('ai.security.is_granted_attribute_listener', IsGrantedToolAttributeListener::class) ->args([ diff --git a/src/ai-bundle/src/AiBundle.php b/src/ai-bundle/src/AiBundle.php index 23f72c289..d3b4c9294 100644 --- a/src/ai-bundle/src/AiBundle.php +++ b/src/ai-bundle/src/AiBundle.php @@ -613,7 +613,9 @@ private function processAgentConfig(string $name, array $config, ContainerBuilde } $toolProcessorDefinition = (new ChildDefinition('ai.tool.agent_processor.abstract')) - ->replaceArgument(0, new Reference('ai.toolbox.'.$name)); + ->replaceArgument(0, new Reference('ai.toolbox.'.$name)) + ->replaceArgument(3, $config['keep_tool_messages']) + ->replaceArgument(4, $config['include_sources']); $container->setDefinition('ai.tool.agent_processor.'.$name, $toolProcessorDefinition) ->addTag('ai.agent.input_processor', ['agent' => $agentId, 'priority' => -10]) diff --git a/src/ai-bundle/src/Profiler/DataCollector.php b/src/ai-bundle/src/Profiler/DataCollector.php index fc0f29d15..88e8ac56d 100644 --- a/src/ai-bundle/src/Profiler/DataCollector.php +++ b/src/ai-bundle/src/Profiler/DataCollector.php @@ -12,6 +12,7 @@ namespace Symfony\AI\AiBundle\Profiler; use Symfony\AI\Agent\Toolbox\ToolResult; +use Symfony\AI\Platform\Metadata\Metadata; use Symfony\AI\Platform\Tool\Tool; use Symfony\Bundle\FrameworkBundle\DataCollector\AbstractDataCollector; use Symfony\Component\HttpFoundation\Request; @@ -103,7 +104,8 @@ private function getAllTools(): array * model: string, * input: array|string|object, * options: array, - * result: string|iterable|object|null + * result: string|iterable|object|null, + * metadata: Metadata, * }[] */ private function awaitCallResults(TraceablePlatform $platform): array @@ -118,6 +120,8 @@ private function awaitCallResults(TraceablePlatform $platform): array $call['result'] = $result->getContent(); } + $call['metadata'] = $result->getMetadata(); + $calls[$key] = $call; } diff --git a/src/ai-bundle/templates/data_collector.html.twig b/src/ai-bundle/templates/data_collector.html.twig index 4f0fc7eac..b8cbc9345 100644 --- a/src/ai-bundle/templates/data_collector.html.twig +++ b/src/ai-bundle/templates/data_collector.html.twig @@ -164,6 +164,15 @@ {% else %} {{ call.result }} {% endif %} + {% if call.metadata|length > 0 %} +
+ Metadata +
    + {% for key, value in call.metadata.all %} +
  • {{ key }}:
    {{ dump(value) }}
    • + {% endfor %} +
+ {% endif %}