Procurize.AI REST API Referencia#

Programozottan érje el tudásbázisát – dokumentumok, kérdőívek, RAG és jelentések – API tokenjével.

Alkalmazandó: Procurize.AI API v1
Autentikáció: API kulcs a X-API-Key fejlécben (lásd API Tokenek a tokenkezeléshez)
Alap URL: https://api.procurize.com

Áttekintés#

A Procurize.AI REST API programozott hozzáférést biztosít a platform kulcsfontosságú funkcióihoz. Lehetővé teszi a Procurize.AI integrálását belső rendszereivel, a tudásbázis kezelésének automatizálását és egyedi munkafolyamatok építését.

Támogatott modulok (token‑hitelesítéssel):

  • RagArticle – dokumentumok kezelése
  • RagFaq – GYIK bejegyzések kezelése
  • RagQuery – RAG lekérdezések végrehajtása

Autentikáció#

Minden hitelesített végpont API tokent vár a kérés fejlécében.

FejlécÉrték
X-API-Key<YOUR_API_TOKEN>

Példa:

curl -X GET "https://api.procurize.com/v1/..." \
  -H "X-API-Key: your-api-token-here"

💡 A tokenek a szervezetéhez vannak kötve – nem szükséges szervezet‑azonosítót megadni a kérésben.

Alap URL#

Minden REST API végpont az alábbi alapon érhető el:

https://api.procurize.com

Hibakezelés#

Az API a szabványos HTTP státuszkódokat használja.

KódJelentés
200 OKKérés sikeres
201 CreatedErőforrás sikeresen létrehozva
204 No ContentKérés sikeres, nincs választest
400 Bad RequestÉrvénytelen paraméterek vagy hibás kérés
401 UnauthorizedHiányzó vagy érvénytelen API token
403 ForbiddenA token nem rendelkezik jogosultsággal a művelethez
404 Not FoundAz erőforrás nem létezik
500 Internal Server ErrorVáratlan szerverhiba

A hibaválaszok gép‑olvasható hibakódot és ember‑olvasható üzenetet tartalmaznak.

Modul Referencia#

RagArticle#

GET /questionnaire/rag/articles/summary#

Összefoglaló: Kezdőlap összefoglalója

Paraméterek:

KódHelyTípusKötelezőLeírás
projquerystring (uuid)NemProjektazonosító.

Válasz (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

Összefoglaló: Cikkek száma

Paraméterek:

KódHelyTípusKötelezőLeírás
qquerystringNemSzűrés cikk neve vagy kódja alapján.
statequeryarrayNemSzűrés állapotok szerint.
projectqueryarrayNemSzűrés projektek szerint.
typequeryarrayNemSzűrés dokumentumtípusok szerint.

Válasz (200):

42

GET /questionnaire/rag/articles/list#

Összefoglaló: Cikkek listájának lekérése

Paraméterek:

KódHelyTípusKötelezőLeírás
qquerystringNemSzűrés cikk neve vagy kódja alapján.
statequeryarrayNemSzűrés állapotok szerint.
projectqueryarrayNemSzűrés projektek szerint.
typequeryarrayNemSzűrés dokumentumtípusok szerint.
squerystringNemRendezési mező.
ascquerybooleanNemNövekvő rendezés.
psqueryinteger (int32)NemOldalméret.
pqueryinteger (int32)Nem1‑al kezdődő oldalszám.

Válasz (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 42,
    "totalPages": 5
  },
  "items": [
    {
      "code": "ART-001",
      "org": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Cikk címe",
      "description": "Cikk leírása",
      "documentTypes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Típus neve",
          "plural": "Típus nevek",
          "count": 5
        }
      ],
      "size": 150,
      "revision": {
        "id": "00000000-0000-0000-0000-000000000000",
        "collectionId": "00000000-0000-0000-0000-000000000000",
        "rev": 3,
        "date": "2025-01-15T10:30:00Z",
        "author": {
          "id": "user123",
          "name": "John Doe",
          "email": "john.doe@example.com",
          "login": "johndoe",
          "ra": true
        },
        "authorName": "John Doe",
        "analysisSummary": {
          "id": "00000000-0000-0000-0000-000000000000",
          "initiator": {
            "id": "user123",
            "name": "John Doe",
            "email": "john.doe@example.com",
            "login": "johndoe",
            "ra": true
          },
          "created": "2025-01-15T10:30:00Z",
          "state": "Completed",
          "stateDate": "2025-01-15T10:35:00Z",
          "stateDetails": "Analysis completed successfully",
          "operationId": "op-12345"
        }
      },
      "type": "Article",
      "state": "Active",
      "projects": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "items": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "isShared": false
    }
  ]
}

