---
sitemap:
  changefreq: yearly
  priority: 0.5
type: docs
group: Integrácie
g_num: 6
o_num: 1
title: "Referenčný manuál REST API – Dokumentácia pre vývojárov Procurize.AI"
description: "Kompletný referenčný manuál REST API pre Procurize.AI. Naučte sa, ako programaticky pristupovať k dokumentom, dotazníkom, RAG a správam pomocou API tokenov. Obsahuje autentifikáciu, koncové body a príklady."
breadcrumb: "Referenčný manuál REST API"
index_title: "Referenčný manuál REST API"
brief: "Kompletný referenčný manuál REST API pre Procurize.AI. Programaticky pristupujte k dokumentom, dotazníkom, RAG, súborom a správam pomocou vášho API tokenu. Obsahuje autentifikáciu, všetky podporované moduly a príklady požiadaviek/odpovedí."
---
# Referenčný manuál REST API Procurize.AI

**Programaticky pristupujte k svojej znalostnej báze – dokumentom, dotazníkom, RAG a správam – pomocou svojho API tokenu.**

> **Platí pre:** Procurize.AI API v1  
> **Autentifikácia:** API kľúč cez hlavičku `X-API-Key` (viac v [API tokeny](/api-tokens/))  
> **Základná URL:** `https://api.procurize.com`

## Prehľad

REST API Procurize.AI poskytuje programatický prístup k kľúčovým funkciám platformy. Umožňuje integrovať Procurize.AI s vašimi internými systémami, automatizovať správu znalostnej bázy a vytvárať vlastné pracovné postupy.

**Podporované moduly (autentifikované tokenom):**

