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: 3

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 2

dev-main 2026-08-05 11:39 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
  • ASK_BIIGLE_LLM_ALGORITHM
  • ASK_BIIGLE_LLM_INFERENCE_SERVICE (default: saia-openai-gateway)
  • ASK_BIIGLE_LLM_ARCANA_ID (optional)
  • ASK_BIIGLE_LLM_SYSTEM_PROMPT (optional)
  • ASK_BIIGLE_LLM_ENABLE_TOOLS (default: true)
  • ASK_BIIGLE_LLM_TEMPERATURE (default: 0.2)
  • ASK_BIIGLE_LLM_TOP_P (default: 1.0)

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.