Search by

biigle / ask-biigle

A BIIGLE module to offer help through a chat interface.

Maintainers

Package info

github.com/biigle/ask-biigle

Homepage

pkg:composer/biigle/ask-biigle

Transparency log

Statistics

Installs: 135

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 2

Security

Advisories: 0

Aikido package health analysis

dev-main 2026-09-01 09:02 UTC

Requires

None

Requires (Dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

GPL-3.0-only 9a3109351ace69bef2545f995e147e586357ff0f

  • Martin Zurowietz <m.zurowietz.woop@uni-bielefeld.de>
  • Daniel Langenkämper <dlangenk.woop@cebitec.uni-bielefeld.de>

biiglebiigle-module

Published on Packagist.org on 2026-09-01 09:02 UTC

This package is auto-updated.

Last update: 2026-09-07 04:15:44 UTC

README

Test status

The RAG was built using the GWDG RAG-Manager using the BIIGLE Manual, the BIIGLE paper, the MAIA paper, and the LabelBot paper, as well as An Ecologist's Guide to BIIGLE

Installation

  1. Run composer require biigle/ask-biigle.
  2. Run php artisan vendor:publish --tag=public to refresh the public assets of the modules. Do this for every update of this module.

Configuration

Configure the chatbot backend in the BIIGLE .env:

  • ASK_BIIGLE_LLM_API_URL (default: https://chat-ai.academiccloud.de/v1/chat/completions)
  • ASK_BIIGLE_LLM_API_KEY (required, see API Key)
  • ASK_BIIGLE_LLM_ALGORITHM (default: qwen3-30b-a3b-instruct-2507)
  • ASK_BIIGLE_LLM_INFERENCE_SERVICE (default: saia-openai-gateway)
  • ASK_BIIGLE_LLM_ARCANA_ID (default: d.langenkaemper/BiigleManual, see Arcana)
  • ASK_BIIGLE_LLM_SYSTEM_PROMPT (default: the prompt at the top of src/config/ask-biigle.php)
  • ASK_BIIGLE_LLM_ENABLE_TOOLS (default: true)
  • ASK_BIIGLE_LLM_TEMPERATURE (default: 0.0)
  • ASK_BIIGLE_LLM_TOP_P (default: 0.05)
  • ASK_BIIGLE_LLM_TIMEOUT (default: 29, see Timeout)

Only the API key has to be configured. All other variables have a default that works with the Chat AI service of the GWDG.

After configuration, a new chat button appears in the BIIGLE navbar-right and opens the ask BIIGLE modal.

API Key

To retrieve an API key (ASK_BIIGLE_LLM_API_KEY), please refer to the GWDG SAIA API Request Documentation.

Arcana

The arcana is the RAG index that the answers are based on. If ASK_BIIGLE_LLM_ARCANA_ID is not set, the module falls back to d.langenkaemper/BiigleManual. This arcana is available to all Chat AI users, so the chatbot works with the BIIGLE documentation out of the box and you only need to set this variable if you want to use an arcana of your own.

Timeout

ASK_BIIGLE_LLM_TIMEOUT is the timeout in seconds for the request to the LLM API. The response is streamed with the PHP stream handler, so the timeout applies to a single read and not to the whole transfer. This allows long answers to be streamed completely, as long as the service keeps sending.

A failed request is retried, with three attempts in total, so a value that is close to the timeout of a reverse proxy in front of BIIGLE can still result in a gateway timeout for the browser.

Arcana Update

To update the arcana RAG system, execute arcanaUpdate/rebuildRAG.py. This script scrapes https://biigle.de/manual and updates any modified files.