docs: split into components

Author: chr-hertel

README.md

@@ -20,7 +20,7 @@ composer install
 #### Configuration
 
 Depending on the examples you want to run, you may need to configure the needed API keys. Therefore, you need to create a
-`.env.local` file in the root of the examples directory. This file should contain the environment variables for the
+`.env.local` file in the root of the examples' directory. This file should contain the environment variables for the
 corresponding example you want to run.
 
 _Now you can run examples standalone or via the example runner._

examples/README.md

@@ -0,0 +1,20 @@
+# Symfony AI - Agent Component
+
+The Agent component provides a framework for building AI agents that, sits on top of the Platform and Store components,
+allowing you to create agents that can interact with users, perform tasks, and manage workflows.
+
+## Installation
+
+```bash
+composer require symfony/ai-agent
+```
+
+**This repository is a READ-ONLY sub-tree split**. See
+https://github.com/symfony/ai to create issues or submit pull requests.
+
+## Resources
+
+- [Documentation](doc/index.rst)
+- [Report issues](https://github.com/symfony/ai/issues) and
+  [send Pull Requests](https://github.com/symfony/ai/pulls)
+  in the [main Symfony AI repository](https://github.com/symfony/ai)

src/agent/README.md

@@ -0,0 +1,14 @@
+Symfony AI - Agent Component
+============================
+
+The Agent component provides a framework for building AI agents that, sits on top of the Platform and Store components,
+allowing you to create agents that can interact with users, perform tasks, and manage workflows.
+
+Installation
+------------
+
+Install the component using Composer:
+
+.. code-block:: terminal
+
+    $ composer require symfony/ai-agent

src/agent/doc/index.rst

@@ -8,169 +8,12 @@ Integration bundle for Symfony AI components.
 composer require symfony/ai-bundle
 ```
 
-## Configuration
+**This repository is a READ-ONLY sub-tree split**. See
+https://github.com/symfony/ai to create issues or submit pull requests.
 
-### Simple Example with OpenAI
+## Resources
 
-```yaml
-# config/packages/ai.yaml
-ai:
-    platform:
-        openai:
-            api_key: '%env(OPENAI_API_KEY)%'
-    agent:
-        default:
-            model:
-                name: 'GPT'
-```
-
-### Advanced Example with Anthropic, Azure, Google and multiple agents
-```yaml
-# config/packages/ai.yaml
-ai:
-    platform:
-        anthropic:
-            api_key: '%env(ANTHROPIC_API_KEY)%'
-        azure:
-            # multiple deployments possible
-            gpt_deployment:
-                base_url: '%env(AZURE_OPENAI_BASEURL)%'
-                deployment: '%env(AZURE_OPENAI_GPT)%'
-                api_key: '%env(AZURE_OPENAI_KEY)%'
-                api_version: '%env(AZURE_GPT_VERSION)%'
-        google:
-            api_key: '%env(GOOGLE_API_KEY)%'
-    agent:
-        rag:
-            platform: 'symfony_ai.platform.azure.gpt_deployment'
-            structured_output: false # Disables support for "output_structure" option, default is true
-            model:
-                name: 'GPT'
-                version: 'gpt-4o-mini'
-            system_prompt: 'You are a helpful assistant that can answer questions.' # The default system prompt of the agent
-            include_tools: true # Include tool definitions at the end of the system prompt
-            tools:
-                # Referencing a service with #[AsTool] attribute
-                - 'Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch'
-
-                # Referencing a service without #[AsTool] attribute
-                - service: 'App\Agent\Tool\CompanyName'
-                  name: 'company_name'
-                  description: 'Provides the name of your company'
-                  method: 'foo' # Optional with default value '__invoke'
-
-                # Referencing a agent => agent in agent 🤯
-                - service: 'symfony_ai.agent.research'
-                  name: 'wikipedia_research'
-                  description: 'Can research on Wikipedia'
-                  is_agent: true
-        research:
-            platform: 'symfony_ai.platform.anthropic'
-            model:
-                name: 'Claude'
-            tools: # If undefined, all tools are injected into the agent, use "tools: false" to disable tools.
-                - 'Symfony\AI\Agent\Toolbox\Tool\Wikipedia'
-            fault_tolerant_toolbox: false # Disables fault tolerant toolbox, default is true
-    store:
-        # also azure_search, mongodb and pinecone are supported as store type
-        chroma_db:
-            # multiple collections possible per type
-            default:
-                collection: 'my_collection'
-    embedder:
-        default:
-            # platform: 'symfony_ai.platform.anthropic'
-            # store: 'symfony_ai.store.chroma_db.default'
-            model:
-                name: 'Embeddings'
-                version: 'text-embedding-ada-002'
-```
-
-## Usage
-
-### Agent Service
-
-Use the `Agent` service to leverage models and tools:
-```php
-use Symfony\AI\Agent\AgentInterface;
-use Symfony\AI\Platform\Message\Message;
-use Symfony\AI\Platform\Message\MessageBag;
-
-final readonly class MyService
-{
-    public function __construct(
-        private AgentInterface $agent,
-    ) {
-    }
-
-    public function submit(string $message): string
-    {
-        $messages = new MessageBag(
-            Message::forSystem('Speak like a pirate.'),
-            Message::ofUser($message),
-        );
-
-        return $this->agent->call($messages);
-    }
-}
-```
-
-### Register Tools
-
-To use existing tools, you can register them as a service:
-```yaml
-services:
-    _defaults:
-        autowire: true
-        autoconfigure: true
-
-    Symfony\AI\Agent\Toolbox\Tool\Clock: ~
-    Symfony\AI\Agent\Toolbox\Tool\OpenMeteo: ~
-    Symfony\AI\Agent\Toolbox\Tool\SerpApi:
-        $apiKey: '%env(SERP_API_KEY)%'
-    Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch: ~
-    Symfony\AI\Agent\Toolbox\Tool\Tavily:
-      $apiKey: '%env(TAVILY_API_KEY)%'
-    Symfony\AI\Agent\Toolbox\Tool\Wikipedia: ~
-    Symfony\AI\Agent\Toolbox\Tool\YouTubeTranscriber: ~
-```
-
-Custom tools can be registered by using the `#[AsTool]` attribute:
-
-```php
-use Symfony\AI\Agent\Toolbox\Attribute\AsTool;
-
-#[AsTool('company_name', 'Provides the name of your company')]
-final class CompanyName
-{
-    public function __invoke(): string
-    {
-        return 'ACME Corp.'
-    }
-}
-```
-
-The agent configuration by default will inject all known tools into the agent.
-
-To disable this behavior, set the `tools` option to `false`:
-```yaml
-ai:
-    agent:
-        my_agent:
-            tools: false
-```
-
-To inject only specific tools, list them in the configuration:
-```yaml
-ai:
-    agent:
-        my_agent:
-            tools:
-                - 'Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch'
-```
-
-### Profiler
-
-The profiler panel provides insights into the agent's execution:
-
-![Profiler](./profiler.png)
+- [Documentation](doc/index.rst)
+- [Report issues](https://github.com/symfony/ai/issues) and
+  [send Pull Requests](https://github.com/symfony/ai/pulls)
+  in the [main Symfony AI repository](https://github.com/symfony/ai)