跳轉到主要內容
GET
https://app.pathors.com
/
knowledgebases
/
{knowledgebaseId}
/
query
查詢文本片段
curl --request GET \
  --url https://app.pathors.com/knowledgebases/{knowledgebaseId}/query \
  --header 'x-api-key: <x-api-key>'
{
  "id": "<string>",
  "content": "<string>",
  "contentLength": 123,
  "isEnabled": true
}
基於語義搜尋查詢從指定知識庫中獲取相關的文本片段。

​
基礎 URL

https://api.pathors.com

​
介面

GET /knowledgebases/{knowledgebaseId}/query

​
路徑參數

​
knowledgebaseId
string
必填
要查詢的知識庫的唯一標識符

​
請求頭

​
x-api-key
string
必填
用於認證的專案 API 金鑰

​
查詢參數

​
q
string
必填
用於匹配知識庫內容的搜尋查詢
​
topK
number
返回結果的最大數量。默認為 5
​
scoreThreshold
number
返回結果的最低相關性分數閾值。默認為 0.3
請求範例： 
curl -X GET "https://api.pathors.com/knowledgebases/kb_abc123/query?q=搜尋關鍵詞&topK=5&scoreThreshold=0.3" \
  --header "x-api-key: <your-api-key>"

​
回應

返回與查詢匹配的文本片段陣列，按相關性排序。
​
id
string
文本片段的唯一標識符
​
content
string
文本片段的內容
​
contentLength
number
文本片段的內容長度
​
isEnabled
boolean
文本片段是否啟用搜尋
回應範例： 
[
  {
    "id": "chunk_abc123",
    "content": "產品功能包括即時分析...",
    "contentLength": 82,
    "isEnabled": true
  }
]

​
錯誤回應

狀態碼描述
400無效的查詢參數或缺少知識庫 ID
401無效的 API 金鍰
404未找到知識庫或存取被拒絕
500內部伺服器錯誤

​
工作原理

  1. 驗證知識庫是否存在並屬於您的專案
  2. 查詢文字使用與知識庫相同的模型轉換為嵌入向量
  3. 使用嵌入向量對存儲的文本片段進行語義相似度搜尋
  4. 返回最相關的文本片段，按相似度分數排序
  5. 結果數量限制為指定的 topK 參數值

​
使用說明

  • 查詢使用語義搜尋處理，而不是精確文字匹配
  • 結果按與查詢的相關性排序返回
  • 回應包含來自指定知識庫中最相關的文本片段
  • 使用 topK 參數控制返回結果的數量
  • 制定查詢時請考慮上下文以獲得最佳結果
  • 知識庫必须屬於與您的 API 金鑰相關聯的專案

​
相關介面