Dokumentacja OneRAI
OneRAI to wtyczka AI do Sparx Systems Enterprise Architect, która integruje modele językowe (LLM) bezpośrednio w Twoim środowisku modelowania. Rozmawiaj z AI, analizuj model, twórz elementy i dokumentację — bez opuszczania EA.
💡 W każdym oknie OneRAI naciśnij F1 lub kliknij ? aby otworzyć pomoc kontekstową.
Szybka nawigacja
🚀 Szybki start
Pierwsze uruchomienie krok po kroku — instalacja, rejestracja, pierwsze zapytanie.
💬 Okno Chat
Jak prowadzić rozmowę z AI, używać historii, dołączać pliki i zarządzać kontekstem.
📐 Scope / Kontekst EA
Jak przekazywać elementy EA do AI — zakres, pinowanie, dodawanie zaznaczonych.
🧩 Metamodel
Wzorce struktury EA dla AI — zakładka Metamodel, konfiguracja i zastosowanie.
⚙️ Ustawienia
Konfiguracja dostawcy LLM, modelu, parametrów i integracji zewnętrznych.
📚 RAG — Dokumenty
Baza wiedzy z lokalnych plików PDF, DOCX, TXT — wyszukiwanie semantyczne.
🗄️ Tryb SQL
Zapytania SQL do repozytorium EA — analiza danych bez wychodzenia z modelu.
🔓 Tryb Bypass
Pomijanie system prompt — bezpośrednia praca z modelem bez predefiniowanego kontekstu.
Ustawienia
| Zakładka | Zawartość |
|---|---|
| Model | Wybór dostawcy LLM, endpointu, klucza API i modelu |
| Parametry | Temperature, Max Tokens, Context Window |
| Azure DevOps | Integracja z Azure DevOps — Work Items, repozytoria |
| JIRA | Integracja z Atlassian JIRA — zadania, projekty |
📖 Dokumentacja jest dostępna w języku polskim i angielskim. Użyj przycisków PL / EN w prawym górnym rogu, aby przełączyć język.
OneRAI Documentation
OneRAI is an AI add-in for Sparx Systems Enterprise Architect that integrates language models (LLMs) directly into your modeling environment. Chat with AI, analyze your model, create elements and documentation — without leaving EA.
💡 In any OneRAI window press F1 or click ? to open context-sensitive help.
Quick Navigation
🚀 Quick Start
First run step by step — installation, registration, first query.
💬 Chat Window
How to converse with AI, use history, attach files, and manage context.
📐 Scope / EA Context
How to pass EA elements to AI — scope, pinning, adding selected elements.
🧩 Metamodel
EA structure patterns for AI — Metamodel tab, configuration and use.
⚙️ Settings
Configure LLM provider, model, parameters and external integrations.
📚 RAG — Documents
Knowledge base from local PDF, DOCX, TXT files — semantic search.
🗄️ SQL Mode
SQL queries against the EA repository — data analysis without leaving the model.
🔓 Bypass Mode
Skip the system prompt — work directly with the model without predefined context.
Settings
| Tab | Contents |
|---|---|
| Model | Choose LLM provider, endpoint, API key, and model |
| Parameters | Temperature, Max Tokens, Context Window |
| Azure DevOps | Integration with Azure DevOps — Work Items, repositories |
| JIRA | Integration with Atlassian JIRA — tasks, projects |
📖 Documentation is available in Polish and English. Use the PL / EN buttons in the top-right corner to switch language.