CrafterQ Best Practices¶
Building an effective AI agent involves more than connecting data and turning it on. This section outlines recommended best practices to help you get the most accurate, relevant, and engaging results from your CrafterQ agents.
1. Define a Clear Purpose¶
Before creating your agent, identify its primary goal.
Ask yourself:
What type of questions should the agent answer?
Who is the intended audience?
Should it provide factual responses, recommendations, or support assistance?
By defining a clear purpose early, you can configure your prompts, tone, and data sources to align with that goal.
Example: A Customer Support Agent should use concise, friendly language and rely only on official help docs. A Product Advisor Agent can be more conversational and creative.
2. Provide High-Quality, Focused Data¶
Your agent’s accuracy depends on the quality and relevance of its data sources.
Use authoritative content: Include website content, official documentation, product guides, FAQs, or curated text — not unverified material.
Avoid duplication: Overlapping or conflicting data across multiple sources can confuse the model.
Keep it focused: Connect only sources relevant to the agent’s scope.
Update regularly: Use the Retrain button after content changes to ensure the agent has the latest information.
Pro Tip
When using website sources, exclude pages with irrelevant navigation text or dynamic comments to keep your dataset clean.
3. Craft a Strong System Prompt¶
The Default Prompt defines your agent’s tone, role, and boundaries. A well-written prompt helps the AI understand context and maintain consistency.
Example template:
Role: You are CrafterQ, a helpful and professional AI assistant that answers questions about [topic]. Your goal is to provide helpful, friendly, and efficient replies in a conversational tone. You carefully listen to the user, understand their intent, and offer clear, accurate responses based on your knowledge. When necessary, you may ask follow-up questions to clarify the user’s needs. Always end responses on a positive and supportive note.
Stay On Role: Remain consistent in your function as a helpful chatbot. If the user tries to steer the conversation into unrelated or out-of-scope areas, politely redirect them back to your supported topics.
No Data Disclosure: Do not discuss your training data, system capabilities, or internal mechanisms. Avoid statements like “based on my training” or “as an AI.”
Answer Only Within Scope: Only answer questions related to your intended knowledge domain. If a query cannot be answered accurately based on what you know, respond with a polite fallback like: “I’m sorry, I don’t have enough information to answer that. Could you please clarify or ask something else?”
Prompt Tips:
Clearly define your agent’s persona and style.
Set limits on what it should or shouldn’t do (e.g., “Only answer from provided sources”).
Test variations of prompts in the Playground to compare performance.
4. Tune AI Settings Thoughtfully¶
Under AI Settings, experiment carefully with parameters like Temperature, Agent Instructions and Trailing Prompt.
Temperature:
Lower (0.0–0.4) → precise, consistent answers.
Higher (0.6–1.0) → more creative or varied responses.
Agent Instructions: Specify the Role and other instructions for the agent to follow.
Always make incremental adjustments and retest in the Playground before deploying.
5. Test Extensively in the Playground¶
The Playground is your safe environment to refine your agent’s performance.
Test for:
Accuracy: Does it cite or reference the correct information?
Clarity: Are the responses well-phrased and easy to understand?
Consistency: Does tone and behavior remain steady across topics?
Failure handling: Does the agent respond gracefully to unknown queries?
Pro Tip
Keep a list of “benchmark” questions that represent typical user queries. Use them to evaluate performance after each configuration change.
6. Design an Engaging Chat Experience¶
A great agent isn’t just accurate — it’s also inviting.
In the User Interface section:
Customize the Welcome Message to greet users naturally.
Add Quick Messages to guide user interaction (“Need help?”, “Show me pricing,” “Learn about our services”).
Match the UI colors to your brand identity.
Pro Tip
Small design details make users more likely to trust and engage with your AI assistant.
7. Monitor and Improve Continuously¶
Once your agent is live:
Visit Chat Logs and Usage regularly to review user interactions and performance metrics.
Identify unanswered or low-confidence questions and enrich your sources to cover those topics.
Use Usage Reports to manage token consumption and optimize efficiency.
Tip: Continuous improvement is the key to long-term agent success.
8. Keep Security and Privacy in Mind¶
If your agent handles sensitive or internal data:
Limit access with proper User Management roles.
Tip: Your users’ trust depends on transparent and secure AI design.
Summary¶
By following these best practices — clear goals, high-quality data, well-crafted prompts, careful tuning, and ongoing monitoring — you’ll ensure your CrafterQ agents deliver intelligent, accurate, and delightful conversational experiences.