POST /questionnaire/rag/file-to-md#

Összefoglaló: Markdown tartalom visszaadása a fájlból

Kérelem törzse (multipart/form-data):

{
  "url": "https://example.com/file.pdf",
  "file": "binary"
}

Válasz (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

Összefoglaló: Cikk létrehozása

Kérelem törzse (multipart/form-data):

{
  "code": "ART-001",
  "name": "Cikk címe",
  "description": "Cikk leírása",
  "content": "# Cikk tartalma\n\nEz a cikk tartalma.",
  "url": "https://example.com/file.pdf",
  "file": "binary"
}

Válasz (200):

{
  "code": "ART-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Cikk címe",
  "description": "Cikk leírása",
  "documentTypes": null,
  "size": 150,
  "revision": null,
  "type": "Article",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

GET /questionnaire/rag/article/check#

Összefoglaló: Cikk létezésének ellenőrzése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.

Válasz (200):

true

GET /questionnaire/rag/article-info#

Összefoglaló: Cikk információ lekérése kód alapján.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.

Válasz (200):

{
  "code": "ART-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Cikk címe",
  "description": "Cikk leírása",
  "documentTypes": null,
  "size": 150,
  "revision": null,
  "type": "Article",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

GET /questionnaire/rag/article#

Összefoglaló: Cikk tartalmának lekérése kód alapján

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.
formatquerystringNemHa igaz, HTML tartalmat ad vissza a választestben; egyébként Markdown formátumban.
splitquerybooleanNemHa igaz, a tartalmat RAG elemek szerint szétválasztva adja vissza.
cssquerybooleanNemHa igaz, a HTML/PDF tartalmat CSS‑szel együtt adja vissza.

Válasz (200):

"# Cikk címe\n\nEz a cikk tartalma Markdown formátumban."

POST /questionnaire/rag/article#

Összefoglaló: Cikk metaadatainak frissítése

Kérelem törzse:

{
  "code": "ART-001",
  "name": "Frissített cikk címe",
  "description": "Frissített leírás",
  "projects": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "documentTypes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Típus neve",
      "plural": "Típus nevek"
    }
  ],
  "isShared": true,
  "state": "Active"
}

Válasz (200):

{}

DELETE /questionnaire/rag/article#

Összefoglaló: Cikk törlése

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.

GET /questionnaire/rag/article/pdf#

Összefoglaló: Cikk PDF‑ként való lekérése kód alapján

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.

Válasz (200):

(pdf binary)

GET /questionnaire/rag/article/content#

Összefoglaló: Cikk tartalmának lekérése

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.

Válasz (200):

{
  "content": "# Cikk címe\n\nTartalom itt."
}

POST /questionnaire/rag/article/content#

Összefoglaló: Cikk tartalmának frissítése

Kérelem törzse (multipart/form-data):

{
  "code": "ART-001",
  "content": "# Frissített tartalom",
  "file": "binary"
}

POST /questionnaire/rag/plural#

Összefoglaló: Főnév többes számú alakjának lekérése

Paraméterek:

KódHelyTípusKötelezőLeírás
nounquerystringNemA többes számra alakítandó főnév.

Válasz (200):

{
  "plural": "Articles"
}

POST /questionnaire/rag/article/find-types#

Összefoglaló: Cikk elemzés AI‑val és típusainak visszaadása

Kérelem törzse (multipart/form-data):

{
  "code": "ART-001",
  "content": "# Cikk tartalma"
}

Válasz (200):

[
  {
    "plural": "Types"
  }
]

POST /questionnaire/rag/article/format-with-ai#

Összefoglaló: Cikk tartalmának formázása AI‑val

Kérelem törzse (multipart/form-data):

{
  "code": "ART-001",
  "content": "# Cikk tartalma"
}

Válasz (200):

{
  "formattedContent": "# Formatted Article Content"
}

POST /questionnaire/rag/article/improve-on-suggestions#

Összefoglaló: Dokumentum javítása javaslatok alapján

Kérelem törzse (multipart/form-data):

{
  "suggestions": [
    {
      "sectionTitle": "Bevezetés",
      "suggestion": "Adj hozzá több részletet itt."
    }
  ],
  "code": "ART-001",
  "content": "# Cikk tartalma"
}

Válasz (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

Összefoglaló: Cikk részeinek listájának visszaadása

Paraméterek:

KódHelyTípusKötelezőLeírás
idqueryarrayIgenCikk részek listája.

Válasz (200):

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "code": "part-1",
    "title": "Bevezetés",
    "orderNumber": 1,
    "content": "Bevezető tartalom."
  }
]

