อ้างอิง REST API ของ Procurize.AI#

เข้าถึงฐานความรู้ของคุณโดยอัตโนมัติ – เอกสาร, แบบสอบถาม, RAG, และรายงาน – ด้วยโทเค็น API ของคุณ

ใช้กับ: Procurize.AI API เวอร์ชัน 1
การรับรองความถูกต้อง: คีย์ API ผ่านหัวข้อ X-API-Key (ดู โทเค็น API สำหรับการจัดการโทเค็น)
URL พื้นฐาน: https://api.procurize.com

ภาพรวม#

REST API ของ Procurize.AI ให้การเข้าถึงแบบโปรแกรมต่อคุณลักษณะสำคัญของแพลตฟอร์ม ช่วยให้คุณสามารถบูรณาการ Procurize.AI กับระบบภายในของคุณ, ทำงานอัตโนมัติการจัดการฐานความรู้, และสร้างเวิร์กโฟลว์ที่กำหนดเองได้

โมดูลที่รองรับ (ต้องใช้โทเค็น):

RagArticle – จัดการเอกสาร
RagFaq – จัดการรายการ FAQ
RagQuery – ทำการค้นหา RAG

การรับรองความถูกต้อง#

ทุกจุดเชื่อมต่อที่ต้องการการรับรองความถูกต้องต้องส่งโทเค็น API ผ่านหัวข้อของคำขอ

หัวข้อ	ค่า
`X-API-Key`	`<YOUR_API_TOKEN>`

ตัวอย่าง:

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

💡 โทเค็นผูกกับองค์กรของคุณ – คุณไม่จำเป็นต้องระบุรหัสองค์กรในคำขอ

URL พื้นฐาน#

จุดเชื่อมต่อ 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#

สรุป: สรุปสำหรับหน้าแรก

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
proj	query	string (uuid)	ไม่	รหัสโครงการ

การตอบสนอง (200):

{
  "active": 5
}

GET /questionnaire/rag/articles/total#

สรุป: จำนวนบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
q	query	string	ไม่	กรองตามชื่อหรือรหัสบทความ
state	query	array	ไม่	กรองตามสถานะ
project	query	array	ไม่	กรองตามโครงการ
type	query	array	ไม่	กรองตามประเภทเอกสาร

การตอบสนอง (200):

GET /questionnaire/rag/articles/list#

