Clickable link in responses

Objective: This guide explains how to configure your AI agent to include links directly within its responses, enhancing clarity and user accessibility.

---

Why Include Links in Responses?

Providing links directly within the AI agent's responses allows users to access relevant resources seamlessly. Rather than showing links as separate answer sources, embedding them within the response text improves usability and contextual relevance.

---

Steps to Configure Links in Responses

Base system prompts

1. Update the System Prompt:

   • Navigate to the Update section of your AI agent settings.

   • Locate the base system prompt.

   • Add the following instruction:

     • "Include website links at the end of your answers when applicable."

   • Save the changes by clicking Update AI Agent and retrain the agent if necessary.

2. Test the Configuration:

   • Ask the AI agent a question that requires a linked response (e.g., “How much does {YOUR SERVICE NAME} cost?”).

   • Verify that the response includes a clickable link, such as:

     • "For more details, you can visit {YOUR WEBSITE DOMAIN}."

3. Handling Knowledge Base Data:

   • Ensure the knowledge base contains links associated with relevant data.

   • If the scraped information already includes links, no further action is required.

   • If links are missing, manually add them to the knowledge base using markdown text (e.g., *"Glossary"").

---

Example Scenarios

1. Answer with Link Embedded:

   • Question: "Where is the glossary located?"

   • Response: "The glossary can be found at this link."

2. Answer Without Links:

   • If you prefer not to include links, remove the instruction from the base system prompt. The response will omit links and display plain text instead.

---

Debugging and Verifying Links

1. Use Debug Mode:

   • Enable Debug Mode to review the data sent to OpenAI.

   • Check that links are properly formatted and included in the semantic search results.

2. Verify Link Formatting:

   • Links should be added in markdown format to ensure they render correctly in responses.

     • Example: "Glossary"

3. Address Missing Links:

   • If a link does not appear in a response, confirm the following:

     • The knowledge base entry includes the link.

     • The scraped data or manually added entries use the correct formatting.

Debug mode

---

Best Practices for Link Integration

1. Ensure Relevance:

   • Only include links that are directly relevant to the question being asked.

2. Optimize Knowledge Base Entries:

   • Make sure all entries with links are clear and descriptive.

   • Use consistent formatting to avoid confusion.

3. Communicate Multilingual Support:

   • If the chatbot supports multiple languages, ensure links are language-specific where applicable.

4. Test Regularly:

   • Periodically test the AI agent to ensure links remain accurate and functional.