Skip to main content

Best Practices for Formatting Knowledge documents

 

Explore key best practices for creating effective AI agents

 

Welcome to the Chatislav AI Agents platform, where creating powerful, purpose-built conversational AI has never been more accessible. Whether you're building customer service or sales assistants, specialized knowledge workers, or creative companions, this guide will walk you through proven practices to ensure your agents deliver exceptional experiences.

Chatislav's agent-building framework empowers both technical and non-technical users to define intelligent assistants that can understand context, maintain consistent personalities, and deliver value across a wide range of use cases. By following these best practices, you'll avoid common pitfalls and create agents that effectively represent your brand, knowledge, and objectives.

In this guide, we'll cover from onceptualizing your agent's behavior to fine-tuning its responses and measuring its effectiveness.

 

Agent Instructions section

 

Overview

The Agent Instructions section (found under AI Agent > Settings >Agent Instructions) allows you to define specific rules and behaviors for your AI agent using natural language commands. This powerful configuration area lets you customize how your agent interacts with users, presents information, and handles media content.

Purpose

In this section, you can provide detailed instructions in your own wording that guide how the agent should respond, format information, display media, and handle specific types of queries. These instructions act as a personalized rulebook for your agent's behavior.

 

Key Features​

 

Media Embedding

Control how your agent displays images and videos in conversations:

 

Image Display Example:

If user asks for picture or how some area looks like, if you have image in your context, show it to user using html <img> tag for showing images centered, and specify width of max 250px.

 

Multiple Image Handling:

If there are more photos to show, between them make at least 10px separation.

 

YouTube Video Embedding:

If user asks about some product and you have youtube video of it, show to user that youtube video, like this:

<iframe src="https://www.youtube.com/embed/VIDEO ID" frameborder="0" allowfullscreen />

 

Response Formatting

Define specific formats for different types of information:

 

Working Hours Format:

When someone asks for working hours show it in formated way

 

Comparison Format:

For every comparison show it in table.

 

Product Information Format:

When user asks about some specific product (not for general product information) you must use this format for your response:

**<name of product>**

<product desctiption>

<product usage instructions(brief version with bolded label)>

- <product price>

*- <product packaging info> * <img ...centered

 

Best Practices​

Be Specific

Provide clear, specific instructions that leave little room for interpretation. Include examples where helpful.

 

Consider User Experience

Think about how information will be presented to your users and create instructions that enhance readability and usability.

 

Test Your Instructions

After setting up your agent instructions, test different scenarios to ensure the agent behaves as expected.

 

Use Natural Language

Write instructions in natural language - the system is designed to understand your intent without requiring special syntax or programming knowledge.

 

Layer Instructions Logically

Structure your instructions from general behaviors to specific cases, allowing the agent to follow a consistent decision-making process.

 

Implementation Tips

  1. Start Simple: Begin with basic instructions and gradually add complexity as needed.

  2. Be Consistent: Ensure your instructions don't contradict each other.

  3. Update as Needed: Revisit and refine your instructions based on how your agent performs in real conversations.

  4. Use Conditional Statements: Instructions like "If user asks about X, then do Y" help create responsive agent behavior.

  5. Specify Priority: For potentially conflicting instructions, indicate which should take precedence.

 

FAQ Section​

Overview

The FAQ Section (found under AI Agent > Training > FAQ tab) provides a versatile tool for training your AI agent with structured information. While primarily designed for traditional frequently asked questions,this feature offers powerful capabilities for organizing additional information related to your businesses, prducts, categories, and anything else.

 

Key Features

3000 Character Capacity

Each FAQ entry allows up to 3000 characters, providing ample space for comprehensive information. This generous limit enables for instance, detailed product descriptions, specifications, and other content to be stored in a single entry.

 

Beyond Basic FAQs

The FAQ section extends far beyond simple question-answer pairs:

  • Product Categorization: Organize and define product groups

  • Comprehensive Product Details: Store specifications, usage instructions, and all other information

  • Structured Knowledge Base: Create a systematic information repository your agent can reference

 

Strategic Uses

Product Group Organization

When you have numerous product groups with multiple items in each category (and integration is not involved), use the FAQ section to clearly define these groupings:

Question: What products are included or what products do you offer in:

Group 1?

Answer: In Group 1, we can offer you:

Product 1

Product 2

Product 3

...

Product N

This approach ensures your AI agent can accurately recommend and discuss products within their correct categories.

 

Detailed Product Information Repository

For products with extensive details and there is no direct integration:

Question: Product X

Answer: [Include all relevant information about Product X]

- Description

- Usage instructions

- Packaging information

- Pricing details

- Technical specifications

- Certification links

- Calculation methods

 

Handling Information Beyond Character Limits

If your product information exceeds the 3000 character limit, split it across multiple FAQ entries using a consistent naming convention:

FAQ 1: Product X, 1

FAQ 2: Product X, 2

FAQ 3: Product X, 3

This approach allows your agent to access and compile comprehensive information even when it spans multiple entries.

 

Including Links in FAQs

The FAQ section is an excellent place to incorporate important links that you want your agent to reference in conversations. Adding links within your FAQ entries ensures your agent can provide users with direct access to valuable resources.

 

Types of Links to Include

  • Product Pages: Direct links to specific products on your website

  • Documentation: Links to user manuals, technical specifications,and guides

  • Video Tutorials: Links to instructional videos (YouTube or other platforms)

  • Certification Documents: Links to compliance certificates or regulatory information

  • Support Resources: Links to help centers, contact forms, or knowledge bases

  • Pricing Pages: Links to current pricing information that may change frequently

 

Link Implementation Examples

Question: Where can I find more information about Product X?

Answer: You can find detailed information about Product X on our official product page at "https://example.com/product-x"

For technical specifications, please visit "https://example.com/product-x/specs"

We also have a helpful video tutorial at "https://youtube.com/watch?v=product-x-tutorial"

 

Question: Product Y

Answer: [Product description...]

 

For more information:

- Product Page: https://example.com/product-y

- User Manual: https://example.com/manuals/product-y.pdf

- Certification: https://example.com/certifications/product-y

- Video Demonstration: https://youtube.com/watch?v=product-y-demo

 

Best Practices for Links

  1. Use Full URLs: Include the complete URL (including https://) for all links

  2. Label Links Clearly: Provide context about what each link contains

  3. Verify Regularly: Check links periodically to ensure they remain active

  4. Group Related Links: Organize links logically when including multiple resources

 

Best Practices

Consistent Formatting

Maintain consistent question and answer formats throughout your FAQ section to help your agent recognize patterns and respond appropriately.

Strategic Question Phrasing

Craft your questions to match how users might inquire about information. Consider variations in terminology and phrasing.

Logical Organization

Group related FAQs together and consider using numbering systems or prefixes to indicate relationships between entries.

Regular Updates

Review and update your FAQ content regularly to ensure accuracy and relevance as your products and services evolve.

 

Implementation Tips

  1. Start with High-Priority Information: Begin by adding FAQs for your most common queries and important products.

  2. Use Clear Language: Avoid ambiguity in both questions and answers for optimal agent understanding.

  3. Test Thoroughly: After adding FAQs, test your agent with various related queries to ensure it properly utilizes the information.

  4. Iterative Improvement: Monitor agent responses and refine your FAQ entries based on performance and user feedback.