xref: /plugin/ragasker/README.md (revision ee5a17d9fbcd1782f5b6e74c2d73d7240fd2f789)
1*ee5a17d9SCharles Chan## RagAsker Plugin for DokuWiki
2*ee5a17d9SCharles Chan
3*ee5a17d9SCharles 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.
4*ee5a17d9SCharles Chan
5*ee5a17d9SCharles Chan### Main Features
6*ee5a17d9SCharles Chan
7*ee5a17d9SCharles Chan- **AI-Powered Q&A Widget**: Adds an interactive widget to your wiki pages, allowing users to input questions and receive AI-generated answers.
8*ee5a17d9SCharles Chan- **Keyword Extraction & Search**: Automatically extracts keywords from user queries and searches relevant wiki pages to enhance answer accuracy.
9*ee5a17d9SCharles Chan- **Retrieval-Augmented Generation**: Combines retrieved wiki content with large language models to generate context-rich responses.
10*ee5a17d9SCharles Chan- **Custom Syntax Support**: Use `~~RAGASKER~~` syntax to embed the Q&A widget anywhere in your wiki.
11*ee5a17d9SCharles Chan- **Multi-language UI**: Supports multiple languages for user interface and prompts.
12*ee5a17d9SCharles Chan- **Configurable**: Easily set API endpoint, key, model, and other parameters via plugin settings.
13*ee5a17d9SCharles Chan
14*ee5a17d9SCharles Chan### Typical Use Cases
15*ee5a17d9SCharles Chan
16*ee5a17d9SCharles Chan- Knowledge base Q&A
17*ee5a17d9SCharles Chan- Wiki content search and summarization
18*ee5a17d9SCharles Chan- Intelligent assistant for documentation
19*ee5a17d9SCharles Chan
20*ee5a17d9SCharles Chan### Requirements
21*ee5a17d9SCharles Chan
22*ee5a17d9SCharles Chan- DokuWiki installation
23*ee5a17d9SCharles Chan- Access to OpenAI API or compatible LLM service
24*ee5a17d9SCharles Chan
25*ee5a17d9SCharles Chan### Installation
26*ee5a17d9SCharles Chan
27*ee5a17d9SCharles Chan1. Copy the plugin folder to `lib/plugins/ragasker` in your DokuWiki installation.
28*ee5a17d9SCharles Chan2. Configure API settings in the plugin configuration page.
29*ee5a17d9SCharles Chan3. Add `~~RAGASKER~~` to any wiki page to enable the widget.
30*ee5a17d9SCharles Chan
31*ee5a17d9SCharles Chan### License
32*ee5a17d9SCharles Chan
33*ee5a17d9SCharles ChanSee plugin.info.txt for details.
34