מדריך API REST של Procurize.AI#

גש לתשתית הידע שלך בצורה תכנותית – מסמכים, שאלונים, RAG ודוחות – באמצעות אסימון ה-API שלך.

מתאים ל: Procurize.AI API v1
אימות: מפתח API דרך כותרת X-API-Key (ראו API Tokens לניהול אסימונים)
כתובת בסיסית: https://api.procurize.com

סקירה כללית#

ה-REST API של Procurize.AI מספק גישה תכנותית לתכונות מרכזיות של הפלטפורמה. הוא מאפשר לך לשלב את Procurize.AI עם המערכות הפנימיות שלך, לאוטומט ניהול תשתית הידע ולבנות זרימות עבודה מותאמות.

מודולים נתמכים (מאומתים באמצעות אסימון):

אימות#

כל נקודות הקצה המאומתות דורשות אסימון API המועבר בכותרת הבקשה.

כותרתערך
X-API-Key<YOUR_API_TOKEN>

דוגמה:

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

💡 אסימונים קשורים לארגון שלך – אין צורך לציין מזהה ארגון בבקשה .

כתובת בסיסית#

כל נקודות הקצה של ה-REST API נגישות תחת:

https://api.procurize.com

טיפול בשגיאות#

ה-API משתמש בקודי סטטוס HTTP סטנדרטיים.

קודמשמעות
200 OKבקשה הצליחה
201 Createdהמשאב נוצר בהצלחה
204 No Contentבקשה הצליחה, ללא גוף תגובה
400 Bad Requestפרמטרים לא תקינים או בקשה פגומה
401 Unauthorizedאסימון API חסר או לא תקין
403 Forbiddenהאסימון אינו בעל הרשאה לפעולה זו
404 Not Foundהמשאב אינו קיים
500 Internal Server Errorשגיאת שרת בלתי צפויה

תגובות השגיאה כוללות קוד שגיאה קריא למכונה והודעה קריאה לבן אדם.

הפניות למודולים#

RagArticle#

GET /questionnaire/rag/articles/summary#

סיכום: סיכום לדף הבית

פרמטרים:

שםבסוגנדרשתיאור
projquerystring (uuid)Noמזהה פרויקט.

