Skip to content

Conversation

@MichielMAnalytics
Copy link

Summary

Added RAG (Retrieval-Augmented Generation) Pinecone plugin that enables knowledge base creation, management, and querying with Telegram bot integration.

Links

Plugin documentation: Located in game-python/plugins/RAGPinecone/README.md
Issue link (if applicable): N/A
Other useful links: https://docs.pinecone.io/docs/overview

Plugin Documentation Checklist

  • README Validation
    [x] Clear installation instructions
    [x] Usage examples with code snippets
    [x] List of features and capabilities
    [x] Troubleshooting guide (if applicable)
    [x] Contribution guidelines (if applicable)

  • Metadata Validation
    [x] Complete metadata provided in reference to plugin metadata template

Dev Testing

(Include where applicable)

Screenshots/GIFs: N/A
Video Demonstrations: N/A
Logs or Console Outputs: Successfully tested with Telegram bot integration and Google Drive document retrieval
Testing steps for the plugin:
Install the plugin dependencies
Set up environment variables (PINECONE_API_KEY, OPENAI_API_KEY, GAME_API_KEY, TELEGRAM_BOT_TOKEN)
Run populate_knowledge_base.py to load documents into the vector database
Run test_rag_pinecone_telegram.py to start the Telegram bot with RAG capabilities
Test queries in Telegram that require knowledge retrieval

Additional Notes

  • Future enhancements:
    Add support for more document types
    Implement document versioning and update tracking
    Add caching mechanism to improve response times
    Optimize embedding generation for better performance

  • Known limitations:
    Large documents may take time to process
    Currently optimized for text-based content, multimedia content requires additional processing
    Requires OpenAI API key for embeddings generation
    Google Drive integration requires public sharing settings for folders

@Ang-dot Ang-dot added the plugin Plugin contribution label Mar 17, 2025
@Ang-dot Ang-dot added plugin Plugin contribution and removed plugin Plugin contribution labels Mar 24, 2025
@Ang-dot Ang-dot force-pushed the mvoortman/RAGPlugin branch from 8be44a6 to 9a018d4 Compare March 25, 2025 02:08
@Ang-dot Ang-dot force-pushed the mvoortman/RAGPlugin branch from 820eab7 to 458aa80 Compare March 25, 2025 02:24
@Ang-dot
Copy link
Contributor

Ang-dot commented Mar 25, 2025

Thanks for the PR @MichielMAnalytics! It's very well documented, appreciate it!

@Ang-dot Ang-dot merged commit ba3711c into game-by-virtuals:main Mar 25, 2025
6 checks passed
MichielMAnalytics pushed a commit to MichielMAnalytics/game-python that referenced this pull request Jun 12, 2025
…man/RAGPlugin

added RAG (both populate and search + tg bot example)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

plugin Plugin contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants