You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
minor #751 [Docs] Improve the overall documentation (OskarStark)
This PR was squashed before being merged into the main branch.
Discussion
----------
[Docs] Improve the overall documentation
| Q | A
| ------------- | ---
| Bug fix? | no
| New feature? | no
| Docs? | yes
| Issues | --
| License | MIT
Commits
-------
69a69ae [Docs] Improve the overall documentation
The system prompt text will be automatically translated using the configured translator service. If no translation domain is specified, the default domain will be used.
369
+
The system prompt text will be automatically translated using the configured translator service.
370
+
If no translation domain is specified, the default domain will be used.
369
371
370
372
Memory Provider Configuration
371
373
-----------------------------
@@ -434,7 +436,8 @@ Memory can work independently or alongside the system prompt:
434
436
Custom Memory Provider Requirements
435
437
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
436
438
437
-
When using a service reference, the memory service must implement the ``Symfony\AI\Agent\Memory\MemoryProviderInterface``::
439
+
When using a service reference, the memory service must implement the
The ``fallback`` parameter (required) specifies an agent to handle requests that don't match any handoff rules. This ensures all requests have a proper handler.
590
565
591
566
How It Works
@@ -636,7 +611,7 @@ This is useful for testing platform configurations and quick interactions with A
636
611
``ai:agent:call``
637
612
~~~~~~~~~~~~~~~~~
638
613
639
-
The ``ai:agent:call`` command (alias: ``ai:chat``) provides an interactive chat interface to communicate with configured agents.
614
+
The ``ai:agent:call`` command provides an interactive chat interface to communicate with configured agents.
640
615
This is useful for testing agent configurations, tools, and conversational flows.
641
616
642
617
.. code-block:: terminal
@@ -724,7 +699,7 @@ Usage
724
699
Agent Service
725
700
~~~~~~~~~~~~~
726
701
727
-
Use the `Agent` service to leverage models and tools::
702
+
Use the :class:`Symfony\\AI\\Agent\\Agent` service to leverage models and tools::
728
703
729
704
use Symfony\AI\Agent\AgentInterface;
730
705
use Symfony\AI\Platform\Message\Message;
@@ -751,11 +726,11 @@ Use the `Agent` service to leverage models and tools::
751
726
Register Processors
752
727
~~~~~~~~~~~~~~~~~~~
753
728
754
-
By default, all services implementing the ``InputProcessorInterface`` or the
755
-
``OutputProcessorInterface`` interfaces are automatically applied to every ``Agent``.
729
+
By default, all services implementing the :class:`Symfony\\AI\\Agent\\InputProcessorInterface` or the
730
+
:class:`Symfony\\AI\\Agent\\OutputProcessorInterface` interfaces are automatically applied to every :class:`Symfony\\AI\\Agent\\Agent`.
756
731
757
-
This behavior can be overridden/configured with the ``#[AsInputProcessor]`` and
758
-
the ``#[AsOutputProcessor]`` attributes::
732
+
This behavior can be overridden/configured with the :class:`Symfony\\AI\\AiBundle\\Attribute\\AsInputProcessor` and
733
+
the :class:`Symfony\\AI\\AiBundle\\Attribute\\AsOutputProcessor` attributes::
759
734
760
735
use Symfony\AI\Agent\Input;
761
736
use Symfony\AI\Agent\InputProcessorInterface;
@@ -804,7 +779,7 @@ To use existing tools, you can register them as a service:
804
779
Symfony\AI\Agent\Toolbox\Tool\Brave:
805
780
$apiKey: '%env(BRAVE_API_KEY)%'
806
781
807
-
Custom tools can be registered by using the ``#[AsTool]`` attribute::
782
+
Custom tools can be registered by using the :class:`Symfony\\AI\\Agent\\Toolbox\\Attribute\\AsTool` attribute::
808
783
809
784
use Symfony\AI\Agent\Toolbox\Attribute\AsTool;
810
785
@@ -838,8 +813,8 @@ To inject only specific tools, list them in the configuration:
0 commit comments