Procurize.AI REST API viide#

Programmiliselt juurdepääs oma teadmistebaasile – dokumendid, küsimustikud, RAG ja aruanded – kasutades oma API‑tokenit.

Kehtib: Procurize.AI API v1
Autentimine: API‑võti X-API-Key päise kaudu (vt API tokenid tokenite haldamiseks)
Baas‑URL: https://api.procurize.com

Ülevaade#

Procurize.AI REST API pakub programmilist juurdepääsu platvormi põhifunktsioonidele. See võimaldab sul integreerida Procurize.AI oma sisemiste süsteemidega, automatiseerida teadmistebaasi haldamist ja luua kohandatud töövooge.

Toetatud moodulid (token‑autentitud):

Autentimine#

Kõik autentitud lõpp‑punktid nõuavad API‑tokenit, mis edastatakse päringu päises.

PäisVäärtus
X-API-Key<YOUR_API_TOKEN>

Näide:

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

💡 Tokenid on seotud sinu organisatsiooniga – sul ei ole vaja päringus organisatsiooni ID‑d määrata.

Baas‑URL#

Kõik REST API lõpp‑punktid asuvad:

https://api.procurize.com

Vea käsitlemine#

API kasutab standardseid HTTP‑staatuskoode.

KoodTähendus
200 OKPäring edukas
201 CreatedRessurss edukalt loodud
204 No ContentPäring edukas, vastuses puudub sisu
400 Bad RequestVigased parameetrid või valesti vormindatud päring
401 UnauthorizedPuuduv või kehtetu API‑token
403 ForbiddenTokenil puuduvad õigused selle toimingu jaoks
404 Not FoundRessurssi ei leitud
500 Internal Server ErrorOotamatu serveri viga

Vea vastused sisaldavad masinloetavat veakoodi ja inimloetavat sõnumit.

Mooduli viide#

RagArticle#

GET /questionnaire/rag/articles/summary#

Kokkuvõte: Kokkuvõte avalehele

Parameetrid:

NimiKusTüüpNõutavKirjeldus
projpäringstring (uuid)EiProjekti ID.

