Add config options for keeping tool call messages and sources + expose metadata in profiler

Author: chr-hertel

.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' ' ')

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'
+            keep_tool_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:

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);
     }

demo/templates/components/wikipedia.html.twig

@@ -1,4 +1,4 @@
-{% import "_message.html.twig" as message %}
+{% import "_message.html.twig" as msg %}
 
 <div class="card mx-auto shadow-lg" {{ attributes.defaults(stimulus_controller('wikipedia')) }}>
     <div class="card-header p-2">
@@ -9,6 +9,16 @@
     <div id="chat-body" class="card-body p-4 overflow-auto">
         {% for message in this.messages %}
             {% include '_message.html.twig' with { message, latest: loop.last } %}
+            {% if message.metadata.has('sources') %}
+                <div class="ms-5">
+                    <h6>Sources:</h6>
+                    <ol>
+                        {% for source in message.metadata.get('sources') %}
+                            <li><a class="text-black-50" href="{{ source.reference }}" target="_blank" rel="noopener">{{ source.name }}</a></li>
+                        {% endfor %}
+                    </ol>
+                </div>
+            {% endif %}
         {% else %}
             <div id="welcome" class="text-center mt-5 py-5 bg-white rounded-5 shadow-sm w-75 mx-auto">
                 {{ ux_icon('mdi:wikipedia', { height: '200px', width: '200px' }) }}
@@ -17,8 +27,8 @@
             </div>
         {% endfor %}
         <div id="loading-message" class="d-none">
-            {{ 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) }}
         </div>
     </div>
     <div class="card-footer p-2">

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('keep_tool_sources')
+                            ->info('Keep tool sources 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()

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([

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['keep_tool_sources']);
 
             $container->setDefinition('ai.tool.agent_processor.'.$name, $toolProcessorDefinition)
                 ->addTag('ai.agent.input_processor', ['agent' => $agentId, 'priority' => -10])

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<mixed>|string|object,
      *     options: array<string, mixed>,
-     *     result: string|iterable<mixed>|object|null
+     *     result: string|iterable<mixed>|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;
         }
 

src/ai-bundle/templates/data_collector.html.twig

@@ -164,6 +164,15 @@
                                         {% else %}
                                             {{ call.result }}
                                         {% endif %}
+                                        {% if call.metadata|length > 0 %}
+                                            <br />
+                                            <strong>Metadata</strong>
+                                            <ul>
+                                                {% for key, value in call.metadata.all %}
+                                                    <li>{{ key }}:<br />{{ dump(value) }}</li>
+                                                {% endfor %}
+                                            </ul>
+                                        {% endif %}
                                     </td>
                                 </tr>
                             </tbody>