---
sitemap:
  changefreq: yearly
  priority: 0.5
type: docs
group: Ինտեգրացիաներ
g_num: 6
o_num: 1
title: "REST API հղում – Procurize.AI ծրագրավորողի փաստաթղթեր"
description: "Ամբողջական REST API հղում Procurize.AI-ի համար։ Սովորեք, թե ինչպես ծրագրային կերպով հասնել փաստաթղթեր, հարցաթերթիկներ, RAG և հաշվետվություններ՝ օգտագործելով API token-ները։ Ներառված են նույնականացում, endpoint-ներ և օրինակներ։"
breadcrumb: REST API հղում
index_title: "REST API հղում"
brief: "Ամբողջական REST API հղում Procurize.AI-ի համար։ Ծրագիրային կերպով հասնել փաստաթղթեր, հարցաթերթիկներ, RAG, ֆայլեր և հաշվետվություններ՝ օգտագործելով ձեր API token-ը։ Ներառված են նույնականացում, բոլոր աջակցված մոդուլները և հարցման/պատասխանի օրինակները."
---
# Procurize.AI REST API հղում

**Ծրագիրային կերպով հասնել ձեր գիտելիքների բազային – փաստաթղթեր, հարցաթերթիկներ, RAG և հաշվետվություններ – օգտագործելով ձեր API token-ը:**

> **Կիրառելի է:** Procurize.AI API v1  
> **Նույնականացում:** API բանալի `X-API-Key` վերնագրով (տես [API Tokens](/api-tokens/) token-ների կառավարում)  
> **Բազային URL:** `https://api.procurize.com`

## Ընդհանուր ակնարկ

Procurize.AI REST API-ն ապահովում է ծրագրային հասանելիություն հարթակի հիմնական գործառույթներին։ Այն թույլ է տալիս ինտեգրել Procurize.AI-ը ձեր ներքին համակարգերի հետ, ավտոմատացնել գիտելիքների բազայի կառավարումը և կառուցել հատուկ աշխատանքային հոսքեր:

**Աջակցված մոդուլներ (token‑նույնականացված):**

