Procurize.AI REST API-referens#

Programatiskt åtkomst till din kunskapsbas – dokument, frågeformulär, RAG och rapporter – med din API‑token.

Gäller för: Procurize.AI API v1
Autentisering: API‑nyckel via X-API-Key‑header (se API‑token för tokenhantering)
Bas-URL: https://api.procurize.com

Översikt#

Procurize.AI REST API ger programmatisk åtkomst till viktiga plattformsfunktioner. Den gör det möjligt att integrera Procurize.AI med dina interna system, automatisera hantering av kunskapsbasen och bygga anpassade arbetsflöden.

Stödda moduler (token‑autentiserade):

Autentisering#

Alla autentiserade slutpunkter kräver en API‑token som skickas i begärans header.

HeaderVärde
X-API-Key<YOUR_API_TOKEN>

Exempel:

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

💡 Token är knutna till din organisation – du behöver inte ange ett organisations‑ID i begäran .

Bas-URL#

Alla REST API‑slutpunkter finns under:

https://api.procurize.com

Felhantering#

API:n använder standard‑HTTP‑statuskoder.

KodBetydelse
200 OKBegäran lyckades
201 CreatedResurs skapades framgångsrikt
204 No ContentBegäran lyckades, inget svarsinnehåll
400 Bad RequestOgiltiga parametrar eller felaktig begäran
401 UnauthorizedSaknad eller ogiltig API‑token
403 ForbiddenToken har inte behörighet för denna åtgärd
404 Not FoundResursen finns inte
500 Internal Server ErrorOväntat serverfel

Felformulär inkluderar en maskinläsbar felkod och ett mänskligt läsbart meddelande.

Modulreferens#

RagArticle#

GET /questionnaire/rag/articles/summary#

Sammanfattning: Sammanfattning för startsidan

Parametrar:

NamnITypObligatoriskBeskrivning
projquerystring (uuid)NoProjekt‑ID.

