全部產品
Search
文件中心

AI Coding Assistant Lingma:擷取知識庫列表

更新時間:Jul 01, 2025

通過 OpenAPI 擷取靈碼知識庫列表。

適用版本

企業專屬版

服務存取點

擷取服務存取點,替換 API 請求文法中的 {domain}

授權資訊

產品

資源

要求的權限

靈碼

知識庫

唯讀

請求文法

GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases

請求說明

查詢組織下的全部知識庫

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

知識庫名稱模糊查詢

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases?query=t' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

根據情境類型查詢知識庫

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases?sceneType=chat' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

要求標頭(Headers)

x-yunxiao-token string (必選)

個人存取權杖。您可參考個人存取權杖擷取。

樣本:pt-0fh3****0fbG_35af****0484。

請求參數

organizationId string (必選)

所屬組織ID。您可以前往組織管理後台基本資料頁面擷取organizationId

query string (可選)

知識庫名稱模糊查詢。

sceneType string (可選)

情境類型,支援如下兩種情境類型:

  • chat:智能問答情境。

  • complement:行間產生情境,此欄位為空白則擷取全部情境類型的知識庫列表。

orderBy string (可選)

排序列,支援如下排序欄位:

  • name:知識庫名稱。

  • sceneType:知識庫情境類型。

  • size:知識庫大小。

  • fileCount:知識庫內檔案數目。

  • lastActivityTime:知識庫上次活躍時間。

  • gmtCreate:知識庫建立時間。

sort string (可選)

排序次序:

  • desc:倒序。

  • asc:正序。

userId string (可選)

使用者識別碼:當傳入使用者 id 時,只會返回此使用者有許可權的知識庫列表;當此欄位為空白時,擷取全部的知識庫列表。

page integer (可選)預設值為1

當前頁。

perPage integer (可選)預設值為20

每頁資料條數的最大值,取值範圍:[1,20]

返回參數

返回樣本

[
    {
        "accessLevel": 10,
        "creator": {
            "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/113iaf62a4481af4cd44ad46d8c3e9b55851/w/100/h/100",
            "displayName": "fangqian_testcloud_com",
            "id": "66a6f60e368d88cff5a513fc",
            "userName": "test"
        },
        "description": "",
        "fileCount": 0,
        "gmtCreate": 1749712990396,
        "gmtModified": 1749712990396,
        "id": "7d9800958eabaa982de687c8",
        "lastActivityTime": 1749712990396,
        "memberCount": 1,
        "name": "test",
        "organizationId": "6826e1d0516a9f85a08cb522",
        "sceneType": "chat",
        "size": "0 B",
        "state": "disable"
    }
]

accessLevel integer

知識庫可見度,目前包含以下兩種:

  • 0:代表私人知識庫。

  • 10:代表公開知識庫。

creator object

知識庫建立者。

屬性

avatarUrl string

建立者頭像。

displayName string

建立者登入名稱稱。

id string

建立者 ID。

userName string

建立者暱稱。

description string

描述。

fileCount integer

知識庫內檔案數目。

gmtCreate integer

知識庫建立時間。

gmtModified integer

知識庫更新時間。

id string

知識庫 ID。

lastActivityTime integer

知識庫上次活躍時間。

memberCount integer

知識庫成員數目。

name string

知識庫名稱。

organizationId string

知識庫所屬組織 ID。

sceneType string

知識庫情境類型。目前包含以下兩種:

  • chat:智能問答情境。

  • complement:行間產生情境。

size string

知識庫大小。

state string

知識庫狀態,目前包含以下兩種:

  • enable:知識庫已啟用。

  • disable:知識庫未啟用。

回應標頭

參數

描述

樣本值

x-next-page

下一頁

1

x-page

當前頁

1

x-per-page

每頁大小

20

x-prev-page

前一頁

1

x-total

總數

9

x-total-pages

總分頁數

1

錯誤碼

訪問錯誤碼中心查看 API 相關錯誤碼。