Skip to content

discord-bot-quick-reference.md

Latest commit

 

History

History
227 lines (169 loc) · 5.66 KB

discord-bot-quick-reference.md

File metadata and controls

227 lines (169 loc) · 5.66 KB

Discord Bot Quick Reference

Quick reference card for Archive-RAG Discord bot commands.

Commands

/archive query (Public)

Access: Everyone
Purpose: Ask natural language questions about archived meetings

Examples:

/archive query query:"What decisions were made last January?"
/archive query query:"What is the tag taxonomy?"
/archive query query:"What meetings discussed budget allocation?"

Response Format:

Processing your query...

[Answer text]

Citations:
[meeting_id | date | workgroup_name]

/archive topics (Contributor+)

Access: Users with "contributor" or "admin" role
Purpose: Search for topics/tags in archived meetings

Examples:

/archive topics topic:"RAG ethics"
/archive topics topic:"governance"
/archive topics topic:"budget"

Response Format:

Processing your topic search...

Topic: governance

References:
1. [meeting_id | date | workgroup_name]
2. [meeting_id | date | workgroup_name]
...
(Showing top 5 results)

/archive people (Contributor+)

Access: Users with "contributor" or "admin" role
Purpose: Search for people/participants in archived meetings

Examples:

/archive people person:"Stephen"
/archive people person:"Gorga"
/archive people person:"André"

Response Format:

Processing your people search...

Person: Stephen
Alias: QADAO
Role: host

Mentions:
1. [meeting_id | date | workgroup_name]
2. [meeting_id | date | workgroup_name]
...
(Showing top 5 results)

/archive relationships (Public)

Access: Everyone
Purpose: Query entity relationships (people, workgroups, meetings, decisions, action items)

Examples:

/archive relationships person:"Stephen"
/archive relationships workgroup:"Archives WG"
/archive relationships meeting:"meeting-id-uuid"

Response Format:

Processing your relationship query...

Entity: Stephen (normalized from 'Stephen [QADAO]')
Type: Person

Relationships (5):
1. Stephen (Person) → attended → Meeting (Meeting)
2. Stephen (Person) → assigned_to → ActionItem (ActionItem)
...

Note: Supports entity name normalization - variations like "Stephen [QADAO]" normalize to "Stephen"

/archive list (Public)

Access: Everyone
Purpose: List entities (topics, meetings by date, etc.)

Examples:

/archive list query:"List topics"
/archive list query:"List meetings in March 2025"
/archive list query:"List decisions made by workgroup in March 2025"

Response Format:

[List of topics/meetings/decisions with citations]

Enhanced Features

Enhanced Citations

All query responses now include enhanced citations with:

  • Semantic chunk type: (summary), (decision), (action), (attendance), (resource)
  • Entity mentions: Shows which entities are mentioned in the chunk
  • Relationship context: Shows relationships like "Person → Relationship → Object"
  • Normalized entity names: All entity names are normalized to canonical forms

Example Enhanced Citation:

[meeting_id | 2025-03-15 | Governance Workgroup] (decision) - Entities: Budget, Allocation - Stephen → attended → Meeting

Issue Reporting

Every bot response includes a "Report Issue" button that allows users to:

  • Report incorrect or misleading information
  • Provide feedback on bot responses
  • Help improve the system

How to Report an Issue:

  1. Click the "Report Issue" button on any bot response
  2. Fill out the modal form describing what was incorrect
  3. Submit the report
  4. Receive confirmation with a report ID

Note: Issue reports are logged for admin review. Spam detection automatically flags rapid-fire or duplicate reports.

Rate Limiting

  • Limit: 10 queries per minute per user
  • Applies to: All commands (shared limit)
  • Message: "Rate limit exceeded. Please wait Xs."

Error Messages

Error Message Cause
Rate Limit "Rate limit exceeded. Please wait Xs." Too many queries (10/minute limit)
Permission Denied "This command requires contributor role. Contact an admin if you need access." User doesn't have contributor/admin role
No Results "No relevant archive data found..." Query didn't match any content
Service Unavailable "RAG service temporarily unavailable..." Index file not found or inaccessible

Role Setup

To Test Contributor Commands:

  1. Go to Server Settings → Roles
  2. Create role named "contributor" (or "admin")
  3. Assign role to your user
  4. Bot checks role names case-insensitively

Quick Test Checklist

  • Bot appears online (green status)
  • /archive query works
  • /archive topics works (with contributor role)
  • /archive people works (with contributor role)
  • /archive relationships works
  • /archive list works
  • Enhanced citations show chunk types and entities
  • Issue reporting button appears on responses
  • Issue reporting modal works
  • Rate limiting works (11th query gets error)
  • Error messages are clear and helpful

Troubleshooting

Commands not appearing?

  • Wait up to 1 hour for Discord to sync
  • Re-invite bot with OAuth2 URL

Permission denied with role?

  • Verify role name is "contributor" or "admin"
  • Check bot has "Server Members Intent" enabled
  • Wait a few seconds for Discord to sync roles

No results?

  • Try different search terms
  • Check entity data exists in entities/ directory
  • Verify RAG index is available

Additional Documentation