System prompt¶
Before you begin¶
Follow the steps in the Install with Helm topic to run F5 AI Gateway.
Overview¶
The F5 System Prompt processor runs in the AI Gateway processors container and helps to shape prompts. It can be configured add rules as system prompts before being passed to the upstream LLM.
The efficacy of rules specified with this processor will depend on the upstream LLM in use. It is recommended to check the documentation on system prompts for the upstream LLM that you are using, as some upstreams may not support messages with role: system
.
Processor details |
Supported |
---|---|
Yes |
|
No |
|
Input stage |
Yes |
Response stage |
No |
End |
|
Supported language(s) |
N/A |
Configuration¶
processors:
- name: system-prompt
type: external
config:
endpoint: https://aigw-processors-f5.ai-gateway.svc.cluster.local
namespace: f5
version: 1
params:
rules: []
modify: true
Each entry in the rules
list will be added as an individual message with role: system
. It is possible to specify multiple commands in a single message using a multi-line YAML string like the example below.
params:
rules:
- |
Your responsibility is handling returns in an online store
Respond to any queries in English
Note
This processor should be configured to be the final processor in an input stage to avoid conflicts. See processor configuration optimization for more details.
Note
To achieve best results with this processor it is more effective to use system messages that establish the desired role or function rather than instructions that restrict certain topics. By clearly defining how the LLM should behave, you provide more focused guidance that aligns its responses with your objectives.
Parameters¶
Parameters |
Description |
Type |
Required |
Defaults |
Examples |
---|---|---|---|---|---|
|
A list of strings representing the rules which will be applied to the prompt. |
|
No |
“Do not generate anything illegal or dangerous” |
“Only talk about insurance related issues” |
|
When activated, the processor will remove any other messages with |
|
No |
|
|
This processor requires the modify
parameter to be set to true
.