Contrib.social

Add event to allow modules to alter pre-prompt token context

Open on Drupal.org →
Created on 21 March 2025, 14 days ago

Description:

Currently, the AI Assistant API module defines a fixed set of tokens available in system prompts, such as [user_name], [site_name], and [page_path], via the AssistantMessageBuilder::getPrePromptDrupalContext() method.

While the module already provides a PrepromptSystemRoleEvent to alter the generated prompt text, it does not provide a way to alter the context of tokens before replacement. This limits extensibility, as other modules (e.g., personalization, subscription, or user profile modules) cannot inject additional dynamic tokens.

Proposed solution:

Introduce a new Symfony event named AiAssistantPrePromptContextEvent, dispatched inside the getPrePromptDrupalContext() method. This would allow external modules to:

Extend the list of available tokens.
Inject context-specific data (e.g., from user profiles or external services).
Maintain clean separation between context building and prompt generation.

✨ Feature request
Status

Active

Version

1.0

Component

AI Assistants API

Created by

🇵🇫French Polynesia laurentb Tahiti

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @laurentb
  • Comment 14 days ago →
    🇵🇫French Polynesia laurentb Tahiti

    Attached patch adds a new Symfony event (AiAssistantPrePromptContextEvent) to allow modules to alter the pre-prompt context before token replacement. This improves extensibility by allowing dynamic tokens.

    Testing instructions:

    • Apply the patch.
    • Implement an event subscriber to inject custom tokens.
    • Verify that new tokens are available and replaced correctly in the AI Assistant prompts.
  • First commit to issue fork.
  • Comment 14 days ago →
    🇬🇧United Kingdom MrDaleSmith

    Patch doesn't cleanly apply to the fork branch, so will need reworking so that it does to allow testing. It might be worth considering if we need all these separate events or whether they can be consolidated into a single one, possibly in consideration with https://www.drupal.org/project/ai/issues/3506391 ✨ Alter PreGenerateResponseEvent response Active .

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024