From bec4ab008fe3c46573d7addcd17576d7da9b5c31 Mon Sep 17 00:00:00 2001 From: Jeff <33599649+Fu-Jie@users.noreply.github.com> Date: Thu, 12 Jun 2025 23:04:43 +0800 Subject: [PATCH] Update env-configuration.md docs: document env variables for enabling follow-up generation and default prompt template --- docs/getting-started/env-configuration.md | 35 +++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 9bf6c94..4e49820 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -490,6 +490,41 @@ JSON format: { "title": "your concise title here" } - Persistence: This environment variable is a `PersistentConfig` variable. +#### `ENABLE_FOLLOW_UP_GENERATION` + +- Type: `bool` +- Default: `True` +- Description: Enables or disables tag generation. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `FOLLOW_UP_GENERATION_PROMPT_TEMPLATE` + +- Type: `str` +- Description: Prompt to use for generating several relevant follow-up questions. +- Default: The value of `DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE` environment variable. + +`DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE`: + +``` +### Task: +Suggest 3-5 relevant follow-up questions or prompts that the user might naturally ask next in this conversation as a **user**, based on the chat history, to help continue or deepen the discussion. +### Guidelines: +- Write all follow-up questions from the user’s point of view, directed to the assistant. +- Make questions concise, clear, and directly related to the discussed topic(s). +- Only suggest follow-ups that make sense given the chat content and do not repeat what was already covered. +- If the conversation is very short or not specific, suggest more general (but relevant) follow-ups the user might ask. +- Use the conversation's primary language; default to English if multilingual. +- Response must be a JSON array of strings, no extra text or formatting. +### Output: +JSON format: { "follow_ups": ["Question 1?", "Question 2?", "Question 3?"] } +### Chat History: + +{{MESSAGES:END:6}} +" +``` + +- Persistence: This environment variable is a `PersistentConfig` variable. + #### `TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE` - Type: `str`