- [**RagArticle**](#ragarticle) – կառավարել փաստաթղթեր
- [**RagFaq**](#ragfaq) – կառավարել FAQ գրառումներ
- [**RagQuery**](#ragquery) – կատարել RAG հարցումներ

## Նույնականացում

Բոլոր նույնականացված endpoint-ները պահանջում են API token՝ ուղարկված հարցման վերնագրում:

| Վերնագիր | Արժեք |
|----------|-------|
| `X-API-Key` | `<YOUR_API_TOKEN>` |

**Օրինակ:**
```bash
curl -X GET "https://api.procurize.com/v1/..." \
  -H "X-API-Key: your-api-token-here"

💡 Token-ները կապված են ձեր կազմակերպության հետ – պահանջված չէ organization ID-ը նշել հարցման մեջ։

Բազային URL#

Բոլոր REST API endpoint-ները մատչելի են հետևյալ հասցեով:

https://api.procurize.com

Սխալների կառավարում#

API-ն օգտագործում է ստանդարտ HTTP վիճակ կոդեր:

ԿոդՆշանակում
200 OKՀարցումը հաջողված է
201 CreatedՊարունակությունը հաջողությամբ ստեղծված է
204 No ContentՀարցումը հաջողված է, պատասխանային մարմին չկա
400 Bad RequestԱնվավեր պարամետրեր կամ սխալ ձևավորված հարցում
401 UnauthorizedԱնհասանելի կամ սխալ API token
403 ForbiddenToken-ը չունի թույլտվություն այս գործողության համար
404 Not FoundՊարունակությունը գոյություն չունի
500 Internal Server ErrorԱնսպասված սերվերի սխալ

Սխալի պատասխանները ներառում են մեքենայով ընթերցվող սխալի կոդ և մարդ-ընթերցվող հաղորդագրություն:

Մոդուլների հղում#

RagArticle#

GET /questionnaire/rag/articles/summary#

Ամփոփում: Գլխավոր էջի ամփոփում

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
projquerystring (uuid)ՈչՊրոյեկտի ID։

Պատասխան (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

Ամփոփում: Հոդվածների քանակը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
qquerystringՈչՖիլտրում հոդվածի անվան կամ կոդի վրա։
statequeryarrayՈչՖիլտրում վիճակների վրա։
projectqueryarrayՈչՖիլտրում պրոյեկտների վրա։
typequeryarrayՈչՖիլտրում փաստաթղթի տեսակների վրա։

Պատասխան (200):

42

GET /questionnaire/rag/articles/list#

Ամփոփում: Ստանալ հոդվածների ցանկը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
qquerystringՈչՖիլտրում հոդվածի անվան կամ կոդի վրա։
statequeryarrayՈչՖիլտրում վիճակների վրա։
projectqueryarrayՈչՖիլտրում պրոյեկտների վրա։
typequeryarrayՈչՖիլտրում փաստաթղթի տեսակների վրա։
squerystringՈչԴասավորության դաշտ։
ascquerybooleanՈչԲարձրացող դասավորում։
psqueryinteger (int32)ՈչԷջի չափը։
pqueryinteger (int32)Ոչ1‑ից սկսվող էջի համարը։

Պատասխան (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#

Ամփոփում: Վերադարձնում է Markdown բովանդակություն ֆայլից

Հարցման մարմին (multipart/form-data):

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

Պատասխան (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

Ամփոփում: Ստեղծել հոդված

Հարցման մարմին (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"
}

Պատասխան (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#

Ամփոփում: Ստուգել հոդվածի գոյությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։

Պատասխան (200):

true

GET /questionnaire/rag/article-info#

Ամփոփում: Ստանալ հոդվածի տեղեկությունները ըստ կոդի

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։

Պատասխան (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#

Ամփոփում: Ստանալ հոդվածի բովանդակությունը ըստ կոդի

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։
formatquerystringՈչԵթե true, վերադարձնում է HTML բովանդակություն պատասխանի մարմնում։ Հակառակ դեպքում վերադարձնում է հոդվածի բովանդակությունը Markdown ձևաչափում։
splitquerybooleanՈչԵթե true, վերադարձնում է բովանդակությունը RAG տարրերով բաժանված։
cssquerybooleanՈչԵթե true, վերադարձնում է HTML/PDF բովանդակություն CSS‑ով։

Պատասխան (200):

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

POST /questionnaire/rag/article#

Ամփոփում: Թարմացնել հոդվածի մետատվյալները

Հարցման մարմին:

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

Պատասխան (200):

{}

DELETE /questionnaire/rag/article#

Ամփոփում: Ջնջել հոդված

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։

GET /questionnaire/rag/article/pdf#

Ամփոփում: Ստանալ հոդվածը PDF ձևաչափում ըստ կոդի

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։

Պատասխան (200):

(pdf binary)

GET /questionnaire/rag/article/content#

Ամփոփում: Ստանալ հոդվածի բովանդակությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։

Պատասխան (200):

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

POST /questionnaire/rag/article/content#

Ամփոփում: Թարմացնել հոդվածի բովանդակությունը

Հարցման մարմին (multipart/form-data):

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

POST /questionnaire/rag/plural#

Ամփոփում: Ստանալ անվան բազմակրկնությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
nounquerystringՈչԲազմակրկնություն ստանալու համար անունը։

Պատասխան (200):

{
  "plural": "Articles"
}

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

Ամփոփում: Վերլուծել հոդվածը AI‑ով և վերադարձնել նրա տեսակները

Հարցման մարմին (multipart/form-data):

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

Պատասխան (200):

[
  {
    "plural": "Types"
  }
]

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

Ամփոփում: Ֆորմատավորել հոդվածի բովանդակությունը AI‑ով

Հարցման մարմին (multipart/form-data):

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

Պատասխան (200):

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

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

Ամփոփում: Բարելավել փաստաթուղթը առաջարկների հիման վրա

Հարցման մարմին (multipart/form-data):

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

Պատասխան (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

Ամփոփում: Վերադարձնում է հոդվածի մասերի ցանկը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idqueryarrayԱյոՀոդվածի մասերի ID-ները։

Պատասխան (200):

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

GET /questionnaire/rag/article/revisions#

Ամփոփում: Վերադարձնում է հոդվածի վերանայումների ցանկը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։

Պատասխան (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}#

Ամփոփում: Ստանալ հոդվածի վերանայման տեղեկատվությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idpathstring (uuid)ԱյոՎերանայման ID։

Պատասխան (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}#

Ամփոփում: Ստանալ հոդվածի վերանայման բովանդակությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idpathstring (uuid)ԱյոՎերանայման ID։

Պատասխան (200):

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

GET /questionnaire/rag/article/analyze#

Ամփոփում: Վերլուծել հոդվածի բովանդակությունը AI‑ով

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀոդվածի կոդը։
revqueryinteger (int32)ՈչՎերանայման համարը։
forcequerybooleanՈչԲուժել նոր վերլուծություն և ջնջել նախորդ անավարտ վերլուծության արդյունքը, եթե կա։

Պատասխան (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}#

Ամփոփում: Ստանալ հոդվածի վերլուծության արդյունքը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idpathstring (uuid)ԱյոՎերլուծության ID։

Պատասխան (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#

Ամփոփում: Ցուցակել բոլոր հաղորդագրությունները

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idquerystring (uuid)ԱյոRAG հավաքածուի ID։
itemquerystring (uuid)ՈչRAG տարրի ID։
messagequerystring (uuid)ՈչՀաղորդագրության ID։
ascquerybooleanՈչԲարձրացող դասավորում։
psqueryinteger (int32)ՈչԷջի չափը։
pqueryinteger (int32)Ոչ1‑ից սկսվող էջի համարը։

Պատասխան (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#

Ամփոփում: Ավելացնել նոր հաղորդագրություն

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idquerystring (uuid)ԱյոRAG հավաքածուի ID։
itemquerystring (uuid)ՈչRAG տարրի ID։
messagequerystring (uuid)ՈչՀաղորդագրության ID՝ պատասխանի համար։

Հարցման մարմին:

{
  "text": "New message content"
}

Պատասխան (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#

Ամփոփում: Թարմացնել գոյություն ունեցող հաղորդագրությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
cquerystring (uuid)ԱյոRAG հավաքածուի ID։
idquerystring (uuid)ԱյոՀաղորդագրության ID։

Հարցման մարմին:

{
  "text": "Updated message content"
}

Պատասխան (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#

Ամփոփում: Ջնջել գոյություն ունեցող հաղորդագրությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
idquerystring (uuid)ԱյոՀաղորդագրության ID։

Պատասխան (200):

{}

RagFaq#

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

Ամփոփում: Գլխավոր էջի ամփոփում

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
projquerystring (uuid)ՈչՊրոյեկտի ID։

Պատասխան (200):

{
  "active": 3
}

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

Ամփոփում: FAQ հավաքածուների քանակը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
qquerystringՈչՖիլտրում հավաքածուի անվան կամ կոդի վրա։
statequeryarrayՈչՖիլտրում վիճակների վրա։
projectqueryarrayՈչՖիլտրում պրոյեկտների վրա։

Պատասխան (200):

3

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

Ամփոփում: Ստանալ FAQ հավաքածուների ցանկը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
qquerystringՈչՖիլտրում հավաքածուի անվան կամ կոդի վրա։
statequeryarrayՈչՖիլտրում վիճակների վրա։
projectqueryarrayՈչՖիլտրում պրոյեկտների վրա։
squerystringՈչԴասավորության դաշտ։
ascquerybooleanՈչԲարձրացող դասավորում։
psqueryinteger (int32)ՈչԷջի չափը։
pqueryinteger (int32)Ոչ1‑ից սկսվող էջի համարը։

Պատասխան (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#

Ամփոփում: Գտնել FAQ տարրերը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
qquerystringԱյոՖիլտրում հարցման վրա։
projectquerystring (uuid)ՈչՖիլտրում պրոյեկտի վրա։
psqueryinteger (int32)ՈչԷջի չափը։
pqueryinteger (int32)Ոչ1‑ից սկսվող էջի համարը։

Պատասխան (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#

Ամփոփում: Ստեղծել նոր FAQ հավաքածու

Հարցման մարմին (multipart/form-data):

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

Պատասխան (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#

Ամփոփում: Թարմացնել FAQ հավաքածուի մետատվյալները

Հարցման մարմին:

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

DELETE /questionnaire/rag/faq-collection#

Ամփոփում: Ջնջել FAQ հավաքածուն

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։

GET /questionnaire/rag/faq-collection#

Ամփոփում: Ստանալ FAQ հավաքածուն

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։

Պատասխան (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#

Ամփոփում: Ստուգել FAQ հավաքածուի գոյությունը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։

Պատասխան (200):

true

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

Ամփոփում: FAQ տարրերի քանակը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։
qquerystringՈչՖիլտրում FAQ տարրերի բովանդակության վրա։

Հարցման մարմին:

["Active", "Default"]

Պատասխան (200):

5

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

Ամփոփում: Ստանալ FAQ տարրերի ցանկը

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։
qquerystringՈչՖիլտրում FAQ տարրերի բովանդակության վրա։
statequeryarrayՈչՖիլտրում վիճակների վրա։
squerystringՈչԴասավորության դաշտ։
ascquerybooleanՈչԲարձրացող դասավորում։
psqueryinteger (int32)ՈչԷջի չափը։
pqueryinteger (int32)Ոչ1‑ից սկսվող էջի համարը։

Պատասխան (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#

Ամփոփում: Ստեղծել նոր FAQ տարր

Հարցման մարմին:

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

Պատասխան (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#

Ամփոփում: Ստանալ FAQ տարր

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։
indexqueryinteger (int32)ԱյոFAQ տարրի զրո-բազված ինդեքսը հավաքածուում։

Պատասխան (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#

Ամփոփում: Թարմացնել FAQ տարր

Հարցման մարմին:

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

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

Ամփոփում: Ջնջել FAQ տարր

Պարամետրեր:

ԱնունՏեղումՏիպՊարտադիրՆկարագրություն
codequerystringԱյոՀավաքածուի կոդը։
indexqueryinteger (int32)ԱյոFAQ տարրի զրո-բազված ինդեքսը հավաքածուում։

RagQuery#

POST /questionnaire/rag/query#

Ամփոփում: Կատարել հարցում RAG գիտելիքների բազայում

Հարցման մարմին:

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

Պատասխան (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#

Ամփոփում: Կատարել հարցում RAG գիտելիքների բազայում (հոսք)

Հարցման մարմին:

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

Պատասխան (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#

Ամփոփում: Կատարել հարցում RAG գիտելիքների բազայում (բաժիններ)

Հարցման մարմին:

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

Պատասխան (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
    }
  ]
}

Կապված հոդվածներ#

վերև
Ընտրել լեզուն
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
한국어
日本語
中文
العربية
ქართული
עִברִית
हिंदी
فارسی