תגובה (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

סיכום: מספר המאמרים

פרמטרים:

שםבסוגנדרשתיאור
qquerystringNoסינון לפי שם המאמר או קוד.
statequeryarrayNoסינון לפי מצבים.
projectqueryarrayNoסינון לפי פרויקטים.
typequeryarrayNoסינון לפי סוגי מסמכים.

תגובה (200):

42

GET /questionnaire/rag/articles/list#

סיכום: קבלת רשימת מאמרים

פרמטרים:

שםבסוגנדרשתיאור
qquerystringNoסינון לפי שם המאמר או קוד.
statequeryarrayNoסינון לפי מצבים.
projectqueryarrayNoסינון לפי פרויקטים.
typequeryarrayNoסינון לפי סוגי מסמכים.
squerystringNoשדה מיון.
ascquerybooleanNoמיון עולה.
psqueryinteger (int32)Noגודל דף.
pqueryinteger (int32)Noמספר דף (מתחיל ב-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#

סיכום: בדיקת קיום של מאמר.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.

תגובה (200):

true

GET /questionnaire/rag/article-info#

סיכום: קבלת מידע על מאמר לפי קוד.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.

תגובה (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#

סיכום: קבלת תוכן מאמר לפי קוד

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.
formatquerystringNoאם true, מחזיר תוכן HTML בגוף התגובה. אחרת מחזיר את תוכן המאמר בפורמט Markdown.
splitquerybooleanNoאם true, מחזיר את התוכן מופרד על ידי רכיבי RAG.
cssquerybooleanNoאם 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#

סיכום: מחיקת מאמר

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.

GET /questionnaire/rag/article/pdf#

סיכום: קבלת מאמר כ-PDF לפי קוד

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.

תגובה (200):

(pdf binary)

GET /questionnaire/rag/article/content#

סיכום: קבלת תוכן מאמר

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.

תגובה (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#

סיכום: קבלת צורת הרבים של שם עצם

פרמטרים:

שםבסוגנדרשתיאור
nounquerystringNoשם עצם לצורת רבים.

תגובה (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": "מבוא",
      "suggestion": "הוסף פרטים נוספים כאן."
    }
  ],
  "code": "ART-001",
  "content": "# Article Content"
}

תגובה (200):

{
  "improvedContent": "# Improved Content"
}

GET /questionnaire/rag/article/parts#

סיכום: מחזיר רשימת חלקי המאמר

פרמטרים:

שםבסוגנדרשתיאור
idqueryarrayYesרשימת חלקי המאמר.

תגובה (200):

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

GET /questionnaire/rag/article/revisions#

סיכום: מחזיר רשימת גרסאות המאמר

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.

תגובה (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)Yesמזהה גרסה.

תגובה (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)Yesמזהה גרסה.

תגובה (200):

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

GET /questionnaire/rag/article/analyze#

סיכום: ניתוח תוכן מאמר עם AI

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד המאמר.
revqueryinteger (int32)Noמספר גרסה.
forcequerybooleanNoהכרח יצירת ניתוח חדש ומחיקת תוצאה חלקית קודמת אם קיימת.

תגובה (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)Yesמזהה ניתוח.

תגובה (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)Yesמזהה אוסף RAG.
itemquerystring (uuid)Noמזהה פריט RAG.
messagequerystring (uuid)Noמזהה הודעה.
ascquerybooleanNoמיון עולה.
psqueryinteger (int32)Noגודל דף.
pqueryinteger (int32)Noמספר דף (מתחיל ב-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)Yesמזהה אוסף RAG.
itemquerystring (uuid)Noמזהה פריט RAG.
messagequerystring (uuid)Noמזהה הודעה לתשובה.

גוף הבקשה:

{
  "text": "תוכן הודעה חדשה"
}

תגובה (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": "תוכן הודעה חדשה",
  "created": "2025-01-15T10:30:00Z",
  "updated": "2025-01-15T10:30:00Z",
  "replies": 0
}

POST /questionnaire/rag/message#

סיכום: עדכון הודעה קיימת

פרמטרים:

שםבסוגנדרשתיאור
cquerystring (uuid)Yesמזהה אוסף RAG.
idquerystring (uuid)Yesמזהה הודעה.

גוף הבקשה:

{
  "text": "תוכן הודעה מעודכן"
}

תגובה (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": "תוכן הודעה מעודכן",
  "created": "2025-01-15T10:30:00Z",
  "updated": "2025-01-15T10:45:00Z",
  "replies": 0
}

DELETE /questionnaire/rag/message#

סיכום: מחיקת הודעה קיימת

פרמטרים:

שםבסוגנדרשתיאור
idquerystring (uuid)Yesמזהה הודעה.

תגובה (200):

{}

RagFaq#

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

סיכום: סיכום לדף הבית

פרמטרים:

שםבסוגנדרשתיאור
projquerystring (uuid)Noמזהה פרויקט.

תגובה (200):

{
  "active": 3
}

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

סיכום: מספר אוספי FAQ.

פרמטרים:

שםבסוגנדרשתיאור
qquerystringNoסינון לפי שם האוסף או קוד.
statequeryarrayNoסינון לפי מצבים.
projectqueryarrayNoסינון לפי פרויקטים.

תגובה (200):

3

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

סיכום: קבלת רשימת אוספי FAQ.

פרמטרים:

שםבסוגנדרשתיאור
qquerystringNoסינון לפי שם האוסף או קוד.
statequeryarrayNoסינון לפי מצבים.
projectqueryarrayNoסינון לפי פרויקטים.
squerystringNoשדה מיון.
ascquerybooleanNoמיון עולה.
psqueryinteger (int32)Noגודל דף.
pqueryinteger (int32)Noמספר דף (מתחיל ב-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.

פרמטרים:

שםבסוגנדרשתיאור
qquerystringYesסינון לפי שאלה.
projectquerystring (uuid)Noסינון לפי פרויקט.
psqueryinteger (int32)Noגודל דף.
pqueryinteger (int32)Noמספר דף (מתחיל ב-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.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.

GET /questionnaire/rag/faq-collection#

סיכום: קבלת אוסף FAQ.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.

תגובה (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.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.

תגובה (200):

true

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

סיכום: מספר פריטי FAQ.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.
qquerystringNoסינון לפי תוכן פריט FAQ.

גוף הבקשה:

["Active", "Default"]

תגובה (200):

5

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

סיכום: קבלת רשימת פריטי FAQ.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.
qquerystringNoסינון לפי תוכן פריט FAQ.
statequeryarrayNoסינון לפי מצבים.
squerystringNoשדה מיון.
ascquerybooleanNoמיון עולה.
psqueryinteger (int32)Noגודל דף.
pqueryinteger (int32)Noמספר דף (מתחיל ב-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.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.
indexqueryinteger (int32)Yesאינדקס מבוסס אפס של פריט 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.

פרמטרים:

שםבסוגנדרשתיאור
codequerystringYesקוד האוסף.
indexqueryinteger (int32)Yesאינדקס מבוסס אפס של פריט 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
한국어
日本語
中文
العربية
ქართული
עִברִית
हिंदी
فارسی