- [**RagArticle**](#ragarticle) – spravovať dokumenty  
- [**RagFaq**](#ragfaq) – spravovať FAQ položky  
- [**RagQuery**](#ragquery) – vykonať RAG dotazy  

## Autentifikácia

Všetky autentifikované koncové body vyžadujú API token odoslaný v hlavičke požiadavky.

| Hlavička   | Hodnota |
|------------|---------|
| `X-API-Key` | `<YOUR_API_TOKEN>` |

**Príklad:**
```bash
curl -X GET "https://api.procurize.com/v1/..." \
  -H "X-API-Key: your-api-token-here"

💡 Tokeny sú viazané na vašu organizáciu – nie je potrebné v požiadavke špecifikovať ID organizácie.

Základná URL#

Všetky koncové body REST API sú dostupné pod:

https://api.procurize.com

Spracovanie chýb#

API používa štandardné HTTP stavové kódy.

KódVýznam
200 OKPožiadavka úspešná
201 CreatedProstriedok úspešne vytvorený
204 No ContentPožiadavka úspešná, žiadne telo odpovede
400 Bad RequestNeplatné parametre alebo nesprávna požiadavka
401 UnauthorizedChýbajúci alebo neplatný API token
403 ForbiddenToken nemá oprávnenie pre túto akciu
404 Not FoundProstriedok neexistuje
500 Internal Server ErrorNeočakávaná chyba servera

Odpovede na chyby obsahujú strojovo čitateľný kód chyby a ľudsky čitateľnú správu.

Referencia modulov#

RagArticle#

GET /questionnaire/rag/articles/summary#

Zhrnutie: Zhrnutie pre domovskú stránku

Parametre:

NázovUmiestnenieTypPovinnéPopis
projquerystring (uuid)NieID projektu.

Odpoveď (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

Zhrnutie: Počet článkov

Parametre:

NázovUmiestnenieTypPovinnéPopis
qquerystringNieFilter podľa názvu alebo kódu článku.
statequeryarrayNieFilter podľa stavov.
projectqueryarrayNieFilter podľa projektov.
typequeryarrayNieFilter podľa typov dokumentov.

Odpoveď (200):

42

GET /questionnaire/rag/articles/list#

Zhrnutie: Získať zoznam článkov

Parametre:

NázovUmiestnenieTypPovinnéPopis
qquerystringNieFilter podľa názvu alebo kódu článku.
statequeryarrayNieFilter podľa stavov.
projectqueryarrayNieFilter podľa projektov.
typequeryarrayNieFilter podľa typov dokumentov.
squerystringNiePole triedenia.
ascquerybooleanNieVzostupné triedenie.
psqueryinteger (int32)NieVeľkosť stránky.
pqueryinteger (int32)NieČíslo stránky (od 1).

Odpoveď (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": "Article Title",
      "description": "Article description",
      "documentTypes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Type Name",
          "plural": "Type Names",
          "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#

Zhrnutie: Vráti Markdown obsah zo súboru

Telo požiadavky (multipart/form-data):

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

Odpoveď (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

Zhrnutie: Vytvoriť článok

Telo požiadavky (multipart/form-data):

{
  "code": "ART-001",
  "name": "Article Title",
  "description": "Article description",
  "content": "# Article Content\n\nThis is the article content.",
  "url": "https://example.com/file.pdf",
  "file": "binary"
}

Odpoveď (200):

{
  "code": "ART-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Article Title",
  "description": "Article description",
  "documentTypes": null,
  "size": 150,
  "revision": null,
  "type": "Article",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

GET /questionnaire/rag/article/check#

Zhrnutie: Skontrolovať existenciu článku.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.

Odpoveď (200):

true

GET /questionnaire/rag/article-info#

Zhrnutie: Získať informácie o článku podľa kódu.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.

Odpoveď (200):

{
  "code": "ART-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Article Title",
  "description": "Article description",
  "documentTypes": null,
  "size": 150,
  "revision": null,
  "type": "Article",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

GET /questionnaire/rag/article#

Zhrnutie: Získať obsah článku podľa kódu

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.
formatquerystringNieAk je true, vráti HTML obsah v tele odpovede. Inak vráti obsah článku v Markdown formáte.
splitquerybooleanNieAk je true, vráti obsah rozdelený podľa RAG elementov.
cssquerybooleanNieAk je true, vráti HTML/PDF obsah s CSS.

Odpoveď (200):

"# Article Title\n\nThis is the article content in Markdown format."

POST /questionnaire/rag/article#

Zhrnutie: Aktualizovať metadáta článku

Telo požiadavky:

{
  "code": "ART-001",
  "name": "Updated Article Title",
  "description": "Updated description",
  "projects": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "documentTypes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Type Name",
      "plural": "Type Names"
    }
  ],
  "isShared": true,
  "state": "Active"
}

Odpoveď (200):

{}

DELETE /questionnaire/rag/article#

Zhrnutie: Odstrániť článok

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.

GET /questionnaire/rag/article/pdf#

Zhrnutie: Získať článok ako PDF podľa kódu

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.

Odpoveď (200):

(pdf binary)

GET /questionnaire/rag/article/content#

Zhrnutie: Získať obsah článku

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.

Odpoveď (200):

{
  "content": "# Article Title\n\nContent here."
}

POST /questionnaire/rag/article/content#

Zhrnutie: Aktualizovať obsah článku

Telo požiadavky (multipart/form-data):

{
  "code": "ART-001",
  "content": "# Updated Content",
  "file": "binary"
}

POST /questionnaire/rag/plural#

Zhrnutie: Získať množný tvar podstatného mena

Parametre:

NázovUmiestnenieTypPovinnéPopis
nounquerystringNiePodstatné meno, ktoré sa má množniť.

Odpoveď (200):

{
  "plural": "Articles"
}

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

Zhrnutie: Analyzovať článok pomocou AI a vrátiť ich typy

Telo požiadavky (multipart/form-data):

{
  "code": "ART-001",
  "content": "# Article Content"
}

Odpoveď (200):

[
  {
    "plural": "Types"
  }
]

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

Zhrnutie: Formátovať obsah článku pomocou AI

Telo požiadavky (multipart/form-data):

{
  "code": "ART-001",
  "content": "# Article Content"
}

Odpoveď (200):

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

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

Zhrnutie: Vylepšiť dokument na základe návrhov

Telo požiadavky (multipart/form-data):

{
  "suggestions": [
    {
      "sectionTitle": "Introduction",
      "suggestion": "Add more details here."
    }
  ],
  "code": "ART-001",
  "content": "# Article Content"
}

Odpoveď (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

Zhrnutie: Vráti zoznam častí článku

Parametre:

NázovUmiestnenieTypPovinnéPopis
idqueryarrayÁnoZoznam častí článku.

Odpoveď (200):

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "code": "part-1",
    "title": "Introduction",
    "orderNumber": 1,
    "content": "Introduction content."
  }
]

GET /questionnaire/rag/article/revisions#

Zhrnutie: Vráti zoznam revízií článku

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.

Odpoveď (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}#

Zhrnutie: Získať informácie o revízii článku

Parametre:

NázovUmiestnenieTypPovinnéPopis
idpathstring (uuid)ÁnoID revízie.

Odpoveď (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}#

Zhrnutie: Získať obsah revízie článku

Parametre:

NázovUmiestnenieTypPovinnéPopis
idpathstring (uuid)ÁnoID revízie.

Odpoveď (200):

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

GET /questionnaire/rag/article/analyze#

Zhrnutie: Analyzovať obsah článku pomocou AI

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód článku.
revqueryinteger (int32)NieČíslo revízie.
forcequerybooleanNieVynútiť vytvorenie novej analýzy a vymazať predchádzajúci neúplný výsledok, ak existuje.

Odpoveď (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}#

Zhrnutie: Získať výsledok analýzy článku

Parametre:

NázovUmiestnenieTypPovinnéPopis
idpathstring (uuid)ÁnoID analýzy.

Odpoveď (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#

Zhrnutie: Zoznam všetkých správ

Parametre:

NázovUmiestnenieTypPovinnéPopis
idquerystring (uuid)ÁnoID RAG kolekcie.
itemquerystring (uuid)NieID RAG položky.
messagequerystring (uuid)NieID správy.
ascquerybooleanNieVzostupné triedenie.
psqueryinteger (int32)NieVeľkosť stránky.
pqueryinteger (int32)NieČíslo stránky (od 1).

Odpoveď (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#

Zhrnutie: Pridať novú správu

Parametre:

NázovUmiestnenieTypPovinnéPopis
idquerystring (uuid)ÁnoID RAG kolekcie.
itemquerystring (uuid)NieID RAG položky.
messagequerystring (uuid)NieID správy, na ktorú sa odpovedá.

Telo požiadavky:

{
  "text": "New message content"
}

Odpoveď (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#

Zhrnutie: Aktualizovať existujúcu správu

Parametre:

NázovUmiestnenieTypPovinnéPopis
cquerystring (uuid)ÁnoID RAG kolekcie.
idquerystring (uuid)ÁnoID správy.

Telo požiadavky:

{
  "text": "Updated message content"
}

Odpoveď (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#

Zhrnutie: Odstrániť existujúcu správu

Parametre:

NázovUmiestnenieTypPovinnéPopis
idquerystring (uuid)ÁnoID správy.

Odpoveď (200):

{}

RagFaq#

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

Zhrnutie: Zhrnutie pre domovskú stránku

Parametre:

NázovUmiestnenieTypPovinnéPopis
projquerystring (uuid)NieID projektu.

Odpoveď (200):

{
  "active": 3
}

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

Zhrnutie: Počet FAQ kolekcií.

Parametre:

NázovUmiestnenieTypPovinnéPopis
qquerystringNieFilter podľa názvu alebo kódu kolekcie.
statequeryarrayNieFilter podľa stavov.
projectqueryarrayNieFilter podľa projektov.

Odpoveď (200):

3

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

Zhrnutie: Získať zoznam FAQ kolekcií.

Parametre:

NázovUmiestnenieTypPovinnéPopis
qquerystringNieFilter podľa názvu alebo kódu kolekcie.
statequeryarrayNieFilter podľa stavov.
projectqueryarrayNieFilter podľa projektov.
squerystringNiePole triedenia.
ascquerybooleanNieVzostupné triedenie.
psqueryinteger (int32)NieVeľkosť stránky.
pqueryinteger (int32)NieČíslo stránky (od 1).

Odpoveď (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 Collection",
      "description": "FAQ collection description",
      "documentTypes": null,
      "size": 5,
      "revision": null,
      "type": "Faq",
      "state": "Active",
      "projects": null,
      "items": null,
      "isShared": false
    }
  ]
}

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

Zhrnutie: Nájsť FAQ položky.

Parametre:

NázovUmiestnenieTypPovinnéPopis
qquerystringÁnoFilter podľa otázky.
projectquerystring (uuid)NieFilter podľa projektu.
psqueryinteger (int32)NieVeľkosť stránky.
pqueryinteger (int32)NieČíslo stránky (od 1).

Odpoveď (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "index": 0,
      "question": "What is this product?",
      "answer": "This is a great product.",
      "comment": "Product FAQ",
      "state": "Active"
    }
  ]
}

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

Zhrnutie: Vytvoriť novú FAQ kolekciu.

Telo požiadavky (multipart/form-data):

{
  "code": "FAQ-001",
  "name": "FAQ Collection",
  "description": "FAQ collection description",
  "content": "Content here",
  "file": "binary"
}

Odpoveď (200):

{
  "code": "FAQ-001",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "FAQ Collection",
  "description": "FAQ collection description",
  "documentTypes": null,
  "size": 5,
  "revision": null,
  "type": "Faq",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

POST /questionnaire/rag/faq-collection#

Zhrnutie: Aktualizovať metadáta FAQ kolekcie.

Telo požiadavky:

{
  "code": "FAQ-001",
  "name": "Updated FAQ Collection",
  "description": "Updated description",
  "projects": null,
  "documentTypes": null,
  "isShared": false,
  "state": "Active"
}

DELETE /questionnaire/rag/faq-collection#

Zhrnutie: Odstrániť FAQ kolekciu.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.

GET /questionnaire/rag/faq-collection#

Zhrnutie: Získať FAQ kolekciu.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.

Odpoveď (200):

{
  "code": "FAQ-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "FAQ Collection",
  "description": "FAQ collection description",
  "documentTypes": null,
  "size": 5,
  "revision": null,
  "type": "Faq",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}

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

Zhrnutie: Skontrolovať existenciu FAQ kolekcie.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.

Odpoveď (200):

true

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

Zhrnutie: Počet FAQ položiek.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.
qquerystringNieFilter podľa obsahu FAQ položky.

Telo požiadavky:

["Active", "Default"]

Odpoveď (200):

5

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

Zhrnutie: Získať zoznam FAQ položiek.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.
qquerystringNieFilter podľa obsahu FAQ položky.
statequeryarrayNieFilter podľa stavov.
squerystringNiePole triedenia.
ascquerybooleanNieVzostupné triedenie.
psqueryinteger (int32)NieVeľkosť stránky.
pqueryinteger (int32)NieČíslo stránky (od 1).

Odpoveď (200):

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "index": 0,
      "question": "What is this product?",
      "answer": "This is a great product.",
      "comment": "Product FAQ",
      "state": "Active"
    }
  ]
}

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

Zhrnutie: Vytvoriť novú FAQ položku.

Telo požiadavky:

{
  "code": "FAQ-001",
  "index": 0,
  "question": "What is this product?",
  "answer": "This is a great product.",
  "comment": "Product FAQ",
  "state": "Active"
}

Odpoveď (200):

{
  "index": 0,
  "question": "What is this product?",
  "answer": "This is a great product.",
  "comment": "Product FAQ",
  "state": "Active"
}

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

Zhrnutie: Získať FAQ položku.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.
indexqueryinteger (int32)ÁnoNulovo založený index položky v kolekcii.

Odpoveď (200):

{
  "index": 0,
  "question": "What is this product?",
  "answer": "This is a great product.",
  "comment": "Product FAQ",
  "state": "Active"
}

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

Zhrnutie: Aktualizovať FAQ položku.

Telo požiadavky:

{
  "code": "FAQ-001",
  "index": 0,
  "newIndex": 1,
  "question": "Updated question?",
  "answer": "Updated answer.",
  "comment": "Updated comment",
  "state": "Active"
}

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

Zhrnutie: Odstrániť FAQ položku.

Parametre:

NázovUmiestnenieTypPovinnéPopis
codequerystringÁnoKód kolekcie.
indexqueryinteger (int32)ÁnoNulovo založený index položky v kolekcii.

RagQuery#

POST /questionnaire/rag/query#

Zhrnutie: Vykonať dotaz v RAG Knowledge Base

Telo požiadavky:

{
  "project": "00000000-0000-0000-0000-000000000000",
  "excludeCollections": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "question": "What is this product?",
  "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
}

Odpoveď (200):

{
  "attempt": 1,
  "preparedQuery": {
    "original": "What is this product?",
    "enhanced": "What is this product and its features?"
  },
  "ragItems": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "distance": 0.25
    }
  ],
  "question": "What is this product?",
  "generalInstructions": "Based on the knowledge base, here is the answer:",
  "text": "This product is a great solution for your needs.",
  "explanation": "The answer was found in multiple sources with high confidence."
}

POST /questionnaire/rag/query-stream#

Zhrnutie: Vykonať dotaz v RAG Knowledge Base

Telo požiadavky: (identické ako vyššie)

Odpoveď (200):

[
  {
    "text": "This product is a great solution",
    "fragments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "part": 1,
        "distance": 0.25,
        "type": "Article",
        "code": "ART-001",
        "title": "Product Title",
        "fragment": "Product content fragment"
      }
    ]
  },
  {
    "text": " for your needs.",
    "fragments": []
  }
]

POST /questionnaire/rag/query-fragments#

Zhrnutie: Vykonať dotaz v RAG Knowledge Base

Telo požiadavky:

{
  "project": "00000000-0000-0000-0000-000000000000",
  "exclude_documents": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "query": "What is this product?",
  "top_k": 5,
  "similarity_threshold": 0.5,
  "prepare_query": true
}

Odpoveď (200):

{
  "results": [
    {
      "document_id": "00000000-0000-0000-0000-000000000000",
      "document_code": "ART-001",
      "document_title": "Product Title",
      "revision": 3,
      "chunk_index": 0,
      "content": "Product content fragment",
      "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
    }
  ]
}

Súvisiace články#

na vrchol
Vybrať jazyk
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
한국어
日本語
中文
العربية
ქართული
עִברִית
हिंदी
فارسی