GET /questionnaire/rag/article/revisions#

Összefoglaló: Cikk revíziók listájának visszaadása

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.

Válasz (200):

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "collectionId": "00000000-0000-0000-0000-000000000000",
    "rev": 1,
    "date": "2025-01-15T10:30:00Z",
    "author": {
      "id": "user123",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "login": "johndoe",
      "ra": true
    },
    "authorName": "John Doe",
    "analysisSummary": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initiator": {
        "id": "user123",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "login": "johndoe",
        "ra": true
      },
      "created": "2025-01-15T10:30:00Z",
      "state": "Completed",
      "stateDate": "2025-01-15T10:35:00Z",
      "stateDetails": "Analysis completed",
      "operationId": "op-12345"
    }
  }
]

GET /questionnaire/rag/article/revisions/info/{id}#

Összefoglaló: Cikk revízió információk lekérése

Paraméterek:

KódHelyTípusKötelezőLeírás
idpathstring (uuid)IgenRevízió azonosítója.

Válasz (200):

{
  "id": "00000000-0000-0000-0000-000000000000",
  "collectionId": "00000000-0000-0000-0000-000000000000",
  "rev": 1,
  "date": "2025-01-15T10:30:00Z",
  "author": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "authorName": "John Doe",
  "analysisSummary": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initiator": {
      "id": "user123",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "login": "johndoe",
      "ra": true
    },
    "created": "2025-01-15T10:30:00Z",
    "state": "Completed",
    "stateDate": "2025-01-15T10:35:00Z",
    "stateDetails": "Analysis completed",
    "operationId": "op-12345"
  }
}

GET /questionnaire/rag/article/revisions/{id}#

Összefoglaló: Cikk revízió tartalmának lekérése

Paraméterek:

KódHelyTípusKötelezőLeírás
idpathstring (uuid)IgenRevízió azonosítója.

Válasz (200):

"# Article Revision Content\n\nPrevious version."

GET /questionnaire/rag/article/analyze#

Összefoglaló: Cikk tartalmának AI‑val történő elemzése

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA cikk kódja.
revqueryinteger (int32)NemRevízió száma.
forcequerybooleanNemÚj elemzés kényszerítése, és a korábbi befejezetlen eredmény törlése, ha létezik.

Válasz (200):

{
  "id": "00000000-0000-0000-0000-000000000000",
  "initiator": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "created": "2025-01-15T10:30:00Z",
  "state": "Completed",
  "stateDate": "2025-01-15T10:35:00Z",
  "stateDetails": "Analysis completed",
  "operationId": "op-12345"
}

GET /questionnaire/rag/article/analyze/{id}#

Összefoglaló: Cikk elemzési eredményének lekérése

Paraméterek:

KódHelyTípusKötelezőLeírás
idpathstring (uuid)IgenElemzés azonosítója.

Válasz (200):

{
  "id": "00000000-0000-0000-0000-000000000000",
  "initiator": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "created": "2025-01-15T10:30:00Z",
  "state": "Completed",
  "stateDate": "2025-01-15T10:35:00Z",
  "stateDetails": "Analysis completed",
  "operationId": "op-12345",
  "fragments": [
    "fragment-1",
    "fragment-2"
  ],
  "ownInconcies": "Own inconsistencies found",
  "ragInconcies": "RAG inconsistencies found",
  "proposals": "Improvement proposals"
}

GET /questionnaire/rag/messages/list#

Összefoglaló: Üzenetek listázása

Paraméterek:

KódHelyTípusKötelezőLeírás
idquerystring (uuid)IgenRAG gyűjtemény azonosítója.
itemquerystring (uuid)NemRAG elem azonosítója.
messagequerystring (uuid)NemÜzenet azonosítója.
ascquerybooleanNemNövekvő rendezés.
psqueryinteger (int32)NemOldalméret.
pqueryinteger (int32)Nem1‑al kezdődő oldalszám.