Svar (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

Sammanfattning: Antal artiklar

Parametrar:

NamnITypObligatoriskBeskrivning
qquerystringNoFiltrera på artikelnamn eller kod.
statequeryarrayNoFiltrera på tillstånd.
projectqueryarrayNoFiltrera på projekt.
typequeryarrayNoFiltrera på dokumenttyper.

Svar (200):

42

GET /questionnaire/rag/articles/list#

Sammanfattning: Hämta lista över artiklar

Parametrar:

NamnITypObligatoriskBeskrivning
qquerystringNoFiltrera på artikelnamn eller kod.
statequeryarrayNoFiltrera på tillstånd.
projectqueryarrayNoFiltrera på projekt.
typequeryarrayNoFiltrera på dokumenttyper.
squerystringNoSorteringsfält.
ascquerybooleanNoStigande sortering.
psqueryinteger (int32)NoSidstorlek.
pqueryinteger (int32)NoSidnummer (börjar på 1).

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

Sammanfattning: Returnerar Markdown‑innehåll från filen

Begäran (multipart/form-data):

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

Svar (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

Sammanfattning: Skapa en artikel

Begäran (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"
}

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

Sammanfattning: Kontrollera om artikel finns.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

Svar (200):

true

GET /questionnaire/rag/article-info#

Sammanfattning: Hämta artikelinformation via kod.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

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

Sammanfattning: Hämta artikelinnehåll via kod

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.
formatquerystringNoOm true, returnerar HTML‑innehåll i svarskroppen. Annars returneras artikelinnehållet i Markdown‑format.
splitquerybooleanNoOm true, returnerar innehållet separerat i RAG‑element.
cssquerybooleanNoOm true, returnerar HTML/PDF‑innehåll med CSS.

Svar (200):

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

POST /questionnaire/rag/article#

Sammanfattning: Uppdatera artikelmetadata

Begäran:

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

Svar (200):

{}

DELETE /questionnaire/rag/article#

Sammanfattning: Radera artikel

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

GET /questionnaire/rag/article/pdf#

Sammanfattning: Hämta artikel som PDF via kod

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

Svar (200):

(pdf binary)

GET /questionnaire/rag/article/content#

Sammanfattning: Hämta artikelinnehåll

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

Svar (200):

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

POST /questionnaire/rag/article/content#

Sammanfattning: Uppdatera artikelinnehåll

Begäran (multipart/form-data):

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

POST /questionnaire/rag/plural#

Sammanfattning: Hämta pluralformen av substantivet

Parametrar:

NamnITypObligatoriskBeskrivning
nounquerystringNoSubstantiv att pluralisera.

Svar (200):

{
  "plural": "Articles"
}

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

Sammanfattning: Analysera artikel med AI och returnera deras typer

Begäran (multipart/form-data):

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

Svar (200):

[
  {
    "plural": "Types"
  }
]

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

Sammanfattning: Formatera artikelinnehåll med AI

Begäran (multipart/form-data):

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

Svar (200):

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

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

Sammanfattning: Förbättra dokumentet baserat på förslag

Begäran (multipart/form-data):

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

Svar (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

Sammanfattning: Returnerar lista över artikeldelar

Parametrar:

NamnITypObligatoriskBeskrivning
idqueryarrayYesLista över artikeldelar.

Svar (200):

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

GET /questionnaire/rag/article/revisions#

Sammanfattning: Returnerar lista över artikelrevisioner

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

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

Sammanfattning: Hämta information om artikelrevision

Parametrar:

NamnITypObligatoriskBeskrivning
idpathstring (uuid)YesRevisions‑ID.

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

Sammanfattning: Hämta artikelrevisionsinnehåll

Parametrar:

NamnITypObligatoriskBeskrivning
idpathstring (uuid)YesRevisions‑ID.

Svar (200):

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

GET /questionnaire/rag/article/analyze#

Sammanfattning: Analysera artikelinnehåll med AI

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.
revqueryinteger (int32)NoRevisionsnummer.
forcequerybooleanNoTvinga skapande av ny analys och radera tidigare ofullständig analys om den finns.

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

Sammanfattning: Hämta analysresultat för artikel

Parametrar:

NamnITypObligatoriskBeskrivning
idpathstring (uuid)YesAnalys‑ID.

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

Sammanfattning: Lista alla meddelanden

Parametrar:

NamnITypObligatoriskBeskrivning
idquerystring (uuid)YesRAG‑samlingens ID.
itemquerystring (uuid)NoRAG‑objektets ID.
messagequerystring (uuid)NoMeddelande‑ID.
ascquerybooleanNoStigande sortering.
psqueryinteger (int32)NoSidstorlek.
pqueryinteger (int32)NoSidnummer (börjar på 1).

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

Sammanfattning: Lägg till nytt meddelande

Parametrar:

NamnITypObligatoriskBeskrivning
idquerystring (uuid)YesRAG‑samlingens ID.
itemquerystring (uuid)NoRAG‑objektets ID.
messagequerystring (uuid)NoMeddelande‑ID att svara på.

Begäran:

{
  "text": "New message content"
}

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

Sammanfattning: Uppdatera befintligt meddelande

Parametrar:

NamnITypObligatoriskBeskrivning
cquerystring (uuid)YesRAG‑samlingens ID.
idquerystring (uuid)YesMeddelande‑ID.

Begäran:

{
  "text": "Updated message content"
}

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

Sammanfattning: Radera befintligt meddelande

Parametrar:

NamnITypObligatoriskBeskrivning
idquerystring (uuid)YesMeddelande‑ID.

Svar (200):

{}

RagFaq#

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

Sammanfattning: Sammanfattning för startsidan

Parametrar:

NamnITypObligatoriskBeskrivning
projquerystring (uuid)NoProjekt‑ID.

Svar (200):

{
  "active": 3
}

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

Sammanfattning: Antal FAQ‑samlingar.

Parametrar:

NamnITypObligatoriskBeskrivning
qquerystringNoFiltrera på samlingsnamn eller kod.
statequeryarrayNoFiltrera på tillstånd.
projectqueryarrayNoFiltrera på projekt.

Svar (200):

3

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

Sammanfattning: Hämta lista över FAQ‑samlingar.

Parametrar:

NamnITypObligatoriskBeskrivning
qquerystringNoFiltrera på samlingsnamn eller kod.
statequeryarrayNoFiltrera på tillstånd.
projectqueryarrayNoFiltrera på projekt.
squerystringNoSorteringsfält.
ascquerybooleanNoStigande sortering.
psqueryinteger (int32)NoSidstorlek.
pqueryinteger (int32)NoSidnummer (börjar på 1).

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

Sammanfattning: Hitta FAQ‑poster.

**Parametrar::

NamnITypObligatoriskBeskrivning
qquerystringYesFiltrera på fråga.
projectquerystring (uuid)NoFiltrera på projekt.
psqueryinteger (int32)NoSidstorlek.
pqueryinteger (int32)NoSidnummer (börjar på 1).

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

Sammanfattning: Skapa ny FAQ‑samling.

Begäran (multipart/form-data):

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

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

Sammanfattning: Uppdatera metadata för FAQ‑samling.

Begäran:

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

DELETE /questionnaire/rag/faq-collection#

Sammanfattning: Radera FAQ‑samling.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för artikeln.

GET /questionnaire/rag/faq-collection#

Sammanfattning: Hämta FAQ‑samling.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för samlingen.

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

Sammanfattning: Kontrollera om FAQ‑samling finns.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för samlingen.

Svar (200):

true

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

Sammanfattning: Antal FAQ‑poster.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för samlingen.
qquerystringNoFiltrera på FAQ‑postens innehåll.

Begäran:

["Active", "Default"]

Svar (200):

5

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

Sammanfattning: Hämta lista över FAQ‑poster.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för samlingen.
qquerystringNoFiltrera på FAQ‑postens innehåll.
statequeryarrayNoFiltrera på tillstånd.
squerystringNoSorteringsfält.
ascquerybooleanNoStigande sortering.
psqueryinteger (int32)NoSidstorlek.
pqueryinteger (int32)NoSidnummer (börjar på 1).

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

Sammanfattning: Skapa ny FAQ‑post.

Begäran:

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

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

Sammanfattning: Hämta FAQ‑post.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för samlingen.
indexqueryinteger (int32)YesNollbaserat index för FAQ‑posten i samlingen.

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

Sammanfattning: Uppdatera FAQ‑post.

Begäran:

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

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

Sammanfattning: Radera FAQ‑post.

Parametrar:

NamnITypObligatoriskBeskrivning
codequerystringYesKod för samlingen.
indexqueryinteger (int32)YesNollbaserat index för FAQ‑posten i samlingen.

RagQuery#

POST /questionnaire/rag/query#

Sammanfattning: Gör en fråga i RAG‑kunskapsbasen

Begäran:

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

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

Sammanfattning: Gör en fråga i RAG‑kunskapsbasen (strömning)

Begäran:

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

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

Sammanfattning: Gör en fråga i RAG‑kunskapsbasen (fragment)

Begäran:

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

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

Relaterade artiklar#

till toppen
Välj språk
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
한국어
日本語
中文
العربية
ქართული
עִברִית
हिंदी
فارسی