HomeGuidesSDK ExamplesAnnouncementsCommunity
Guides
Start typing to search…

System Prompt

Managing Assistant System Prompts

Older system prompts incorporate all values in the system prompt portion of the assistant settings. New system prompts leverage prompt variables - placeholder prompt variables, which are completed with metadata when rendering the prompt in chat. The prompt variables in newer versions can be configured in "prompt variables" in the assistant settings part of the product.

Working with Existing Assistants

When managing an existing assistant, you can configure the system prompt through the assistant settings:

  • Navigate to Assistant Settings → System Prompt
  • Edit the prompt directly in this section

New Assistant System Prompts

Newly created assistants automatically include the latest system prompt version recommended by AnswerRocket. To obtain the most current system prompt template:

  1. Create a new assistant
  2. Copy the default system prompt
  3. Use this template to update older assistant prompts if needed

Updating Older System Prompts

When updating older assistant prompts, ensure you preserve all critical configuration information:

  • Persona definitions
  • Skill selection parameters
  • Parameter selection rules
  • Answer guidance instructions

Transfer these elements to the Prompt Variables settings area when implementing the new prompt template.

Best Practices

The recommended approach for system prompt management:

  1. Use the latest base prompt provided by AnswerRocket as your foundation
  2. Complete the Prompt Variables section with information specific to your assistant
  3. Keep assistant-specific customizations separate from the base prompt structure

This approach ensures you benefit from AnswerRocket's latest prompt improvements while maintaining your custom configurations.

Architecture Overview

The system prompt management feature operates across three distinct phases of the conversation pipeline:

  1. Function Selection
  2. Parameter Selection
  3. Answer Generation

Each phase can be independently customized to optimize the AI's behavior for specific use cases and requirements.

Available Variables

Temporal Variables

  • {{copilot_dataset_end_date}}: Dataset cutoff date in YYYY-MM-DD format
  • {{today}}: Current date in YYYY-MM-DD format
  • {{quarter}}: Current calendar quarter (1-4)

Context Variables

  • {{hints}}: Contextual hints for the current question (if configured)
  • {{user__full_query}}: Original user question
  • {{user_chat_question_with_context}}: Contextualized version of the user question
  • {{stage}}: Current pipeline stage ("Function Selection" or "Parameter Selection")

System State Variables

  • {{active_tool}}: Current skill information

    • Name
    • Description

  • {{datasets}}: Available dataset information

    • Name
    • Description
    • Dimensions
      • Sample values
      • Mapped values
    • Metrics

  • {{pipeline.tools}}: Available skills

    • Name
    • Description

Pipeline Stages

1. Function Selection

Purpose

Customize how the system interprets user queries and selects appropriate functions based on available skills.

Example Usage

During {{stage}}, evaluate {{user__full_query}} against available tools:
{{pipeline.tools}}

Consider these hints for context:
{{hints}}

2. Parameter Selection

Purpose

Define specific prompting for parameter identification and validation based on the selected function.

Example Usage

For {{active_tool.Name}}, identify required parameters from:
{{user_chat_question_with_context}}

Available datasets:
{{datasets}}

3. Answer Generation

Purpose

Control how responses are formulated and presented to users.

Example Usage

Generate response using data until {{copilot_dataset_end_date}}
Current quarter: {{quarter}}

Dynamic Content Generation

The system automatically adapts prompts based on:

  1. Available Skills

    • Dynamically updates available functions
    • Maintains consistency with system capabilities

  2. Connected Datasets

    • Incorporates current data context
    • Ensures responses align with available data

  3. Context Requirements

    • Adapts to conversation flow
    • Maintains contextual relevance

Best Practices

Variable Usage

  1. Always validate temporal variables against dataset limitations
  2. Use context variables to maintain conversation coherence
  3. Leverage system state variables for accurate function selection

Prompt Design

  1. Keep prompts focused and specific to each pipeline stage
  2. Include relevant context without overwhelming the system
  3. Use clear, unambiguous language

Performance Optimization

  1. Minimize redundant variable usage
  2. Structure prompts for efficient processing
  3. Regular testing and refinement of prompt effectiveness

Implementation Example

Here's a complete example of stage-specific prompt configuration:

# Function Selection Stage
WHEN {{stage}} == "Function Selection":
Given {{user__full_query}}, select the most appropriate tool from:
{{pipeline.tools}}
Consider data availability until {{copilot_dataset_end_date}}

# Parameter Selection Stage
WHEN {{stage}} == "Parameter Selection":
For {{active_tool.Name}}, extract parameters from:
{{user_chat_question_with_context}}
Using available datasets:
{{datasets}}

Troubleshooting

Common issues and their solutions:

  1. Inconsistent Function Selection

    • Review function selection prompt
    • Verify tool descriptions are clear
    • Check hint relevance

  2. Parameter Extraction Issues

    • Validate dataset availability
    • Verify parameter format requirements
    • Check context preservation

  3. Response Generation Problems

    • Confirm temporal variable accuracy
    • Verify data freshness
    • Review context handling

Updated about 2 months ago