Prompt

The Prompt is the container for runtime context messages and options passed to the generation provider.

Prompts are responsible for managing the contextual history and providing the necessary information to the generation provider for a meaningful prompt and response cycles.

Prompt Structure

The Prompt is structured to include the following components:

• Messages: An array of messages that represent the contextual information or conversational chat history. Each message includes content, role (user or assistant), and metadata.
• Message: The Action Prompt's rendered message object or hash that contains the content and role of the message. The role can be :user, :system, :assistant, or :tool, but defaults to :user.
• Actions: An array of actions that the agent can perform in response to user input. By default, the prompt will use the agent's action methods, but you can also specify custom actions.

Example Prompt

Prompts are built and rendered in the agent's action methods, typically using the prompt method. This is an example of creating a prompt by manually building the context; assigning actions, message and messages.

prompt = ActiveAgent::ActionPrompt::Prompt.new(
  actions: SupportAgent.new.action_schemas, 
  message: "I need help with my account.",
  messages: [
    { content: "Hello, how can I assist you today?", role: "assistant" },
  ]
)

Rendering Prompts

Prompts can be rendered using the prompt method, which generates the structured prompt object with the provided context.

agent_prompt_context = SupportAgent.with(message: "I need help with my account.", messages: [
  { content: "Hello, how can I assist you today?", role: :assistant },
]).prompt_context