Vastus (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

Kokkuvõte: Artiklite arv

Parameetrid:

NimiKusTüüpNõutavKirjeldus
qpäringstringEiFiltreeri artikli nime või koodi järgi.
statepäringmassiivEiFiltreeri olekute järgi.
projectpäringmassiivEiFiltreeri projektide järgi.
typepäringmassiivEiFiltreeri dokumendi tüüpide järgi.

Vastus (200):

42

GET /questionnaire/rag/articles/list#

Kokkuvõte: Hangi artiklite loend

Parameetrid:

NimiKusTüüpNõutavKirjeldus
qpäringstringEiFiltreeri artikli nime või koodi järgi.
statepäringmassiivEiFiltreeri olekute järgi.
projectpäringmassiivEiFiltreeri projektide järgi.
typepäringmassiivEiFiltreeri dokumendi tüüpide järgi.
späringstringEiSorteerimisväli.
ascpäringboolEiKasvav sortimine.
pspäringtäisarv (int32)EiLehekülje suurus.
ppäringtäisarv (int32)Ei1‑põhine lehekülje number.

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

Kokkuvõte: Tagastab Markdown‑sisu failist

Päringu keha (multipart/form-data):

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

Vastus (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

Kokkuvõte: Loo artikkel

Päringu keha (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"
}

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

Kokkuvõte: Kontrolli artikli olemasolu.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.

Vastus (200):

true

GET /questionnaire/rag/article-info#

Kokkuvõte: Hangi artikli info koodi järgi.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.

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

Kokkuvõte: Hangi artikli sisu koodi järgi

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.
formatpäringstringEiKui true, tagastab HTML‑sisu vastuse kehas. Vastasel juhul tagastab artikli sisu Markdown‑vormingus.
splitpäringboolEiKui true, tagastab sisu eraldatud RAG‑elementide kaupa.
csspäringboolEiKui true, tagastab HTML/PDF‑sisu koos CSS‑iga.

Vastus (200):

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

POST /questionnaire/rag/article#

Kokkuvõte: Uuenda artikli metaandmeid

Päringu keha:

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

Vastus (200):

{}

DELETE /questionnaire/rag/article#

Kokkuvõte: Kustuta artikkel

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.

GET /questionnaire/rag/article/pdf#

Kokkuvõte: Hangi artikkel PDF‑ina koodi järgi

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.

Vastus (200):

(pdf binary)

GET /questionnaire/rag/article/content#

Kokkuvõte: Hangi artikli sisu

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.

Vastus (200):

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

POST /questionnaire/rag/article/content#

Kokkuvõte: Uuenda artikli sisu

Päringu keha (multipart/form-data):

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

POST /questionnaire/rag/plural#

Kokkuvõte: Hangi nimisõna mitmusvorm

Parameetrid:

NimiKusTüüpNõutavKirjeldus
nounpäringstringEiMitmuseks muudetav nimisõna.

Vastus (200):

{
  "plural": "Articles"
}

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

Kokkuvõte: Analüüsi artikkel AI‑ga ja tagasta selle tüübid

Päringu keha (multipart/form-data):

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

Vastus (200):

[
  {
    "plural": "Types"
  }
]

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

Kokkuvõte: Vorminda artikli sisu AI‑ga

Päringu keha (multipart/form-data):

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

Vastus (200):

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

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

Kokkuvõte: Paranda dokumenti ettepanekute põhjal

Päringu keha (multipart/form-data):

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

Vastus (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

Kokkuvõte: Tagastab artikli osade loendi

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idpäringmassiivJahArtikli osade loend.

Vastus (200):

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

GET /questionnaire/rag/article/revisions#

Kokkuvõte: Tagastab artikli versioonide loendi

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.

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

Kokkuvõte: Hangi artikli versiooni info

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idteestring (uuid)JahVersiooni ID.

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

Kokkuvõte: Hangi artikli versiooni sisu

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idteestring (uuid)JahVersiooni ID.

Vastus (200):

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

GET /questionnaire/rag/article/analyze#

Kokkuvõte: Analüüsi artikli sisu AI‑ga

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahArtikli kood.
revpäringinteger (int32)EiVersiooni number.
forcepäringboolEiSunni uue analüüsi loomist ja kustuta olemasolev poolikult lõpetatud analüüsitulemus, kui see eksisteerib.

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

Kokkuvõte: Hangi artikli analüüsi tulemus

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idteestring (uuid)JahAnalüüsi ID.

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

Kokkuvõte: Loetle kõik sõnumid

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idpäringstring (uuid)JahRAG kollektsiooni ID.
itempäringstring (uuid)EiRAG elemendi ID.
messagepäringstring (uuid)EiSõnumi ID.
ascpäringboolEiKasvav sortimine.
pspäringinteger (int32)EiLehekülje suurus.
ppäringinteger (int32)Ei1‑põhine lehekülje number.

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

Kokkuvõte: Lisa uus sõnum

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idpäringstring (uuid)JahRAG kollektsiooni ID.
itempäringstring (uuid)EiRAG elemendi ID.
messagepäringstring (uuid)EiSõnumi ID, millele vastata.

Päringu keha:

{
  "text": "New message content"
}

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

Kokkuvõte: Uuenda olemasolevat sõnumit

Parameetrid:

NimiKusTüüpNõutavKirjeldus
cpäringstring (uuid)JahRAG kollektsiooni ID.
idpäringstring (uuid)JahSõnumi ID.

Päringu keha:

{
  "text": "Updated message content"
}

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

Kokkuvõte: Kustuta olemasolev sõnum

Parameetrid:

NimiKusTüüpNõutavKirjeldus
idpäringstring (uuid)JahSõnumi ID.

Vastus (200):

{}

RagFaq#

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

Kokkuvõte: Kokkuvõte avalehele

Parameetrid:

NimiKusTüüpNõutavKirjeldus
projpäringstring (uuid)EiProjekti ID.

Vastus (200):

{
  "active": 3
}

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

Kokkuvõte: KKK kollektsioonide arv.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
qpäringstringEiFiltreeri kollektsiooni nime või koodi järgi.
statepäringmassiivEiFiltreeri olekute järgi.
projectpäringmassiivEiFiltreeri projektide järgi.

Vastus (200):

3

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

Kokkuvõte: Hangi KKK kollektsioonide loend.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
qpäringstringEiFiltreeri kollektsiooni nime või koodi järgi.
statepäringmassiivEiFiltreeri olekute järgi.
projectpäringmassiivEiFiltreeri projektide järgi.
späringstringEiSorteerimisväli.
ascpäringboolEiKasvav sortimine.
pspäringinteger (int32)EiLehekülje suurus.
ppäringinteger (int32)Ei1‑põhine lehekülje number.

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

Kokkuvõte: Leia KKK kirjeid.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
qpäringstringJahFiltreeri küsimuse järgi.
projectpäringstring (uuid)EiFiltreeri projekti järgi.
pspäringinteger (int32)EiLehekülje suurus.
ppäringinteger (int32)Ei1‑põhine lehekülje number.

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

Kokkuvõte: Loo uus KKK kollektsioon.

Päringu keha (multipart/form-data):

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

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

Kokkuvõte: Uuenda KKK kollektsiooni metaandmeid.

Päringu keha:

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

DELETE /questionnaire/rag/faq-collection#

Kokkuvõte: Kustuta KKK kollektsioon.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.

GET /questionnaire/rag/faq-collection#

Kokkuvõte: Hangi KKK kollektsioon.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.

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

Kokkuvõte: Kontrolli KKK kollektsiooni olemasolu.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.

Vastus (200):

true

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

Kokkuvõte: KKK kirjeid kokku.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.
qpäringstringEiFiltreeri KKK kirje sisu järgi.

Päringu keha:

["Active", "Default"]

Vastus (200):

5

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

Kokkuvõte: Hangi KKK kirjeid.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.
qpäringstringEiFiltreeri KKK kirje sisu järgi.
statepäringmassiivEiFiltreeri olekute järgi.
späringstringEiSorteerimisväli.
ascpäringboolEiKasvav sortimine.
pspäringinteger (int32)EiLehekülje suurus.
ppäringinteger (int32)Ei1‑põhine lehekülje number.

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

Kokkuvõte: Loo uus KKK kirje.

Päringu keha:

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

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

Kokkuvõte: Hangi KKK kirje.

Parameetrid:

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.
indexpäringinteger (int32)JahNull‑põhine indeks KKK kirje loendis.

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

Kokkuvõte: Uuenda KKK kirjet.

Päringu keha:

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

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

Kokkuvõte: Kustuta KKK kirje.

**Parameetrid::

NimiKusTüüpNõutavKirjeldus
codepäringstringJahKollektsiooni kood.
indexpäringinteger (int32)JahNull‑põhine indeks KKK kirje loendis.

RagQuery#

POST /questionnaire/rag/query#

Kokkuvõte: Tee päring RAG teadmistebaasis

Päringu keha:

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

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

Kokkuvõte: Tee päring RAG teadmistebaasis (voog)

Päringu keha: (sama nagu eelmine)

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

Kokkuvõte: Tee päring RAG teadmistebaasis (fragmentid)

Päringu keha:

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

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

Seotud artiklid#

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