Válasz (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "replyTo": null,
      "questionnaire": null,
      "section": null,
      "question": null,
      "ragCollection": "00000000-0000-0000-0000-000000000000",
      "ragItem": "00000000-0000-0000-0000-000000000000",
      "targetId": "00000000-0000-0000-0000-000000000000",
      "targetType": "Question",
      "targetNum": 1,
      "author": {
        "id": "user123",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "login": "johndoe",
        "ra": true
      },
      "text": "Message content",
      "created": "2025-01-15T10:30:00Z",
      "updated": "2025-01-15T10:30:00Z",
      "replies": 0
    }
  ]
}

POST /questionnaire/rag/messages/add#

Összefoglaló: Új üzenet hozzáadása

Paraméterek:

KódHelyTípusKötelezőLeírás
idquerystring (uuid)IgenRAG gyűjtemény azonosítója.
itemquerystring (uuid)NemRAG elem azonosítója.
messagequerystring (uuid)NemVálaszolandó üzenet azonosítója.

Kérelem törzse:

{
  "text": "New message content"
}

Válasz (200):

{
  "id": "00000000-0000-0000-0000-000000000000",
  "replyTo": null,
  "questionnaire": null,
  "section": null,
  "question": null,
  "ragCollection": "00000000-0000-0000-0000-000000000000",
  "ragItem": "00000000-0000-0000-0000-000000000000",
  "targetId": "00000000-0000-0000-0000-000000000000",
  "targetType": "Question",
  "targetNum": 1,
  "author": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "text": "New message content",
  "created": "2025-01-15T10:30:00Z",
  "updated": "2025-01-15T10:30:00Z",
  "replies": 0
}

POST /questionnaire/rag/message#

Összefoglaló: Létező üzenet frissítése

Paraméterek:

KódHelyTípusKötelezőLeírás
cquerystring (uuid)IgenRAG gyűjtemény azonosítója.
idquerystring (uuid)IgenÜzenet azonosítója.

Kérelem törzse:

{
  "text": "Updated message content"
}

Válasz (200):

{
  "id": "00000000-0000-0000-0000-000000000000",
  "replyTo": null,
  "questionnaire": null,
  "section": null,
  "question": null,
  "ragCollection": "00000000-0000-0000-0000-000000000000",
  "ragItem": "00000000-0000-0000-0000-000000000000",
  "targetId": "00000000-0000-0000-0000-000000000000",
  "targetType": "Question",
  "targetNum": 1,
  "author": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "text": "Updated message content",
  "created": "2025-01-15T10:30:00Z",
  "updated": "2025-01-15T10:45:00Z",
  "replies": 0
}

DELETE /questionnaire/rag/message#

Összefoglaló: Létező üzenet törlése

Paraméterek:

KódHelyTípusKötelezőLeírás
idquerystring (uuid)IgenÜzenet azonosítója.

Válasz (200):

{}

RagFaq#

GET /questionnaire/rag/faq-collections/summary#

Összefoglaló: Kezdőlap összefoglalója

Paraméterek:

KódHelyTípusKötelezőLeírás
projquerystring (uuid)NemProjektazonosító.

Válasz (200):

{
  "active": 3
}

GET /questionnaire/rag/faq-collections/total#

Összefoglaló: GYIK gyűjtemények száma.

Paraméterek:

KódHelyTípusKötelezőLeírás
qquerystringNemSzűrés gyűjtemény név vagy kód alapján.
statequeryarrayNemSzűrés állapotok szerint.
projectqueryarrayNemSzűrés projektek szerint.

Válasz (200):

3

GET /questionnaire/rag/faq-collections/list#

Összefoglaló: GYIK gyűjtemények listájának lekérése.

Paraméterek:

KódHelyTípusKötelezőLeírás
qquerystringNemSzűrés gyűjtemény név vagy kód alapján.
statequeryarrayNemSzűrés állapotok szerint.
projectqueryarrayNemSzűrés projektek szerint.
squerystringNemRendezési mező.
ascquerybooleanNemNövekvő rendezés.
psqueryinteger (int32)NemOldalméret.
pqueryinteger (int32)Nem1‑al kezdődő oldalszám.

