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 Strong Agent Instructions¶
The Agent Instructions define your agent’s tone, role, and boundaries. A well-written set of instructions helps the AI understand context and maintain consistency.
CrafterQ Default Agent Instructions
Role & Purpose:
You are an AI assistant that helps users with their questions, issues, and requests. Your goal is to provide friendly, clear, and efficient responses in a conversational tone. Understand the user's intent, offer accurate answers based on your configured data sources, and ask a short clarifying question when necessary. End every response on a positive, supportive note.
Knowledge Domain:
Your knowledge comes only from the content provided below. Do not rely on external knowledge or make assumptions beyond these sources.
Tone & Interaction:
- Style: friendly, professional, and helpful
- Answers: Concise answers - Use bullet points for lists - Provide step-by-step guidance only when helpful
- Tone: Warm tone but not overly casual.
Redirecting Out-of-Scope Questions:
If the user asks about something outside your knowledge domain, acknowledge it politely and guide them back to supported topics. Example redirect: "That topic is outside what I can help with, but I'm happy to assist with anything related to the information I do know."
Fallback Responses:
If you cannot answer accurately, use one of these fallback lines:
1. I'm not able to help with that yet. Could you clarify?
2. I don't have the right information for that. Want to try another question?
3. I'm sorry, I'm not sure. Could you rephrase or ask something else?
Clarifying Questions:
Ask a short clarifying question when the user's request is ambiguous, incomplete, or could be interpreted in multiple ways.
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."
Stay On Role Remain:
consistent in your function as a helpful assistant. Politely redirect when the user attempts to move into unrelated or unsupported topics.
Instructions 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.
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.
9. Choosing Between Text and Q&A Sources¶
CrafterQ supports two complementary source types — Text and Q&A — each optimized for a different kind of knowledge and user intent. Using the right source type is critical for accuracy, performance, and predictability of AI responses.
Use Text Sources for General Knowledge and Exploration¶
Text sources are designed for broad, descriptive, and contextual information. They are ideal when:
The content explains concepts, processes, features, or policies
Users may ask many variations of similar questions
The answer requires synthesis across multiple paragraphs or documents
The content should be on your website (and you may publish it to your website in the future)
Best suited for:
Product updates and feature descriptions
Documentation and help clarifications
Marketing, educational, and explanatory content
Use Q&A Sources for Precise, Canonical Answers¶
Q&A sources are purpose-built for specific, known questions that require exact, authoritative answers.
When a user’s question matches a Q&A entry, the stored answer is returned verbatim to the end user. This eliminates ambiguity, prevents paraphrasing drift, and guarantees consistency.
Best suited for:
Pricing, limits, and plan comparisons
Legal, compliance, or policy statements
“What happens if…?” or “Does your product support…?” questions
Any answer that must be precise and repeatable
Recommended Strategy: Use Both—Intentionally¶
The strongest implementations combine both source types:
Text for discoverability, nuance, and exploration
Q&A for precision, control, and trust
A good rule of thumb:
This layered approach improves response quality, reduces hallucination risk, and ensures users get the right kind of answer every time.
10. Choosing Expressiveness¶
Different AI agents benefit from different Expressiveness levels depending on their role, audience, and risk tolerance. Below are recommended defaults based on common CrafterQ use cases.
These are starting points — you may fine-tune per site, brand voice, or compliance needs.
Recommended Expressiveness Settings by Agent Type¶
🛠️ Support / Helpdesk Agent
Recommended: Low / Precise (0.0 - 0.1)
Why:
Users want fast, unambiguous answers
Consistency is more important than tone
Reduces risk of misinterpretation
Typical use cases:
FAQs
Technical troubleshooting
Policy and compliance questions
Pro Tip: Keep Expressiveness near the Precise end, especially when paired with Q&A sources.
💼 Sales Agent
Recommended: Medium (0.3 - 0.7)
Why:
Needs clarity and conversational flow
Benefits from slight variation to avoid robotic responses
Still must remain accurate and controlled
Typical use cases:
Product explanations
Qualification questions
Pricing and feature comparisons
📣 Marketing Agent
Recommended: Medium–High (0.4 - 0.8)
Why:
Expressive language improves engagement
Helps reflect brand voice and personality
Users expect elaboration and inspiration
Typical use cases:
Value propositions
Differentiation messaging
Campaign and brand content
Pro Tip: Pair higher Expressiveness with well-curated content sources to maintain message consistency.
🛒 E-Commerce Shopping Assistant
Recommended: Medium (0.3 - 0.7)
Why:
Needs clear, factual product info
Benefits from friendly, helpful phrasing
Too much creativity can obscure details like specs or pricing
Typical use cases:
Product discovery
Feature comparisons
Buying guidance
✍️ Content Author / Internal Authoring Agent
Recommended: High / Creative (0.8 - 1.0)
Why:
Designed to assist with drafting and ideation
Variation and expressive language are beneficial
Lower risk since content is reviewed before publishing
Typical use cases:
Blog drafts
Page copy suggestions
Content rewrites and expansions
🧠 Knowledge / Internal Assistant
Recommended: Low–Medium (0.0 - 0.3)
Why:
Employees often want concise, reliable answers
Overly expressive responses can slow comprehension
Typical use cases:
Internal documentation
Policy lookup
Operational guidance
General Guidelines
Start conservative for external-facing agents, especially in regulated industries.
Increase Expressiveness gradually and test with real user queries.
Use Q&A sources for answers that must remain exact, regardless of Expressiveness.
Align Expressiveness with brand voice, not just agent function.
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.