すべてのプロダクト
Search

このプロダクト

    Qoder CN シリーズ:ナレッジベースのリスト

    ドキュメントセンター

    Qoder CN シリーズ:ナレッジベースのリスト

    最終更新日:Mar 27, 2026

    Lingma のナレッジベースのリストを取得します。

    サポートされているエディション

    Enterprise Dedicated Edition

    サービスエンドポイント

    サービスエンドポイントを取得し、API リクエスト構文の {domain} をご利用の エンドポイント に置き換えます。

    認証

    プロダクト

    リソース

    必要な権限

    Lingma

    ナレッジベース

    読み取り専用

    リクエスト構文

    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'

    リクエストヘッダー

    x-yunxiao-token string (必須)

    アクセストークン。詳細については、「 アクセストークン 」をご参照ください。

    例：pt-0fh3****0fbG_35af****0484。

    リクエストパラメーター

    organizationId string (必須)

    組織 ID です。組織 ID を取得するには、[基本情報] ページの [管理コンソール] を参照してください。

    query string (オプション)

    ナレッジベース名によるあいまい検索のキーワード。

    sceneType string (オプション)

    シナリオタイプ。有効な値：

    • chat：チャットシナリオ。

    • complement：コード補完シナリオ。sceneType パラメーターを指定しない場合、すべてのシナリオタイプのナレッジベースが返されます。

    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

    作成者のアバターの URL。

    displayName string

    作成者の表示名。

    id string

    作成者の ID。

    userName string

    作成者のユーザー名。

    description string

    ナレッジベースの説明。

    fileCount integer

    ナレッジベース内のファイル数。

    gmtCreate integer

    作成時間 (ミリ秒単位の UNIX タイムスタンプ)。

    gmtModified integer

    更新時間 (ミリ秒単位の UNIX タイムスタンプ)。

    id string

    ナレッジベースの ID。

    lastActivityTime integer

    最終アクティビティ時間 (ミリ秒単位の UNIX タイムスタンプ)。

    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

    エラーコード

    詳細については、「エラーコード」をご参照ください。