Válasz (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 3,
    "totalPages": 1
  },
  "items": [
    {
      "code": "FAQ-001",
      "org": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "FAQ Gyűjtemény",
      "description": "FAQ gyűjtemény leírása",
      "documentTypes": null,
      "size": 5,
      "revision": null,
      "type": "Faq",
      "state": "Active",
      "projects": null,
      "items": null,
      "isShared": false
    }
  ]
}

GET /questionnaire/rag/faq-collections/find-items#

Összefoglaló: GYIK elemek keresése.

Paraméterek:

KódHelyTípusKötelezőLeírás
qquerystringIgenSzűrés kérdés alapján.
projectquerystring (uuid)NemSzűrés projekt szerint.
psqueryinteger (int32)NemOldalméret.
pqueryinteger (int32)Nem1‑al kezdődő oldalszám.

Válasz (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "index": 0,
      "question": "Mi ez a termék?",
      "answer": "Ez egy nagyszerű termék.",
      "comment": "Termék GYIK",
      "state": "Active"
    }
  ]
}

POST /questionnaire/rag/faq-collection/create#

Összefoglaló: Új GYIK gyűjtemény létrehozása.

Kérelem törzse (multipart/form-data):

{
  "code": "FAQ-001",
  "name": "FAQ Gyűjtemény",
  "description": "FAQ gyűjtemény leírása",
  "content": "Tartalom itt",
  "file": "binary"
}

Válasz (200):

{
  "code": "FAQ-001",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "FAQ Gyűjtemény",
  "description": "FAQ gyűjtemény leírása",
  "documentTypes": null,
  "size": 5,
  "revision": null,
  "type": "Faq",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

POST /questionnaire/rag/faq-collection#

Összefoglaló: GYIK gyűjtemény metaadatainak frissítése.

Kérelem törzse:

{
  "code": "FAQ-001",
  "name": "Frissített FAQ Gyűjtemény",
  "description": "Frissített leírás",
  "projects": null,
  "documentTypes": null,
  "isShared": false,
  "state": "Active"
}

DELETE /questionnaire/rag/faq-collection#

Összefoglaló: GYIK gyűjtemény törlése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.

GET /questionnaire/rag/faq-collection#

Összefoglaló: GYIK gyűjtemény lekérése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.

Válasz (200):

{
  "code": "FAQ-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "FAQ Gyűjtemény",
  "description": "FAQ gyűjtemény leírása",
  "documentTypes": null,
  "size": 5,
  "revision": null,
  "type": "Faq",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

GET /questionnaire/rag/faq-collection/check#

Összefoglaló: GYIK gyűjtemény létezésének ellenőrzése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.

Válasz (200):

true

GET /questionnaire/rag/faq-collection/items-total#

Összefoglaló: GYIK elemek száma.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.
qquerystringNemSzűrés GYIK elem tartalma alapján.

Kérelem törzse:

["Active", "Default"]

Válasz (200):

5

GET /questionnaire/rag/faq-collection/items#

Összefoglaló: GYIK elemek listájának lekérése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.
qquerystringNemSzűrés GYIK elem tartalma alapján.
statequeryarrayNemSzűrés állapotok szerint.
squerystringNemRendezési mező.
ascquerybooleanNemNövekvő rendezés.
psqueryinteger (int32)NemOldalméret.
pqueryinteger (int32)Nem1‑al kezdődő oldalszám.

Válasz (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "index": 0,
      "question": "Mi ez a termék?",
      "answer": "Ez egy nagyszerű termék.",
      "comment": "Termék GYIK",
      "state": "Active"
    }
  ]
}

POST /questionnaire/rag/faq-collection/item/create#

Összefoglaló: Új GYIK elem létrehozása.

Kérelem törzse:

{
  "code": "FAQ-001",
  "index": 0,
  "question": "Mi ez a termék?",
  "answer": "Ez egy nagyszerű termék.",
  "comment": "Termék GYIK",
  "state": "Active"
}

Válasz (200):

{
  "index": 0,
  "question": "Mi ez a termék?",
  "answer": "Ez egy nagyszerű termék.",
  "comment": "Termék GYIK",
  "state": "Active"
}

GET /questionnaire/rag/faq-collection/item#

Összefoglaló: GYIK elem lekérése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.
indexqueryinteger (int32)IgenA GYIK elem nulla‑bázisú indexe a gyűjteményben.

