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