API-referencia: AI

Az AI-végpontok aszinkron módon futtatják az AI-promptokat, az eredmény pedig lekérdezhető.

Közvetlen AI-prompt indítása (aszinkron; az eredmény lekérdezéséhez küldje el a POST …/ai/{promptType}/status kérést ugyanazzal a törzzsel)

Végpont: POST /v1/tenant/{tenantId}/ai/{promptType}

Hitelesítés: Tenanthez kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	útvonal	Igen	Engedélyezett értékek: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Kérés törzse:

{
	"prompt": "string",
	"summaryVariant": "string"
}

Mező	Típus	Kötelező	Leírás
prompt	string	Igen	Természetes nyelvű prompt Maximális hossz: 10000
summaryVariant	string	Nem

Válasz (200):

AI-eredmény (állapot: success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}

Mező	Típus	Kötelező	Leírás
status	success | error | generating	Igen	Engedélyezett értékek: success, error, generating
result	object | object | object | object | object | object	Nem	A prompt típusától függő eredményadat (sikeres állapot esetén jelenik meg)
error	string	Nem	Hibaüzenet, ha az állapot error

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
• 429 A használati korlát elérve

Folyamatban lévő AI-generálás lekérdezése (küldje el pontosan ugyanazt a törzset, mint az indító POST-kérésben)

A lekérdezéshez szándékosan POST-kérést kell küldeni: a generálást a prompt, a promptType és a summaryVariant azonosítja, ezért a lekérdezésben a törzset kell megismételni, nem egy futásazonosítót megadni.

Végpont: POST /v1/tenant/{tenantId}/ai/{promptType}/status

Hitelesítés: Tenanthez kötött API-kulcs · write hatókör

Paraméterek:

Név	Típus	Hely	Kötelező	Leírás
tenantId	string	útvonal	Igen	Formátum: uuid
promptType	processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit	útvonal	Igen	Engedélyezett értékek: processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Kérés törzse:

{
	"prompt": "string",
	"summaryVariant": "string"
}

Mező	Típus	Kötelező	Leírás
prompt	string	Igen	Természetes nyelvű prompt Maximális hossz: 10000
summaryVariant	string	Nem

Válasz (200):

AI-eredmény (állapot: success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}

Mező	Típus	Kötelező	Leírás
status	success | error | generating	Igen	Engedélyezett értékek: success, error, generating
result	object | object | object | object | object | object	Nem	A prompt típusától függő eredményadat (sikeres állapot esetén jelenik meg)
error	string	Nem	Hibaüzenet, ha az állapot error

Hibák:

• 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
• 429 A használati korlát elérve