Writing Effective Prompts for AI Assistant
This section provides guidelines for writing clear and effective prompts when interacting with the AI Assistant. Following these conventions helps ensure that the system correctly interprets your request and performs the intended action.
General Rules
-
Use action-specific keywords
Each module has reserved terms. Always use the correct keyword to avoid ambiguity.
-
Departments → use 'department'
-
Monitored Employees → use 'monitor' or 'monitored' (individual referred to as employee)
-
Role Assignment → use 'assign' and 'role' (individual referred to as user)
-
Use quotation marks for dynamic values
Enclose department names, user names, and role names in single quotes.
Example: 'Finance', 'John Smith', 'Department Reviewer'
-
Use separate chat sessions for different modules
Start a new chat when switching between modules (for example, from Monitored Employees to Role Assignment). This ensures context clarity and avoids misinterpretation.
-
One operation type per request
Do not mix view and update, add and remove actions in a single prompt - send them separately. However, applying the same action to multiple users or departments in one prompt is supported.
-
Clearly define the scope
Always state whether the action applies to a specific department, a list of departments, or all departments.
-
✓ Assign the 'Department Reviewer' role to user 'Dave' in the department 'Sales'
-
✓ Assign the 'Passive Reviewer' role to user 'Dave' across all departments
-
✗ Assign 'Escalation Reviewer' role to 'Dave' - missing scope (Department name not provided)
-
Verify responses before proceeding
Review the system response before submitting follow-up prompts. If needed, start a new chat to correct or refine the request.
Note: The AI Assistant removes HTML tags from user requests and system responses for security purposes.
Prompts for Departments
Use the keyword department in all department-related prompts.
| Intent | Example Prompt |
|---|---|
| List departments created in a time period | Number of departments created in November 2025 |
| Number of departments created in last year | |
| Show departments by status | Show the list of Open and Closed departments |
| Show departments with Intelligent Review enabled | Show all departments where Intelligent Review is enabled |
| Show top departments by review volume | Show the top 10 departments with the highest number of items in review |
| Open one or more departments | Open the department 'Finance' |
| Open the departments 'Sales', 'Trading', 'Marketing' | |
| Close department list with partial name match | Close all departments that has the word 'temp' in the name |
| Close departments created in the last year | Close all departments that were created before January 2024 |
| Close one or more departments | Close the department 'Finance' |
| Close the departments 'Trading', 'Sales', 'Marketing' |
Prompts for Monitored Employees
Use the keywords monitor or monitored in prompts related to this module.
| Intent | Example Prompt |
|---|---|
| List monitored employees in a department | Show the list of employees monitored in the department 'Finance' |
| List all departments where an employee is monitored | Show all departments where employee 'John Smith' is monitored |
| List all monitored employees and groups in a department | Show the list of all monitored employees and groups in the department 'Sales' |
| Add a single employee to monitoring | Add employee 'John Smith' to the monitoring list in the department 'Sales' |
| Add multiple employees to monitoring | Add employees 'John Smith', 'Emily Johnson', 'Olivia Brown' to the monitoring list in the department 'Sales' |
| Add an employee to monitoring across multiple departments | Add employee 'John Smith' to the monitoring list in the departments 'Sales', 'Trading', 'Marketing' |
| Remove a single employee from monitoring | Remove employee 'Ryan' from the monitoring list in the department 'Trading' |
| Remove multiple employees from monitoring | Remove employees 'Ryan', 'Jacob', 'Abigail' from the monitoring list in the department 'Trading' |
Prompts for Role Assignment
Always include both the user name and the role name in every role-related prompt.
| Intent | Example Prompt |
|---|---|
| Fetch role assignment details for a department | Fetch the role assignment details for the department 'Marketing' |
| Show departments where a user has a specific role | Show the list of departments where user 'Dave' has the 'Compliance Supervisor' role assigned |
| Assign a role in one department | Assign the 'Department Reviewer' role to user 'Dave' in the department 'Sales' |
| Assign a role across multiple departments | Assign the 'Escalation Reviewer' role to user 'Dave' in the departments 'Sales', 'Finance', 'Trading' |
| Assign a role across all departments | Assign the 'Rule Admin' role to user 'Dave' across all departments |
| Remove a user's role in a department | Remove user 'Jane' from the 'Passive Reviewer' role in the department 'Finance' |
| Remove a user's role across all departments | Remove user 'Jane' from the 'Department Reviewer' role across all departments |
Common Mistakes to Avoid
Avoid the following patterns when writing prompts:
-
Mixing multiple operations
Example: Add 'John' and remove 'Dave' from monitoring in 'Sales'
Remark: Send as two separate prompts
-
Mixing multiple modules in one prompt
Example: Add 'John' as monitored and assign him the 'Department Reviewer' role in 'Sales'
Remark: Use separate chat sessions
-
Missing scope
Example: Assign 'Passive Reviewer' role to 'Dave'
Remark: Always specify a department or 'across all departments'
-
Spelling errors in names
Example: Remove 'Jane' from 'Deprtment1'
Remark: Ensure the correct spelling as the system matches values exactly
Note: Partial name matching (without spelling error) is supported; however, the request explicitly indicates a partial match. Example: Show all departments that have the word 'fin' in the name.
-
Using vague scope
Example: Assign role to some departments
Remark: Always list specific departments or say 'across all departments'
-
Missing role name in role operations
Example: Remove 'Jane' from her role
Remark: Always include the full role name in role operations
Related information