KB and UI-engine
The UI Engine is a powerful feature in TIXAE Agents that allows you to create dynamic, interactive elements in your agent’s responses. By integrating the UI-Engine with your knowledge base, you can create more sophisticated and user friendly interfaces. This doc shows you how to effectively combine these two powerful tools.
Instructing Your Agent
Here’s how you can use the system prompt
to instruct your agent to use UI Engine components with information from the knowledge base:
By referring to the knowledge base in your prompt, you can populate it with links, text, and formatting instructions that the model can use in its responses, freeing up space in your system instructions.
Structuring Your Knowledge Base docs
To efficiently retrieve information for UI Engine components, structuring your knowledge base documents for easy retrieval is key
. We recommend the following:
Carousels
Carousels
Carousels can be displayed in every way you want. only pictures, without pictures, without title etc. This makes for many creative use-cases:
Cards
Cards
As well as all other UI elements. Cards can also be heavily customized. Here are some variants you can consider:
Images
Images
Images needs to be pulled from a valid
URL. Makes sure to test this thouroughly before launching you agent. Looking for a hosting service, we recommend imgur.
Iframes
Iframes
Iframes introduces the ability to integrate any
website into you agent. This means you can embed calendly for booking, agent previews inside you agent😯 or show youtube videos with ease. Make sure to test this thoroughly.
Customize for Your Use Case
While these guidelines provide a solid foundation, remember that every knowledge base is unique. Here are some key points to consider:
- Experiment with different structures to find what works best for your specific needs.
- UI elements may require special attention - their optimal format can vary based on your agent.
- Don’t hesitate to iterate and refine your approach over time.
Best Practices
Consistent Formatting
Use consistent formatting across your knowledge base to make it easier for your agent to parse and use the information.
Clear Instructions
Provide clear, specific instructions in your knowledge base on how to use each piece of information.
Regular Updates
Keep your knowledge base up-to-date with the latest product information, images, and formatting instructions.
Test Thoroughly
Regularly test your agent’s responses to ensure it’s correctly using the UI Engine components with the knowledge base information.
Test it out:
Try asking Gia to book an appointment or tell you anything about TIXAE Agents and see the UI-engine in action.