Procurize.AI REST API referenca#

Programatski pristupite svojoj bazi znanja – dokumentima, upitnicima, RAG-u i izvješćima – koristeći vaš API token.

Primjenjuje se na: Procurize.AI API v1
Autentifikacija: API ključ putem zaglavlja X-API-Key (pogledajte API tokeni za upravljanje tokenima)
Osnovni URL: https://api.procurize.com

Pregled#

Procurize.AI REST API omogućuje programatski pristup ključnim značajkama platforme. Omogućuje integraciju Procurize.AI s vašim internim sustavima, automatizaciju upravljanja bazom znanja i izgradnju prilagođenih radnih tokova.

Podržani moduli (autentifikacija tokenom):

Autentifikacija#

Svi autentificirani krajnji‑točke zahtijevaju API token proslijeđen u zaglavlju zahtjeva.

ZaglavljeVrijednost
X-API-Key<YOUR_API_TOKEN>

Primjer:

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

💡 Tokeni su vezani uz vašu organizaciju – ne morate navoditi ID organizacije u zahtjevu.

Osnovni URL#

Sve REST API krajnje točke nalaze se pod:

https://api.procurize.com

Obrada grešaka#

API koristi standardne HTTP kodove statusa.

KodZnačenje
200 OKZahtjev uspješan
201 CreatedResurs je uspješno kreiran
204 No ContentZahtjev uspješan, nema tijela odgovora
400 Bad RequestNeispravni parametri ili loše oblikovan zahtjev
401 UnauthorizedNedostaje ili je neispravan API token
403 ForbiddenToken nema dozvolu za ovu radnju
404 Not FoundResurs ne postoji
500 Internal Server ErrorNeočekivana greška na poslužitelju

Odgovori na greške uključuju strojno čitljiv kod greške i ljudski čitljivu poruku.

Referenca modula#

RagArticle#

GET /questionnaire/rag/articles/summary#

Sažetak: Sažetak za početnu stranicu

Parametri:

NazivUTipObaveznoOpis
projquerystring (uuid)NeID projekta.

