POST
/
api
/
knowledgebases
curl --request POST \
  --url https://app.pathors.com/api/knowledgebases \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "name": "<string>",
  "type": "<string>",
  "embeddingModelName": "<string>",
  "chunkSize": 123,
  "chunkOverlap": 123
}'

建立知識庫

為您的專案建立新的知識庫。目前每個專案僅限建立一個知識庫。

介面

POST /api/knowledgebases

請求頭

x-api-key
string
required

用於認證的專案 API 金鑰

請求體

name
string
required

知識庫名稱

type
string
required

知識庫類型。目前僅支援 “pgvector”

embeddingModelName
string
required

要使用的嵌入模型。可選值:

  • text-embedding-ada-002
  • text-embedding-3-small
  • text-embedding-3-large
chunkSize
number

文本分塊的最大大小(以字元為單位)。默認為 500

chunkOverlap
number

相鄰文本塊之間的重疊字元數。默認為 50

請求範例:

{
  "name": "我的知識庫",
  "type": "pgvector",
  "embeddingModelName": "text-embedding-3-small",
  "chunkSize": 500,
  "chunkOverlap": 50
}

回應

成功的請求將返回 201 狀態碼和一條成功訊息。

回應範例:

{
  "message": "Knowledgebase created successfully"
}

錯誤回應

狀態碼描述
400無效的請求體或驗證錯誤
401無效的 API 金鑰
500內部伺服器錯誤

使用說明

  • 每個專案只能建立一個知識庫
  • 建立後無法更改嵌入模型
  • 根據需求選擇嵌入模型:
    • text-embedding-ada-002:傳統模型,通用性好
    • text-embedding-3-small:更快速,更高效
    • text-embedding-3-large:性能最強,質量最佳

相關介面