The Agent Description under the Configuration tab is the guiding criteria in which the Agent will operate.
To maximize the effectiveness of your agent and achieve higher scorecard ratings, follow these guidelines to refine your agent descriptions. A well-crafted description not only improves the agent's output but also ensures clarity, accuracy, and user satisfaction.
ℹ️ It may be worthwhile to utilize the Enhance with AI tool at the bottom of the Agent Scorecard in the Agent Configuration tab to get a template of an optimized Agent Description before making your personalized edits.
1. Clearly Define the AI's Role
Why it matters: A specific and well-defined role helps the Agent stay focused on its purpose.
Example: Instead of a vague description like "Analyze HR documents," use:
"You are an advanced AI research assistant specializing in Human Resources (HR) candidate evaluation, capable of extracting and summarizing information from PDF documents."
2. Specify the Task or Request
Why it matters: A clear, specific task ensures the Agent understands what it needs to do.
Tips for improvement:
Include actionable tasks like gathering, analyzing, or summarizing.
Provide explicit instructions, e.g., "Focus on resumes and cover letters for analysis."
3. Include Relevant Context
Why it matters: Context helps the Agent tailor its responses to meet the user's needs.
How to add context:
Highlight the Agent's knowledge base, e.g., "You possess extensive knowledge of HR practices and candidate assessment techniques."
Mention the target industry or role if applicable.
4. Provide Examples of Expected Outputs
Why it matters: Examples illustrate the desired format and level of detail.
How to improve:
Use sample scenarios like:
"For a candidate named 'John Doe', summarize his experience in talent acquisition, key achievements, and certifications."Be concise but detailed in your examples.
5. Define Constraints and Focus Areas
Why it matters: Constraints guide the Agent to filter information effectively.
Best practices:
Include specifics such as:
"Focus on candidates with at least 5 years of experience in HR and those who have worked in the tech industry."If privacy or ethical guidelines are relevant, make them explicit.
6. Specify the Desired Output Format
Why it matters: A structured output format improves usability and consistency.
Examples of format instructions:
"The output should be structured as a list of candidates, with each entry containing the candidate's name, a brief summary of their qualifications, and a link to the PDF document."
Indicate word limits if necessary, e.g., "Keep each summary under 150 words."
7. Emphasize Ethical and Professional Standards
Why it matters: Ethical considerations ensure compliance with privacy and confidentiality standards.
How to include:
Add statements like:
"Ensure that your response adheres to ethical guidelines, respecting the privacy of candidates and the confidentiality of their documents."Reinforce professionalism, e.g., "Use clear and precise language, avoiding subjective opinions."
Checklist for Optimizing Descriptions
Use this checklist to review and refine your agent description:
✅ Role: Is the agent’s role clearly defined?
✅ Task: Are specific tasks outlined?
✅ Context: Does the description include relevant background information?
✅ Examples: Are examples provided to illustrate the desired output?
✅ Constraints: Are there clear filters or conditions for the task?
✅ Format: Is the output format explicitly described?
✅ Ethics: Are ethical and professional standards emphasized?
Common Pitfalls to Avoid
Vagueness: Avoid descriptions that lack focus or specificity.
Overcomplexity: Keep descriptions clear and concise to prevent confusion.
Subjectivity: Avoid language that introduces personal opinions or unclear criteria.
Missing Ethics: Ensure all ethical considerations are explicitly stated.