Odgovor (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

Sažetak: Broj članaka

Parametri:

NazivUTipObaveznoOpis
qquerystringNeFiltriraj po nazivu ili kodu članka.
statequeryarrayNeFiltriraj po statusima.
projectqueryarrayNeFiltriraj po projektima.
typequeryarrayNeFiltriraj po vrstama dokumenata.

Odgovor (200):

42

GET /questionnaire/rag/articles/list#

Sažetak: Dohvati popis članaka

Parametri:

NazivUTipObaveznoOpis
qquerystringNeFiltriraj po nazivu ili kodu članka.
statequeryarrayNeFiltriraj po statusima.
projectqueryarrayNeFiltriraj po projektima.
typequeryarrayNeFiltriraj po vrstama dokumenata.
squerystringNePolje za sortiranje.
ascquerybooleanNeUzlazno sortiranje.
psqueryinteger (int32)NeVeličina stranice.
pqueryinteger (int32)NeBroj stranice (počevši od 1).

Odgovor (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#

Sažetak: Vraća Markdown sadržaj iz datoteke

Tijelo zahtjeva (multipart/form-data):

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

Odgovor (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

Sažetak: Kreiraj članak

Tijelo zahtjeva (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"
}

Odgovor (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#

Sažetak: Provjeri postojanje članka.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.

Odgovor (200):

true

GET /questionnaire/rag/article-info#

Sažetak: Dohvati informacije o članku po kodu.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.

Odgovor (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#

Sažetak: Dohvati sadržaj članka po kodu

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.
formatquerystringNeAko je true, vraća HTML sadržaj u tijelu odgovora. Inače vraća sadržaj članka u Markdown formatu.
splitquerybooleanNeAko je true, vraća sadržaj podijeljen po RAG elementima.
cssquerybooleanNeAko je true, vraća HTML/PDF sadržaj s CSS‑om.

Odgovor (200):

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

POST /questionnaire/rag/article#

Sažetak: Ažuriraj metapodatke članka

Tijelo zahtjeva:

{
  "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"
}

Odgovor (200):

{}

DELETE /questionnaire/rag/article#

Sažetak: Izbriši članak

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.

GET /questionnaire/rag/article/pdf#

Sažetak: Dohvati članak kao PDF po kodu

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.

Odgovor (200):

(pdf binary)

GET /questionnaire/rag/article/content#

Sažetak: Dohvati sadržaj članka

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.

Odgovor (200):

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

POST /questionnaire/rag/article/content#

Sažetak: Ažuriraj sadržaj članka

Tijelo zahtjeva (multipart/form-data):

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

POST /questionnaire/rag/plural#

Sažetak: Dohvati množinski oblik imenice

Parametri:

NazivUTipObaveznoOpis
nounquerystringNeImenica koju treba množiti.

Odgovor (200):

{
  "plural": "Articles"
}

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

Sažetak: Analiziraj članak pomoću AI i vrati njihove tipove

Tijelo zahtjeva (multipart/form-data):

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

Odgovor (200):

[
  {
    "plural": "Types"
  }
]

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

Sažetak: Formatiraj sadržaj članka pomoću AI

Tijelo zahtjeva (multipart/form-data):

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

Odgovor (200):

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

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

Sažetak: Poboljšaj dokument na temelju prijedloga

Tijelo zahtjeva (multipart/form-data):

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

Odgovor (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

Sažetak: Vraća popis dijelova članka

Parametri:

NazivUTipObaveznoOpis
idqueryarrayDaPopis dijelova članka.

Odgovor (200):

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

GET /questionnaire/rag/article/revisions#

Sažetak: Vraća popis revizija članka

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.

Odgovor (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}#

Sažetak: Dohvati informacije o reviziji članka

Parametri:

NazivUTipObaveznoOpis
idpathstring (uuid)DaID revizije.

Odgovor (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}#

Sažetak: Dohvati sadržaj revizije članka

Parametri:

NazivUTipObaveznoOpis
idpathstring (uuid)DaID revizije.

Odgovor (200):

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

GET /questionnaire/rag/article/analyze#

Sažetak: Analiziraj sadržaj članka pomoću AI

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod članka.
revqueryinteger (int32)NeBroj revizije.
forcequerybooleanNePrisilno kreiraj novu analizu i izbriši prethodni nepotpun rezultat ako postoji.

Odgovor (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}#

Sažetak: Dohvati rezultat analize članka

Parametri:

NazivUTipObaveznoOpis
idpathstring (uuid)DaID analize.

Odgovor (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#

Sažetak: Popis svih poruka

Parametri:

NazivUTipObaveznoOpis
idquerystring (uuid)DaID RAG kolekcije.
itemquerystring (uuid)NeID RAG stavke.
messagequerystring (uuid)NeID poruke.
ascquerybooleanNeUzlazno sortiranje.
psqueryinteger (int32)NeVeličina stranice.
pqueryinteger (int32)NeBroj stranice (počevši od 1).

Odgovor (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#

Sažetak: Dodaj novu poruku

Parametri:

NazivUTipObaveznoOpis
idquerystring (uuid)DaID RAG kolekcije.
itemquerystring (uuid)NeID RAG stavke.
messagequerystring (uuid)NeID poruke na koju se odgovara.

Tijelo zahtjeva:

{
  "text": "New message content"
}

Odgovor (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#

Sažetak: Ažuriraj postojeću poruku

Parametri:

NazivUTipObaveznoOpis
cquerystring (uuid)DaID RAG kolekcije.
idquerystring (uuid)DaID poruke.

Tijelo zahtjeva:

{
  "text": "Updated message content"
}

Odgovor (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#

Sažetak: Izbriši postojeću poruku

Parametri:

NazivUTipObaveznoOpis
idquerystring (uuid)DaID poruke.

Odgovor (200):

{}

RagFaq#

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

Sažetak: Sažetak za početnu stranicu

Parametri:

NazivUTipObaveznoOpis
projquerystring (uuid)NeID projekta.

Odgovor (200):

{
  "active": 3
}

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

Sažetak: Broj FAQ kolekcija.

Parametri:

NazivUTipObaveznoOpis
qquerystringNeFiltriraj po nazivu ili kodu kolekcije.
statequeryarrayNeFiltriraj po statusima.
projectqueryarrayNeFiltriraj po projektima.

Odgovor (200):

3

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

Sažetak: Dohvati popis FAQ kolekcija.

Parametri:

NazivUTipObaveznoOpis
qquerystringNeFiltriraj po nazivu ili kodu kolekcije.
statequeryarrayNeFiltriraj po statusima.
projectqueryarrayNeFiltriraj po projektima.
squerystringNePolje za sortiranje.
ascquerybooleanNeUzlazno sortiranje.
psqueryinteger (int32)NeVeličina stranice.
pqueryinteger (int32)NeBroj stranice (počevši od 1).

Odgovor (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#

Sažetak: Pronađi FAQ stavke.

Parametri:

NazivUTipObaveznoOpis
qquerystringDaFiltriraj po pitanju.
projectquerystring (uuid)NeFiltriraj po projektu.
psqueryinteger (int32)NeVeličina stranice.
pqueryinteger (int32)NeBroj stranice (počevši od 1).

Odgovor (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#

Sažetak: Kreiraj novu FAQ kolekciju.

Tijelo zahtjeva (multipart/form-data):

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

Odgovor (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#

Sažetak: Ažuriraj metapodatke FAQ kolekcije.

Tijelo zahtjeva:

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

DELETE /questionnaire/rag/faq-collection#

Sažetak: Izbriši FAQ kolekciju.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.

GET /questionnaire/rag/faq-collection#

Sažetak: Dohvati FAQ kolekciju.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.

Odgovor (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#

Sažetak: Provjeri postojanje FAQ kolekcije.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.

Odgovor (200):

true

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

Sažetak: Broj FAQ stavki.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.
qquerystringNeFiltriraj po sadržaju FAQ stavke.

Tijelo zahtjeva:

["Active", "Default"]

Odgovor (200):

5

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

Sažetak: Dohvati popis FAQ stavki.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.
qquerystringNeFiltriraj po sadržaju FAQ stavke.
statequeryarrayNeFiltriraj po statusima.
squerystringNePolje za sortiranje.
ascquerybooleanNeUzlazno sortiranje.
psqueryinteger (int32)NeVeličina stranice.
pqueryinteger (int32)NeBroj stranice (počevši od 1).

Odgovor (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#

Sažetak: Kreiraj novu FAQ stavku.

Tijelo zahtjeva:

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

Odgovor (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#

Sažetak: Dohvati FAQ stavku.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.
indexqueryinteger (int32)DaNula‑bazirani indeks stavke u kolekciji.

Odgovor (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#

Sažetak: Ažuriraj FAQ stavku.

Tijelo zahtjeva:

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

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

Sažetak: Izbriši FAQ stavku.

Parametri:

NazivUTipObaveznoOpis
codequerystringDaKod kolekcije.
indexqueryinteger (int32)DaNula‑bazirani indeks stavke u kolekciji.

RagQuery#

POST /questionnaire/rag/query#

Sažetak: Izvrši upit u RAG bazi znanja

Tijelo zahtjeva:

{
  "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
}

Odgovor (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#

Sažetak: Izvrši upit u RAG bazi znanja (stream)

Tijelo zahtjeva:

{
  "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
}

Odgovor (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#

Sažetak: Izvrši upit u RAG bazi znanja (fragmenti)

Tijelo zahtjeva:

{
  "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
}

Odgovor (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
    }
  ]
}

Povezani članci#

na vrh
Odaberite jezik