Válasz (200):

{
  "index": 0,
  "question": "Mi ez a termék?",
  "answer": "Ez egy nagyszerű termék.",
  "comment": "Termék GYIK",
  "state": "Active"
}

POST /questionnaire/rag/faq-collection/item#

Összefoglaló: GYIK elem frissítése.

Kérelem törzse:

{
  "code": "FAQ-001",
  "index": 0,
  "newIndex": 1,
  "question": "Frissített kérdés?",
  "answer": "Frissített válasz.",
  "comment": "Frissített megjegyzés",
  "state": "Active"
}

DELETE /questionnaire/rag/faq-collection/item#

Összefoglaló: GYIK elem törlése.

Paraméterek:

KódHelyTípusKötelezőLeírás
codequerystringIgenA gyűjtemény kódja.
indexqueryinteger (int32)IgenA GYIK elem nulla‑bázisú indexe a gyűjteményben.

RagQuery#

POST /questionnaire/rag/query#

Összefoglaló: Lekérdezés végrehajtása a RAG tudásbázison

Kérelem törzse:

{
  "project": "00000000-0000-0000-0000-000000000000",
  "excludeCollections": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "question": "Mi ez a termék?",
  "yourCompanyName": "Acme Corp",
  "yourCompanyAlias": "Acme",
  "customerName": "John Doe",
  "options": [
    "option1",
    "option2"
  ],
  "multiselect": false,
  "nArticles": 5,
  "nFaqs": 3,
  "threshold": 0.5,
  "debug": false,
  "withJustification": true,
  "withConfidenceLevel": true,
  "withFragments": true,
  "nAttempts": 3
}

Válasz (200):

{
  "attempt": 1,
  "preparedQuery": {
    "original": "Mi ez a termék?",
    "enhanced": "Mi ez a termék és milyen tulajdonságai vannak?"
  },
  "ragItems": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "distance": 0.25
    }
  ],
  "question": "Mi ez a termék?",
  "generalInstructions": "A tudásbázis alapján a válasz:",
  "text": "Ez a termék egy nagyszerű megoldás az Ön igényeire.",
  "explanation": "A válasz több forrásból származik magas bizalommal."
}

POST /questionnaire/rag/query-stream#

Összefoglaló: Lekérdezés végrehajtása a RAG tudásbázison (stream)

Kérelem törzse: (azonos a fentihez)

Válasz (200):

[
  {
    "text": "Ez a termék egy nagyszerű megoldás",
    "fragments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "part": 1,
        "distance": 0.25,
        "type": "Article",
        "code": "ART-001",
        "title": "Termék címe",
        "fragment": "Termék tartalom részlet"
      }
    ]
  },
  {
    "text": " az Ön igényeire.",
    "fragments": []
  }
]

POST /questionnaire/rag/query-fragments#

Összefoglaló: Lekérdezés végrehajtása a RAG tudásbázison fragmentumokkal

Kérelem törzse:

{
  "project": "00000000-0000-0000-0000-000000000000",
  "exclude_documents": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "query": "Mi ez a termék?",
  "top_k": 5,
  "similarity_threshold": 0.5,
  "prepare_query": true
}

Válasz (200):

{
  "results": [
    {
      "document_id": "00000000-0000-0000-0000-000000000000",
      "document_code": "ART-001",
      "document_title": "Termék címe",
      "revision": 3,
      "chunk_index": 0,
      "content": "Termék tartalom részlet",
      "metadata": {
        "author": "John Doe",
        "created_at": "2025-01-15T10:30:00Z",
        "last_updated_at": "2025-01-15T10:35:00Z",
        "doc_categories": [
          "Product",
          "Information"
        ]
      },
      "similarity_score": 0.85
    }
  ]
}

Kapcsolódó Cikkek#

felülre
Válasszon nyelvet
English
Български
Čeština
Dansk
Deutsch
Ελληνική
Eestlane
Español
Suomalainen
Français
Hrvatski
Magyar
Հայերեն
Indonesia
Italiano
Lietuvių
Melayu
Nederlands
Polski
Português
Română
Русский
Slovenský
Svenska
ไทย
Türk
Українська
Tiếng Việt
한국어
日本語
中文
العربية
ქართული
עִברִית
हिंदी
فارسی