SDK
Privát AI – Plugin fejlesztői dokumentáció

Privát AI  SDK

Útmutató a Plugin / AI Agent fejlesztőknek, akik egyedi eszközöket szeretnének illeszteni a Privát AI - Agent Orchestration / GraphRAG Platformhoz. A dokumentáció végigvezet az első egyszerű tool-tól a komplex orchestrátoros megoldásokig.

Fejezetek

1. fejezet

Bevezető és architektúra áttekintés

Mi a platform, mit lehet rá fejleszteni, hogyan illeszkedik a plugin a rendszerbe.

2. fejezet

Projekt beállítás

Maven konfiguráció, platform-bom, plugin.jar felépítése, ServiceLoader regisztráció.

3. fejezet

Az első tool – IChatbotTool

Egyszerű tool lépésről lépésre: implementáció, regisztráció, deploy, tesztelés.

4. fejezet

Tool típusok és mikor melyiket

IChatbotTool, IOrchestratorActivatedTool, IClarifiableTool, IIngestionTool – döntési útmutató.

5. fejezet

Orchestrátor tool fejlesztés

AbstractOrchestratorTool, prototype scope, sub-query kezelés, retrieval profil.

6. fejezet

Agent-koordináció – IAgentCoordinator

Feladat-szétbontás, rész-lépés-fa, tool-ok együttműködésének csatornái - kontextus-megosztás, garantált függőség, közvetlen hívás.

7. fejezet

Interaktív tisztázó kérdezés

IClarifiableTool, ClarificationSession, applyAnswer, detectNextQuestion – lépésről lépésre.

8. fejezet

LLM hívások pluginből

ILlmAssistant injektálása, strukturált JSON válasz, hibakezelés.

9. fejezet

ToolExecutionResult módok

CONTEXT, ANSWER, ANSWERED, NEEDS_CLARIFICATION – mikor melyiket és mi történik utána.

10. fejezet

NER ingestion pipeline

IIngestionTool, tudásgráf feltöltés, KnowledgeGraphService, mikor érdemes implementálni.

11. fejezet

Plugin csomagolás és deploy

Teljes lifecycle: build, könyvtárstruktúra, class loading, tranzitív függőségek.

12. fejezet

Aszinkron feladatok

IAsyncTaskTool, AsyncTaskProgressReporter, AbstractGraphEnrichmentTask – külső hívó által indítható, hosszú futású feladatok.

13. fejezet

Platform API

Backend integrátoroknak szóló REST végpontok – AI feladat futtatás és az aszinkron feladatok indítása/lekérdezése.

14. fejezet

MCP-integráció

AbstractMcpTool, McpServerDescriptor, IMcpSession – külső rendszerek adatai MCP szerveren át, visszakérdezéssel, megerősítéssel és kiszivárgás-ellenőrzéssel.

Haladó témák

Haladó fejezet

Spark batch LLM feldolgozás

BaseLLMTransformer, SummaryToolTransformer, BatchedSummaryTransformer – párhuzamos feldolgozás ingestion-ban és azon túl.

Haladó fejezet

Plugin adatbázis-hozzáférés

IPluginConfigurer, AbstractPluginJpaConfigurer, Spring @Transactional minta saját JPA persistence unit-hoz.

Haladó fejezet

KnowledgeGraphService

Saját tudásgráf-ingestion nem platform-feldolgozott, nem szöveges forrásadatból – upsertConcept, upsertRelation, saveMention.

Haladó fejezet

Plugin fejlesztési minták

Melyik tool-mintát melyik esetre – lookup, orchestrátor-lánc, interaktív tool, NER utófeldolgozás, önmagát streamelő tool, gráfbejárás.

Referencia

Referencia

API referencia

Az SDK összes publikus interfésze, osztálya és bean-je annotált leírással.

ℹ️
Ez a dokumentáció a platform SDK-jának nyilvános részét írja le. A belső implementációk (orchestrálási logika, LLM kliens, ArangoDB service-ek) nem kerülnek nyilvánosságra – ezek az @SdkApi(strip=true) annotációval jelölt osztályokban találhatók és csak stub formában érhetők el az SDK JAR-ban.