Skip to content

[AI Bundle] Rename system_prompt to prompt and prompt key to text #579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2025
+46 −46
Merged

[AI Bundle] Rename system_prompt to prompt and prompt key to text #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions demo/config/packages/ai.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ai:
model:
class: 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'
name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI
system_prompt: |
prompt: |
You are an example chat application where messages from the LLM are streamed to the user using
Server-Sent Events via `symfony/ux-turbo` / Turbo Streams. This example does not use any custom
javascript and solely relies on the built-in `live` & `turbo_stream` Stimulus controllers.
Expand All @@ -35,16 +35,16 @@ ai:
name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI
options:
temperature: 0.5
system_prompt:
prompt: 'Please answer the users question based on Wikipedia and provide a link to the article.'
prompt:
text: 'Please answer the users question based on Wikipedia and provide a link to the article.'
include_tools: true
tools:
- 'Symfony\AI\Agent\Toolbox\Tool\Wikipedia'
audio:
model:
class: 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'
name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI
system_prompt: 'You are a friendly chatbot that likes to have a conversation with users and asks them some questions.'
prompt: 'You are a friendly chatbot that likes to have a conversation with users and asks them some questions.'
tools:
# Agent in agent 🤯
- agent: 'blog'
Expand Down
14 changes: 7 additions & 7 deletions src/ai-bundle/config/options.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,32 +130,32 @@
->end()
->end()
->booleanNode('structured_output')->defaultTrue()->end()
->arrayNode('system_prompt')
->arrayNode('prompt')
->info('The system prompt configuration')
->beforeNormalization()
->ifString()
->then(function (string $v) {
return ['prompt' => $v];
return ['text' => $v];
})
->end()
->beforeNormalization()
->ifArray()
->then(function (array $v) {
if (!isset($v['prompt']) && !isset($v['include_tools'])) {
throw new \InvalidArgumentException('Either "prompt" must be configured for system_prompt.');
if (!isset($v['text']) && !isset($v['include_tools'])) {
throw new \InvalidArgumentException('Either "text" must be configured for prompt.');
}

return $v;
})
->end()
->validate()
->ifTrue(function ($v) {
return \is_array($v) && '' === trim($v['prompt'] ?? '');
return \is_array($v) && '' === trim($v['text'] ?? '');
})
->thenInvalid('The "prompt" cannot be empty.')
->thenInvalid('The "text" cannot be empty.')
->end()
->children()
->scalarNode('prompt')
->scalarNode('text')
->info('The system prompt text')
->end()
->booleanNode('include_tools')
Expand Down
12 changes: 6 additions & 6 deletions src/ai-bundle/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ Configuration
model:
class: 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'
name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI
system_prompt: # The system prompt configuration
prompt: 'You are a helpful assistant that can answer questions.' # The prompt text
prompt: # The system prompt configuration
text: 'You are a helpful assistant that can answer questions.' # The prompt text
include_tools: true # Include tool definitions at the end of the system prompt
tools:
# Referencing a service with #[AsTool] attribute
Expand Down Expand Up @@ -158,7 +158,7 @@ For basic usage, specify the system prompt as a simple string:
model:
class: 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'
name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI
system_prompt: 'You are a helpful assistant.'
prompt: 'You are a helpful assistant.'

**Advanced Configuration**

Expand All @@ -172,13 +172,13 @@ For more control, such as including tool definitions in the system prompt, use t
model:
class: 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'
name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI
system_prompt:
prompt: 'You are a helpful assistant that can answer questions.'
prompt:
text: 'You are a helpful assistant that can answer questions.'
include_tools: true # Include tool definitions at the end of the system prompt

The array format supports these options:

* ``prompt`` (string, required): The system prompt text that will be sent to the AI model
* ``text`` (string, required): The system prompt text that will be sent to the AI model
* ``include_tools`` (boolean, optional): When set to ``true``, tool definitions will be appended to the system prompt


Expand Down
6 changes: 3 additions & 3 deletions src/ai-bundle/src/AiBundle.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,12 +604,12 @@ private function processAgentConfig(string $name, array $config, ContainerBuilde
}

// SYSTEM PROMPT
if (isset($config['system_prompt'])) {
$includeTools = isset($config['system_prompt']['include_tools']) && $config['system_prompt']['include_tools'];
if (isset($config['prompt'])) {
$includeTools = isset($config['prompt']['include_tools']) && $config['prompt']['include_tools'];

$systemPromptInputProcessorDefinition = (new Definition(SystemPromptInputProcessor::class))
->setArguments([
$config['system_prompt']['prompt'],
$config['prompt']['text'],
$includeTools ? new Reference('ai.toolbox.'.$name) : null,
new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE),
])
Expand Down
52 changes: 26 additions & 26 deletions src/ai-bundle/tests/DependencyInjection/AiBundleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ public function testProcessorTagsUseFullAgentId()
['service' => 'some_tool', 'description' => 'Test tool'],
],
'structured_output' => true,
'system_prompt' => 'You are a test assistant.',
'prompt' => 'You are a test assistant.',
],
],
],
Expand Down Expand Up @@ -440,14 +440,14 @@ public function testMultipleAgentsWithProcessors()
'tools' => [
['service' => 'tool_one', 'description' => 'Tool for first agent'],
],
'system_prompt' => 'First agent prompt',
'prompt' => 'First agent prompt',
],
'second_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\Anthropic\Claude'],
'tools' => [
['service' => 'tool_two', 'description' => 'Tool for second agent'],
],
'system_prompt' => 'Second agent prompt',
'prompt' => 'Second agent prompt',
],
],
],
Expand Down Expand Up @@ -656,8 +656,8 @@ public function testSystemPromptWithArrayStructure()
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => [
'prompt' => 'You are a helpful assistant.',
'prompt' => [
'text' => 'You are a helpful assistant.',
],
'tools' => [
['service' => 'some_tool', 'description' => 'Test tool'],
Expand All @@ -683,8 +683,8 @@ public function testSystemPromptWithIncludeToolsEnabled()
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => [
'prompt' => 'You are a helpful assistant.',
'prompt' => [
'text' => 'You are a helpful assistant.',
'include_tools' => true,
],
'tools' => [
Expand All @@ -704,16 +704,16 @@ public function testSystemPromptWithIncludeToolsEnabled()
$this->assertSame('ai.toolbox.test_agent', (string) $arguments[1]);
}

#[TestDox('System prompt with only prompt key defaults include_tools to false')]
public function testSystemPromptWithOnlyPromptKey()
#[TestDox('System prompt with only text key defaults include_tools to false')]
public function testSystemPromptWithOnlyTextKey()
{
$container = $this->buildContainer([
'ai' => [
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => [
'prompt' => 'You are a helpful assistant.',
'prompt' => [
'text' => 'You are a helpful assistant.',
],
'tools' => [
['service' => 'some_tool', 'description' => 'Test tool'],
Expand Down Expand Up @@ -756,8 +756,8 @@ public function testValidSystemPromptCreatesProcessor()
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => [
'prompt' => 'Valid prompt',
'prompt' => [
'text' => 'Valid prompt',
'include_tools' => true,
],
'tools' => [
Expand All @@ -777,38 +777,38 @@ public function testValidSystemPromptCreatesProcessor()
$this->assertSame('ai.toolbox.test_agent', (string) $arguments[1]);
}

#[TestDox('Empty prompt in array structure throws configuration exception')]
public function testEmptyPromptInArrayThrowsException()
#[TestDox('Empty text in array structure throws configuration exception')]
public function testEmptyTextInArrayThrowsException()
{
$this->expectException(InvalidConfigurationException::class);
$this->expectExceptionMessage('The "prompt" cannot be empty.');
$this->expectExceptionMessage('The "text" cannot be empty.');

$this->buildContainer([
'ai' => [
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => [
'prompt' => '',
'prompt' => [
'text' => '',
],
],
],
],
]);
}

#[TestDox('System prompt array without prompt key throws configuration exception')]
public function testSystemPromptArrayWithoutPromptKeyThrowsException()
#[TestDox('System prompt array without text key throws configuration exception')]
public function testSystemPromptArrayWithoutTextKeyThrowsException()
{
$this->expectException(InvalidConfigurationException::class);
$this->expectExceptionMessage('The "prompt" cannot be empty.');
$this->expectExceptionMessage('The "text" cannot be empty.');

$this->buildContainer([
'ai' => [
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => [
'prompt' => [
'include_tools' => true,
],
],
Expand All @@ -825,7 +825,7 @@ public function testSystemPromptWithStringFormat()
'agent' => [
'test_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'],
'system_prompt' => 'You are a helpful assistant.',
'prompt' => 'You are a helpful assistant.',
'tools' => [
['service' => 'some_tool', 'description' => 'Test tool'],
],
Expand Down Expand Up @@ -1270,8 +1270,8 @@ private function getFullConfig(): array
],
'structured_output' => false,
'track_token_usage' => true,
'system_prompt' => [
'prompt' => 'You are a helpful assistant.',
'prompt' => [
'text' => 'You are a helpful assistant.',
'include_tools' => true,
],
'tools' => [
Expand All @@ -1285,7 +1285,7 @@ private function getFullConfig(): array
],
'another_agent' => [
'model' => ['class' => 'Symfony\AI\Platform\Bridge\Anthropic\Claude', 'name' => 'claude-3-opus-20240229'],
'system_prompt' => 'Be concise.',
'prompt' => 'Be concise.',
],
],
'store' => [
Expand Down