{"id":25877312,"url":"https://github.com/ragpi/ragpi","last_synced_at":"2025-04-05T23:05:08.222Z","repository":{"id":274551478,"uuid":"856605046","full_name":"ragpi/ragpi","owner":"ragpi","description":"🤖 An open-source AI assistant answering questions using your docs","archived":false,"fork":false,"pushed_at":"2025-03-23T12:39:11.000Z","size":580,"stargazers_count":157,"open_issues_count":0,"forks_count":22,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-29T22:08:11.743Z","etag":null,"topics":["generative-ai","llm","python","rag"],"latest_commit_sha":null,"homepage":"https://docs.ragpi.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ragpi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-12T21:41:40.000Z","updated_at":"2025-03-27T14:49:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"e455c8a4-9dfe-4b85-a976-9d7807d026e0","html_url":"https://github.com/ragpi/ragpi","commit_stats":null,"previous_names":["ragpi/ragpi"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragpi%2Fragpi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragpi%2Fragpi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragpi%2Fragpi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragpi%2Fragpi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ragpi","download_url":"https://codeload.github.com/ragpi/ragpi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411226,"owners_count":20934653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generative-ai","llm","python","rag"],"created_at":"2025-03-02T11:26:55.935Z","updated_at":"2025-04-05T23:05:08.203Z","avatar_url":"https://github.com/ragpi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ragpi\n\nRagpi is an open-source AI assistant that answers questions using your documentation, GitHub issues, and READMEs. It combines LLMs with intelligent search to provide relevant, documentation-backed answers through a simple API. It supports multiple providers like OpenAI, Ollama, and Deepseek, and has built-in integrations with Discord and Slack.\n\n[Documentation](https://docs.ragpi.io) | [API Reference](https://docs.ragpi.io/api) | [Join Discord](https://discord.gg/tXN8dkqvcE)\n\n## Key Features\n\n- 📚 Builds knowledge bases from docs, GitHub issues and READMEs\n- 🤖 Agentic RAG system for dynamic document retrieval\n- 🔌 Supports OpenAI, Ollama, Deepseek \u0026 OpenAI-Compatible models\n- 💬 Discord and slack integrations for community support\n- 🚀 API-first design with Docker deployment\n\n## Example Workflow\n\nHere's a simple workflow to get started with Ragpi once it's deployed:\n\n### 1. Set up a Source with a Connector\n\n- Use the [`/sources`](https://docs.ragpi.io/api#tag/Sources/operation/create_source_sources_post) endpoint to configure a source with your chosen connector.\n- Each connector type has its own configuration parameters.\n\nExample payload using the Sitemap connector:\n\n```json\n{\n  \"name\": \"example-docs\",\n  \"description\": \"Documentation for example project. It contains information about configuration, usage, and deployment.\",\n  \"connector\": {\n    \"type\": \"sitemap\",\n    \"sitemap_url\": \"https://docs.example.com/sitemap.xml\"\n  }\n}\n```\n\n### 2. Monitor Source Synchronization\n\n- After adding a source, documents will be synced automatically. You can monitor the sync process through the [`/tasks`](https://docs.ragpi.io/api#tag/Tasks/operation/get_task_tasks__task_id__get) endpoint.\n\n### 3. Chat with the AI Assistant\n\n- Use the [`/chat`](https://docs.ragpi.io/api#tag/Chat/operation/chat_chat_post) endpoint to query the AI assistant using the configured sources:\n\n  ```json\n  {\n    \"sources\": [\"example-docs\"],\n    \"messages\": [\n      { \"role\": \"user\", \"content\": \"How do I deploy the example project?\" }\n    ]\n  }\n  ```\n\n- You can also interact with the AI assistant through the [Discord](https://docs.ragpi.io/integrations/discord) or [Slack](https://docs.ragpi.io/integrations/slack) integration.\n\n## Connectors\n\nRagpi supports the following connectors for building knowledge bases:\n\n- **Documentation Website (Sitemap)**\n- **GitHub Issues**\n- **GitHub README Files**\n\n[Explore connectors →](https://docs.ragpi.io/connectors)\n\n## Providers\n\nRagpi supports the following LLM providers for generating responses and embeddings:\n\n- **OpenAI** (default)\n- **Ollama**\n- **Deepseek**\n- **OpenAI-compatible APIs**\n\n[Configure providers →](https://docs.ragpi.io/providers/overview)\n\n## Integrations\n\nRagpi supports the following integrations for interacting with the AI assistant:\n\n- [**Discord**](https://docs.ragpi.io/integrations/discord)\n- [**Slack**](https://docs.ragpi.io/integrations/slack)\n\n## Contributing\n\nContributions to Ragpi are welcome! Please check out the [contributing guidelines](CONTRIBUTING.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fragpi%2Fragpi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fragpi%2Fragpi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fragpi%2Fragpi/lists"}