สรุป: ดึงรายการบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
q	query	string	ไม่	กรองตามชื่อหรือรหัสบทความ
state	query	array	ไม่	กรองตามสถานะ
project	query	array	ไม่	กรองตามโครงการ
type	query	array	ไม่	กรองตามประเภทเอกสาร
s	query	string	ไม่	ฟิลด์เรียงลำดับ
asc	query	boolean	ไม่	เรียงลำดับจากน้อยไปมาก
ps	query	integer (int32)	ไม่	ขนาดหน้า
p	query	integer (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 จากไฟล์

เนื้อหา Request (multipart/form-data):

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

การตอบสนอง (200):

"Markdown content from file"

POST /questionnaire/rag/article/create#

สรุป: สร้างบทความ

เนื้อหา Request (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#

สรุป: ตรวจสอบการมีอยู่ของบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ

การตอบสนอง (200):

true

GET /questionnaire/rag/article-info#

สรุป: ดึงข้อมูลบทความตามรหัส

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ

การตอบสนอง (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#

สรุป: ดึงเนื้อหาบทความตามรหัส

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ
format	query	string	ไม่	หากเป็น true จะส่งคืนเนื้อหา HTML; มิฉะนั้นส่งคืน Markdown
split	query	boolean	ไม่	หากเป็น true จะส่งคืนเนื้อหาที่แยกตามองค์ประกอบ RAG
css	query	boolean	ไม่	หากเป็น true จะส่งคืนเนื้อหา HTML/PDF พร้อม CSS

การตอบสนอง (200):

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

POST /questionnaire/rag/article#

สรุป: ปรับปรุงเมตาดาต้าบทความ

เนื้อหา Request:

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

สรุป: ลบบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ

GET /questionnaire/rag/article/pdf#

สรุป: ดึงบทความเป็น PDF ตามรหัส

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ

การตอบสนอง (200):

(pdf binary)

GET /questionnaire/rag/article/content#

สรุป: ดึงเนื้อหาบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ

การตอบสนอง (200):

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

POST /questionnaire/rag/article/content#

สรุป: ปรับปรุงเนื้อหาบทความ

เนื้อหา Request (multipart/form-data):

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

POST /questionnaire/rag/plural#

สรุป: ดึงรูปพหูพจน์ของคำนาม

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
noun	query	string	ไม่	คำนามที่ต้องการทำพหูพจน์

การตอบสนอง (200):

{
  "plural": "Articles"
}

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

สรุป: วิเคราะห์บทความด้วย AI และคืนประเภทของมัน

เนื้อหา Request (multipart/form-data):

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

การตอบสนอง (200):

[
  {
    "plural": "Types"
  }
]

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

สรุป: จัดรูปแบบเนื้อหาบทความด้วย AI

เนื้อหา Request (multipart/form-data):

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

การตอบสนอง (200):

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

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

สรุป: ปรับปรุงเอกสารตามข้อเสนอแนะ

เนื้อหา Request (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#

สรุป: คืนรายการส่วนของบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	query	array	ใช่	รายการส่วนของบทความ

การตอบสนอง (200):

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

GET /questionnaire/rag/article/revisions#

สรุป: คืนรายการรุ่นของบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ

การตอบสนอง (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}#

สรุป: ดึงข้อมูลรุ่นของบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	path	string (uuid)	ใช่	รหัสรุ่น

การตอบสนอง (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}#

สรุป: ดึงเนื้อหารุ่นของบทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	path	string (uuid)	ใช่	รหัสรุ่น

การตอบสนอง (200):

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

GET /questionnaire/rag/article/analyze#

สรุป: วิเคราะห์เนื้อหาบทความด้วย AI

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของบทความ
rev	query	integer (int32)	ไม่	หมายเลขรุ่น
force	query	boolean	ไม่	บังคับสร้างการวิเคราะห์ใหม่และลบผลการวิเคราะห์ที่ยังไม่สมบูรณ์ถ้ามี

การตอบสนอง (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}#

สรุป: ดึงผลการวิเคราะห์บทความ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	path	string (uuid)	ใช่	รหัสการวิเคราะห์

การตอบสนอง (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#

สรุป: รายการข้อความทั้งหมด

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	query	string (uuid)	ใช่	รหัสคอลเลกชัน RAG
item	query	string (uuid)	ไม่	รหัสรายการ RAG
message	query	string (uuid)	ไม่	รหัสข้อความ
asc	query	boolean	ไม่	เรียงจากน้อยไปมาก
ps	query	integer (int32)	ไม่	ขนาดหน้า
p	query	integer (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#

สรุป: เพิ่มข้อความใหม่

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	query	string (uuid)	ใช่	รหัสคอลเลกชัน RAG
item	query	string (uuid)	ไม่	รหัสรายการ RAG
message	query	string (uuid)	ไม่	รหัสข้อความที่ต้องการตอบกลับ

เนื้อหา Request:

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

สรุป: ปรับปรุงข้อความที่มีอยู่

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
c	query	string (uuid)	ใช่	รหัสคอลเลกชัน RAG
id	query	string (uuid)	ใช่	รหัสข้อความ

เนื้อหา Request:

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

สรุป: ลบข้อความที่มีอยู่

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
id	query	string (uuid)	ใช่	รหัสข้อความ

การตอบสนอง (200):

{}

RagFaq#

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

สรุป: สรุปสำหรับหน้าแรก

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
proj	query	string (uuid)	ไม่	รหัสโครงการ

การตอบสนอง (200):

{
  "active": 3
}

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

สรุป: จำนวนคอลเลกชัน FAQ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
q	query	string	ไม่	กรองตามชื่อหรือรหัสคอลเลกชัน
state	query	array	ไม่	กรองตามสถานะ
project	query	array	ไม่	กรองตามโครงการ

การตอบสนอง (200):

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

สรุป: ดึงรายการคอลเลกชัน FAQ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
q	query	string	ไม่	กรองตามชื่อหรือรหัสคอลเลกชัน
state	query	array	ไม่	กรองตามสถานะ
project	query	array	ไม่	กรองตามโครงการ
s	query	string	ไม่	ฟิลด์เรียงลำดับ
asc	query	boolean	ไม่	เรียงจากน้อยไปมาก
ps	query	integer (int32)	ไม่	ขนาดหน้า
p	query	integer (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

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
q	query	string	ใช่	กรองตามคำถาม
project	query	string (uuid)	ไม่	กรองตามโครงการ
ps	query	integer (int32)	ไม่	ขนาดหน้า
p	query	integer (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 ใหม่

เนื้อหา Request (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

เนื้อหา Request:

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

DELETE /questionnaire/rag/faq-collection#

สรุป: ลบคอลเลกชัน FAQ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน

GET /questionnaire/rag/faq-collection#

สรุป: ดึงคอลเลกชัน FAQ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน

การตอบสนอง (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

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน

การตอบสนอง (200):

true

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

สรุป: จำนวนรายการ FAQ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน
q	query	string	ไม่	กรองตามเนื้อหารายการ FAQ

เนื้อหา Request:

["Active", "Default"]

การตอบสนอง (200):

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

สรุป: ดึงรายการ FAQ

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน
q	query	string	ไม่	กรองตามเนื้อหารายการ FAQ
state	query	array	ไม่	กรองตามสถานะ
s	query	string	ไม่	ฟิลด์เรียงลำดับ
asc	query	boolean	ไม่	เรียงจากน้อยไปมาก
ps	query	integer (int32)	ไม่	ขนาดหน้า
p	query	integer (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 ใหม่

เนื้อหา Request:

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

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน
index	query	integer (int32)	ใช่	ดัชนีเริ่มจาก 0 ของรายการในคอลเลกชัน

การตอบสนอง (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

เนื้อหา Request:

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

พารามิเตอร์:

ชื่อ	อยู่ใน	ชนิด	จำเป็น	คำอธิบาย
code	query	string	ใช่	รหัสของคอลเลกชัน
index	query	integer (int32)	ใช่	ดัชนีเริ่มจาก 0 ของรายการในคอลเลกชัน

RagQuery#

POST /questionnaire/rag/query#

สรุป: ทำการค้นหาในฐานความรู้ RAG

เนื้อหา Request:

{
  "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 (แบบสตรีม)

เนื้อหา Request:

{
  "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 (ดึงส่วนข้อมูล)

เนื้อหา Request:

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

อ้างอิง REST API ของ Procurize.AI#

ภาพรวม#

การรับรองความถูกต้อง#

URL พื้นฐาน#

การจัดการข้อผิดพลาด#

การอ้างอิงโมดูล#

RagArticle#

GET /questionnaire/rag/articles/summary#

GET /questionnaire/rag/articles/total#

GET /questionnaire/rag/articles/list#

POST /questionnaire/rag/file-to-md#

POST /questionnaire/rag/article/create#

GET /questionnaire/rag/article/check#

GET /questionnaire/rag/article-info#

GET /questionnaire/rag/article#

POST /questionnaire/rag/article#

DELETE /questionnaire/rag/article#

GET /questionnaire/rag/article/pdf#

GET /questionnaire/rag/article/content#

POST /questionnaire/rag/article/content#

POST /questionnaire/rag/plural#

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

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

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

GET /questionnaire/rag/article/parts#

GET /questionnaire/rag/article/revisions#

GET /questionnaire/rag/article/revisions/info/{id}#

GET /questionnaire/rag/article/revisions/{id}#

GET /questionnaire/rag/article/analyze#

GET /questionnaire/rag/article/analyze/{id}#

GET /questionnaire/rag/messages/list#

POST /questionnaire/rag/messages/add#

POST /questionnaire/rag/message#

DELETE /questionnaire/rag/message#

RagFaq#

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

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

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

GET /questionnaire/rag/faq-collections/find-items#

POST /questionnaire/rag/faq-collection/create#

POST /questionnaire/rag/faq-collection#

DELETE /questionnaire/rag/faq-collection#

GET /questionnaire/rag/faq-collection#

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

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

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

POST /questionnaire/rag/faq-collection/item/create#

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

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

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

RagQuery#

POST /questionnaire/rag/query#

POST /questionnaire/rag/query-stream#

POST /questionnaire/rag/query-fragments#

บทความที่เกี่ยวข้อง#