feat: only render profiler bar section if used

chr-hertel · chr-hertel · commit 14d14a7de353 · 2024-12-06T14:02:09.000+01:00
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ composer require php-llm/llm-chain-bundle
 ```yaml
 # config/packages/llm_chain.yaml
 llm_chain:
-    platforms:
+    platform:
         openai:
             api_key: '%env(OPENAI_API_KEY)%'
         azure:
@@ -23,13 +23,15 @@ llm_chain:
             version: '%env(AZURE_OPENAI_VERSION)%'
         anthropic:
             api_key: '%env(ANTHROPIC_API_KEY)%'
-    chains:
+    chain:
         default:
             model:
                 name: 'gpt'
                 version: 'gpt-3.5-turbo'
                 options: []
-    stores:
+            tools:
+                - 'PhpLlm\LlmChain\Chain\ToolBox\Tool\SimilaritySearch'
+    store:
         azure_search:
             api_key: '%env(AZURE_SEARCH_KEY)%'
             endpoint: '%env(AZURE_SEARCH_ENDPOINT)%'
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -33,7 +33,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
-                ->arrayNode('chains')
+                ->arrayNode('chain')
                     ->normalizeKeys(false)
                     ->useAttributeAsKey('name')
                     ->arrayPrototype()
@@ -42,9 +42,14 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->children()
                                     ->scalarNode('name')->isRequired()->end()
                                     ->scalarNode('version')->defaultNull()->end()
-                                    ->arrayNode('options')->end()
+                                    ->arrayNode('options')
+                                        ->scalarPrototype()->end()
+                                    ->end()
                                 ->end()
                             ->end()
+                            ->arrayNode('tools')
+                                ->scalarPrototype()->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()
@@ -63,7 +68,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
-                ->arrayNode('stores')
+                ->arrayNode('store')
                     ->normalizeKeys(false)
                     ->useAttributeAsKey('name')
                     ->arrayPrototype()
diff --git a/src/DependencyInjection/LlmChainExtension.php b/src/DependencyInjection/LlmChainExtension.php
@@ -53,10 +53,10 @@ public function load(array $configs, ContainerBuilder $container): void
             $this->processPlatformConfig($type[0], $config['platform'][$type[0]], $container);
         }
 
-        foreach ($config['chains'] as $chainName => $chain) {
+        foreach ($config['chain'] as $chainName => $chain) {
             $this->processChainConfig($chainName, $chain, $container);
         }
-        if (1 === count($config['chains']) && isset($chainName)) {
+        if (1 === count($config['chain']) && isset($chainName)) {
             $container->setAlias(ChainInterface::class, 'llm_chain.chain.'.$chainName);
         }
 
@@ -67,10 +67,10 @@ public function load(array $configs, ContainerBuilder $container): void
             $container->setAlias(Embedder::class, 'llm_chain.embedder.'.$embedderName);
         }
 
-        foreach ($config['stores'] as $storeName => $store) {
+        foreach ($config['store'] as $storeName => $store) {
             $this->processStoreConfig($storeName, $store, $container);
         }
-        if (1 === count($config['stores']) && isset($storeName)) {
+        if (1 === count($config['store']) && isset($storeName)) {
             $container->setAlias(VectorStoreInterface::class, 'llm_chain.store.'.$storeName);
             $container->setAlias(StoreInterface::class, 'llm_chain.store.'.$storeName);
         }
@@ -123,6 +123,7 @@ private function processPlatformConfig(string $type, array $platform, ContainerB
      */
     private function processChainConfig(string $name, array $config, ContainerBuilder $container): void
     {
+        // MODEL
         ['name' => $modelName, 'version' => $version, 'options' => $options] = $config['model'];
 
         $llmClass = match (strtolower($modelName)) {
@@ -138,10 +139,35 @@ private function processChainConfig(string $name, array $config, ContainerBuilde
             ]);
         $container->setDefinition('llm_chain.chain.'.$name.'.llm', $llmDefinition);
 
-        $definition = (new ChildDefinition('llm_chain.chain.abstract'))
+        // CHAIN
+        $chainDefinition = (new ChildDefinition('llm_chain.chain.abstract'))
             ->replaceArgument('$llm', new Reference('llm_chain.chain.'.$name.'.llm'));
 
-        $container->setDefinition('llm_chain.chain.'.$name, $definition);
+        // TOOL & PROCESSOR
+        if (isset($config['tools'])) {
+            $tools = array_map(static fn (string $tool) => new Reference($tool), $config['tools']);
+            $toolboxDefinition = (new ChildDefinition('llm_chain.toolbox.abstract'))
+                ->replaceArgument('$tools', $tools);
+            $container->setDefinition('llm_chain.toolbox.'.$name, $toolboxDefinition);
+
+            if ($container->getParameter('kernel.debug')) {
+                $traceableToolboxDefinition = (new Definition('llm_chain.traceable_toolbox.'.$name))
+                    ->setClass(TraceableToolBox::class)
+                    ->setAutowired(true)
+                    ->setDecoratedService('llm_chain.toolbox.'.$name)
+                    ->addTag('llm_chain.traceable_toolbox');
+                $container->setDefinition('llm_chain.traceable_toolbox.'.$name, $traceableToolboxDefinition);
+            }
+
+            $toolProcessorDefinition = (new ChildDefinition('llm_chain.tool.chain_processor.abstract'))
+                ->replaceArgument('$toolBox', new Reference('llm_chain.toolbox.'.$name));
+            $container->setDefinition('llm_chain.tool.chain_processor.'.$name, $toolProcessorDefinition);
+
+            $chainDefinition->replaceArgument('$inputProcessor', [new Reference('llm_chain.tool.chain_processor.'.$name)]);
+            $chainDefinition->replaceArgument('$outputProcessor', [new Reference('llm_chain.tool.chain_processor.'.$name)]);
+        }
+
+        $container->setDefinition('llm_chain.chain.'.$name, $chainDefinition);
     }
 
     /**
diff --git a/src/Profiler/DataCollector.php b/src/Profiler/DataCollector.php
@@ -5,7 +5,9 @@
 namespace PhpLlm\LlmChainBundle\Profiler;
 
 use PhpLlm\LlmChain\Chain\ToolBox\Metadata;
+use PhpLlm\LlmChain\Chain\ToolBox\ToolBoxInterface;
 use Symfony\Bundle\FrameworkBundle\DataCollector\AbstractDataCollector;
+use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -15,18 +17,29 @@
  */
 final class DataCollector extends AbstractDataCollector
 {
+    /**
+     * @var TraceableToolBox[]
+     */
+    private array $toolBoxes;
+
+    /**
+     * @param TraceableToolBox[] $toolBoxes
+     */
     public function __construct(
         private readonly TraceablePlatform $platform,
-        private readonly TraceableToolBox $toolBox,
+        private readonly ToolBoxInterface $defaultToolBox,
+        #[TaggedIterator('llm_chain.traceable_toolbox')]
+        iterable $toolBoxes,
     ) {
+        $this->toolBoxes = $toolBoxes instanceof \Traversable ? iterator_to_array($toolBoxes) : $toolBoxes;
     }
 
     public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
     {
         $this->data = [
-            'tools' => $this->toolBox->getMap(),
+            'tools' => $this->defaultToolBox->getMap(),
             'platform_calls' => $this->platform->calls,
-            'tool_calls' => $this->toolBox->calls,
+            'tool_calls' => array_merge(...array_map(fn (TraceableToolBox $toolBox) => $toolBox->calls, $this->toolBoxes)),
         ];
     }
 
diff --git a/src/Profiler/TraceableToolBox.php b/src/Profiler/TraceableToolBox.php
@@ -16,23 +16,23 @@
 final class TraceableToolBox implements ToolBoxInterface
 {
     /**
-     * @var list<ToolCallData>
+     * @var ToolCallData[]
      */
     public array $calls = [];
 
     public function __construct(
-        private ToolBoxInterface $toolRegistry,
+        private ToolBoxInterface $toolBox,
     ) {
     }
 
     public function getMap(): array
     {
-        return $this->toolRegistry->getMap();
+        return $this->toolBox->getMap();
     }
 
     public function execute(ToolCall $toolCall): string
     {
-        $result = $this->toolRegistry->execute($toolCall);
+        $result = $this->toolBox->execute($toolCall);
 
         $this->calls[] = [
             'call' => $toolCall,
diff --git a/src/Resources/config/services.php b/src/Resources/config/services.php
@@ -5,8 +5,6 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use PhpLlm\LlmChain\Chain;
-use PhpLlm\LlmChain\Chain\InputProcessor;
-use PhpLlm\LlmChain\Chain\OutputProcessor;
 use PhpLlm\LlmChain\Chain\StructuredOutput\ChainProcessor as StructureOutputProcessor;
 use PhpLlm\LlmChain\Chain\StructuredOutput\ResponseFormatFactory;
 use PhpLlm\LlmChain\Chain\StructuredOutput\ResponseFormatFactoryInterface;
@@ -29,11 +27,6 @@
     $container->services()
         ->defaults()
             ->autowire()
-            ->autoconfigure()
-        ->instanceof(InputProcessor::class)
-            ->tag('llm_chain.chain.input_processor')
-        ->instanceof(OutputProcessor::class)
-            ->tag('llm_chain.chain.output_processor')
         ->instanceof(ModelClient::class)
             ->tag('llm_chain.platform.model_client')
         ->instanceof(ResponseConverter::class)
@@ -66,20 +59,39 @@
         ->set(StructureOutputProcessor::class)
 
         // tools
+        ->set('llm_chain.toolbox.abstract')
+            ->class(ToolBox::class)
+            ->abstract()
+            ->args([
+                '$tools' => abstract_arg('Collection of tools'),
+            ])
         ->set(ToolBox::class)
+            ->parent('llm_chain.toolbox.abstract')
             ->args([
                 '$tools' => tagged_iterator('llm_chain.tool'),
             ])
             ->alias(ToolBoxInterface::class, ToolBox::class)
         ->set(ToolAnalyzer::class)
         ->set(ParameterAnalyzer::class)
+        ->set('llm_chain.tool.chain_processor.abstract')
+            ->class(ToolProcessor::class)
+            ->abstract()
+            ->args([
+                '$toolBox' => abstract_arg('Tool box'),
+            ])
         ->set(ToolProcessor::class)
+            ->parent('llm_chain.tool.chain_processor.abstract')
+            ->args([
+                '$toolBox' => service(ToolBoxInterface::class),
+            ])
 
         // profiler
         ->set(DataCollector::class)
+            ->tag('data_collector')
         ->set(TraceablePlatform::class)
             ->decorate(Platform::class)
         ->set(TraceableToolBox::class)
-            ->decorate(ToolBox::class)
+            ->decorate(ToolBoxInterface::class)
+            ->tag('llm_chain.traceable_toolbox')
     ;
 };
diff --git a/src/Resources/views/data_collector.html.twig b/src/Resources/views/data_collector.html.twig
@@ -1,36 +1,39 @@
 {% extends '@WebProfiler/Profiler/layout.html.twig' %}
 
 {% block toolbar %}
-    {% set icon %}
-        {{ include('@LlmChain/icon.svg', { y: 18 }) }}
-        <span class="sf-toolbar-value">{{ collector.platformCalls|length }}</span>
-        <span class="sf-toolbar-info-piece-additional-detail">
-            <span class="sf-toolbar-label">calls</span>
-        </span>
-    {% endset %}
+    {% if collector.platformCalls|length > 0 %}
+        {% set icon %}
+            {{ include('@LlmChain/icon.svg', { y: 18 }) }}
+            <span class="sf-toolbar-value">{{ collector.platformCalls|length }}</span>
+            <span class="sf-toolbar-info-piece-additional-detail">
+                <span class="sf-toolbar-label">calls</span>
+            </span>
+        {% endset %}
 
-    {% set text %}
-        <div class="sf-toolbar-info-piece">
+        {% set text %}
             <div class="sf-toolbar-info-piece">
-                <b class="label">Configured Platforms</b>
-                <span class="sf-toolbar-status">1</span>
-            </div>
-            <div class="sf-toolbar-info-piece">
-                <b class="label">Platform Calls</b>
-                <span class="sf-toolbar-status">{{ collector.platformCalls|length }}</span>
-            </div>
-            <div class="sf-toolbar-info-piece">
-                <b class="label">Registered Tools</b>
-                <span class="sf-toolbar-status">{{ collector.tools|length }}</span>
-            </div>
-            <div class="sf-toolbar-info-piece">
-                <b class="label">Tool Calls</b>
-                <span class="sf-toolbar-status">{{ collector.toolCalls|length }}</span>
+                <div class="sf-toolbar-info-piece">
+                    <b class="label">Configured Platforms</b>
+                    <span class="sf-toolbar-status">1</span>
+                </div>
+                <div class="sf-toolbar-info-piece">
+                    <b class="label">Platform Calls</b>
+                    <span class="sf-toolbar-status">{{ collector.platformCalls|length }}</span>
+                </div>
+                <div class="sf-toolbar-info-piece">
+                    <b class="label">Registered Tools</b>
+                    <span class="sf-toolbar-status">{{ collector.tools|length }}</span>
+                </div>
+                <div class="sf-toolbar-info-piece">
+                    <b class="label">Tool Calls</b>
+                    <span class="sf-toolbar-status">{{ collector.toolCalls|length }}</span>
+                </div>
             </div>
-        </div>
-    {% endset %}
+        {% endset %}
+
+        {{ include('@WebProfiler/Profiler/toolbar_item.html.twig', { 'link': true }) }}
 
-    {{ include('@WebProfiler/Profiler/toolbar_item.html.twig', { 'link': true }) }}
+    {% endif %}
 {% endblock %}
 
 {% block menu %}

Original file line number	Diff line number	Diff line change
`@@ -16,23 +16,23 @@`
`16`	`16`	`final class TraceableToolBox implements ToolBoxInterface`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`		`- * @var list<ToolCallData>`
	`19`	`+ * @var ToolCallData[]`
`20`	`20`	`*/`
`21`	`21`	`public array $calls = [];`
`22`	`22`
`23`	`23`	`public function __construct(`
`24`		`- private ToolBoxInterface $toolRegistry,`
	`24`	`+ private ToolBoxInterface $toolBox,`
`25`	`25`	`) {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`public function getMap(): array`
`29`	`29`	`{`
`30`		`- return $this->toolRegistry->getMap();`
	`30`	`+ return $this->toolBox->getMap();`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public function execute(ToolCall $toolCall): string`
`34`	`34`	`{`
`35`		`- $result = $this->toolRegistry->execute($toolCall);`
	`35`	`+ $result = $this->toolBox->execute($toolCall);`
`36`	`36`
`37`	`37`	`$this->calls[] = [`
`38`	`38`	`'call' => $toolCall,`