Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Discord Bot Q&A #36

Open
4 tasks
Nyumat opened this issue Nov 18, 2024 · 0 comments
Open
4 tasks

Implement Discord Bot Q&A #36

Nyumat opened this issue Nov 18, 2024 · 0 comments
Labels
advanced Great for experienced developers enhancement New feature or request requires-officer Requires an officer input/aid

Comments

@Nyumat
Copy link
Member

Nyumat commented Nov 18, 2024

Overview

Develop an extension of BeavsAI that integrates a Discord bot capable of answering questions using a knowledge base built from the Oregon State CS Discord server. This feature will enhance student interactions by providing quick access to relevant academic support and resources directly within Discord.

Objective

Create a Discord bot that connects to BeavsAI’s retrieval-augmented generation (RAG) system to deliver accurate and context-aware answers based on a curated knowledge base from the Oregon State CS Discord community.

Details

Core Features

  • Discord Bot Integration: Build a bot using Discord's API that can respond to user queries within channels and DMs.
  • Knowledge Base Creation: Extract and structure information from the Oregon State CS Discord server, focusing on FAQs, common discussion points, and course-specific insights.
  • Q&A Capability: Integrate the bot with BeavsAI’s existing RAG pipeline to provide responses based on the knowledge base.
  • Contextual Awareness: Ensure the bot can understand context to answer questions accurately and suggest additional resources when needed.

Technical Requirements

  • Discord API: Use discord.js or a similar library to develop the bot.
  • Knowledge Base Management: Store and update knowledge using Pinecone for vector searches and OpenAI for embedding and responses.
  • Bot Commands: Implement basic commands such as /ask {question} and /help.
  • Type Safety and Validation: Use TypeScript and Zod to ensure type safety and robust error handling.
  • Data Processing: Include routines to parse and update the knowledge base with new Discord discussions or posts.

UI/UX Changes (If Any)

  • Bot Interaction: Create friendly and user-focused responses for the bot’s interaction.
  • Web Dashboard (Optional): Implement a web interface within BeavsAI for monitoring and managing the bot's activity and knowledge base updates.

Data and Privacy Considerations

  • User Privacy: Ensure compliance with data privacy standards and obtain necessary permissions for extracting and using content from the Discord server.
  • Content Moderation: Filter sensitive or inappropriate content before it becomes part of the knowledge base.

Acceptance Criteria

  • A Discord bot is implemented and connected to BeavsAI.
  • The bot can answer questions based on the curated knowledge base from the Oregon State CS Discord.
  • The knowledge base is stored and managed effectively, with options to update and refine content.
  • Responses are accurate, contextually aware, and helpful to users.
@Nyumat Nyumat converted this from a draft issue Nov 18, 2024
@Nyumat Nyumat added enhancement New feature or request advanced Great for experienced developers requires-officer Requires an officer input/aid labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
advanced Great for experienced developers enhancement New feature or request requires-officer Requires an officer input/aid
Projects
Status: Todo
Development

No branches or pull requests

1 participant