1ee5a17d9SCharles Chan## RagAsker Plugin for DokuWiki 2ee5a17d9SCharles Chan 3ee5a17d9SCharles ChanRagAsker is a DokuWiki plugin that brings Retrieval-Augmented Generation (RAG) powered Q&A capabilities to your wiki. It integrates with OpenAI or compatible APIs to provide intelligent, context-aware answers based on your wiki content. 4ee5a17d9SCharles Chan 5ee5a17d9SCharles Chan### Main Features 6ee5a17d9SCharles Chan 7ee5a17d9SCharles Chan- **AI-Powered Q&A Widget**: Adds an interactive widget to your wiki pages, allowing users to input questions and receive AI-generated answers. 8ee5a17d9SCharles Chan- **Keyword Extraction & Search**: Automatically extracts keywords from user queries and searches relevant wiki pages to enhance answer accuracy. 9ee5a17d9SCharles Chan- **Retrieval-Augmented Generation**: Combines retrieved wiki content with large language models to generate context-rich responses. 10ee5a17d9SCharles Chan- **Custom Syntax Support**: Use `~~RAGASKER~~` syntax to embed the Q&A widget anywhere in your wiki. 11ee5a17d9SCharles Chan- **Multi-language UI**: Supports multiple languages for user interface and prompts. 12ee5a17d9SCharles Chan- **Configurable**: Easily set API endpoint, key, model, and other parameters via plugin settings. 13ee5a17d9SCharles Chan 14ee5a17d9SCharles Chan### Typical Use Cases 15ee5a17d9SCharles Chan 16ee5a17d9SCharles Chan- Knowledge base Q&A 17ee5a17d9SCharles Chan- Wiki content search and summarization 18ee5a17d9SCharles Chan- Intelligent assistant for documentation 19ee5a17d9SCharles Chan 20ee5a17d9SCharles Chan### Requirements 21ee5a17d9SCharles Chan 22ee5a17d9SCharles Chan- DokuWiki installation 23ee5a17d9SCharles Chan- Access to OpenAI API or compatible LLM service 24ee5a17d9SCharles Chan 25ee5a17d9SCharles Chan### Installation 26ee5a17d9SCharles Chan 27ee5a17d9SCharles Chan1. Copy the plugin folder to `lib/plugins/ragasker` in your DokuWiki installation. 28ee5a17d9SCharles Chan2. Configure API settings in the plugin configuration page. 29ee5a17d9SCharles Chan3. Add `~~RAGASKER~~` to any wiki page to enable the widget. 30ee5a17d9SCharles Chan 31ee5a17d9SCharles Chan### License 32ee5a17d9SCharles Chan 33*47bd0b3bSCharles ChanCopyright (C) Charles Chan <charles@zeerd.com> 34*47bd0b3bSCharles Chan 35*47bd0b3bSCharles ChanThis program is free software; you can redistribute it and/or modify 36*47bd0b3bSCharles Chanit under the terms of the GNU General Public License as published by 37*47bd0b3bSCharles Chanthe Free Software Foundation; version 2 of the License 38*47bd0b3bSCharles Chan 39*47bd0b3bSCharles ChanThis program is distributed in the hope that it will be useful, 40*47bd0b3bSCharles Chanbut WITHOUT ANY WARRANTY; without even the implied warranty of 41*47bd0b3bSCharles ChanMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42*47bd0b3bSCharles ChanGNU General Public License for more details. 43*47bd0b3bSCharles Chan 44*47bd0b3bSCharles ChanSee the COPYING file in your DokuWiki folder for details 45