How To Activate Arcana in the GWDG Chat AI Environment
For more information see here:
https://docs.hpc.gwdg.de/services/arcana/getting-started/index.html
A step-by-step guide to set up Arcana (Retrieval-Augmented Generation) and use it inside GWDG’s Chat AI, including best practices and reference links.
Prerequisites
- Have a valid Academic Cloud or university SSO account.
- Be able to log in to Chat AI using your institution’s federated login.
Setting Up Arcana
- Open the Arcana (RAG) Manager in your browser (for many institutions this is available under the Chat AI portal).
- After signing in, go to Arcanas → + Add New Arcana (or Create New Arcana), then:
- Enter a clear, descriptive Name for your Arcana.
- (Optional) Enable Secure Arcana Name to append a random hash for easier, private sharing.
- Upload the source documents you want to use for retrieval:
- Common formats:
.pdf,.txt,.md,.docx, and others supported by your deployment. - Prefer clean, well-structured files with headings and short paragraphs.
- Common formats:
- Start Index Generation. Arcana will process and index your content for retrieval.
- When the status shows Indexed, generate and note your Arcana ID (and/or an Access Link) for use in chat sessions.
Using Arcana in Chat AI
- Open the Chat AI interface and choose a model that supports RAG (usually indicated with a book icon).
- In Advanced Options, locate the field for Arcana ID and paste your ID.
- Alternatively, open a chat via the Arcana’s pre-generated link (includes the ID).
- Optionally tune parameters (e.g., system prompt, temperature, max tokens). For factual answers, a lower temperature is often best.
- Ask your questions normally—responses will be grounded in your indexed documents.
Tips and Best Practices
- Structure Matters: Headings, lists, and concise paragraphs improve retrieval quality.
- Version Your Sources: Re-index after significant content updates to keep answers current.
- Share Wisely: Provide colleagues or students with the Arcana ID or Access Link as needed.
- Prompt Hygiene: Use short, explicit prompts (e.g., “Cite relevant sections” or “List page numbers”).
- Privacy: Uploaded content is processed and indexed for retrieval; consult your institution’s data-handling policy for details.
References
Quick FAQ
Do I Need Special Permissions To Create an Arcana?
If you can access the Arcana Manager via your Academic Cloud login, you can usually create your own Arcana. Some institutions may restrict features—check with your IT.
Which File Types Work Best?
Searchable, text-centric formats (PDF with embedded text, Markdown, DOCX, TXT) work best. Avoid scanned PDFs without OCR.
How Long Does Indexing Take?
Indexing time depends on file size and queue load. You can monitor progress in the Arcana Manager until the status shows Indexed.
Can I Share My Arcana With Others?
Yes. Share the Arcana ID or Access Link with trusted collaborators or students as permitted by your institution’s policies.
Troubleshooting Checklist
- No Results From Documents? Confirm you selected a RAG-enabled model and supplied the correct Arcana ID.
- Index Status Not Green? Wait until Indexed appears, then try again.
- Scanned PDFs? Run OCR or convert to text-based formats and re-index.
- Stale Answers? Re-index after updating source documents.
- Access Issues? Verify your Academic Cloud credentials or contact your local IT helpdesk.
