通過 OpenAPI 擷取靈碼知識庫列表。
適用版本 | 企業專屬版 |
服務存取點
擷取服務存取點,替換 API 請求文法中的 {domain} 。
授權資訊
產品 | 資源 | 要求的權限 |
靈碼 | 知識庫 | 唯讀 |
請求文法
GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases請求說明 | 查詢組織下的全部知識庫知識庫名稱模糊查詢根據情境類型查詢知識庫 |
要求標頭(Headers) | |
x-yunxiao-token 個人存取權杖。您可參考個人存取權杖擷取。 樣本:pt-0fh3****0fbG_35af****0484。 | |
請求參數 | |
organizationId 所屬組織ID。您可以前往組織管理後台的基本資料頁面擷取organizationId。 | |
query 知識庫名稱模糊查詢。 | |
sceneType 情境類型,支援如下兩種情境類型:
| |
orderBy 排序列,支援如下排序欄位:
| |
sort 排序次序:
| |
userId 使用者識別碼:當傳入使用者 id 時,只會返回此使用者有許可權的知識庫列表;當此欄位為空白時,擷取全部的知識庫列表。 | |
page 當前頁。 | |
perPage 每頁資料條數的最大值,取值範圍: |
返回參數 | 返回樣本 |
accessLevel 知識庫可見度,目前包含以下兩種:
| |
creator 知識庫建立者。 | |
description string 描述。 | |
fileCount 知識庫內檔案數目。 | |
gmtCreate 知識庫建立時間。 | |
gmtModified 知識庫更新時間。 | |
id string 知識庫 ID。 | |
lastActivityTime 知識庫上次活躍時間。 | |
memberCount 知識庫成員數目。 | |
name 知識庫名稱。 | |
organizationId 知識庫所屬組織 ID。 | |
sceneType 知識庫情境類型。目前包含以下兩種:
| |
size 知識庫大小。 | |
state 知識庫狀態,目前包含以下兩種:
|
回應標頭
參數 | 描述 | 樣本值 |
x-next-page | 下一頁 | 1 |
x-page | 當前頁 | 1 |
x-per-page | 每頁大小 | 20 |
x-prev-page | 前一頁 | 1 |
x-total | 總數 | 9 |
x-total-pages | 總分頁數 | 1 |
錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。