すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:ListIndices

    ドキュメントセンター

    Alibaba Cloud Model Studio:ListIndices

    最終更新日:Aug 26, 2026

    指定されたワークスペース内のナレッジベースのリストを取得します。

    操作説明

    • Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、Alibaba Cloud Model Studio の API 権限 を取得する必要があります (AliyunBailianDataFullAccess が必要で、これには sfm:ListIndex 権限が含まれます)。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出せます。この操作を呼び出すには、最新の Alibaba Cloud Model Studio SDK を使用してください。
    • この操作にはべき等性があります。

    レート制限: この操作は、頻繁に呼び出されるとスロットリングされます。毎秒 10 回を超える呼び出しは行わないでください。スロットリングされた場合は、後でリトライしてください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sfm:ListIndex

    list

    *すべてのリソース。

    *

    		なしなし

    リクエスト構文 

    GET /{WorkspaceId}/index/list_indices HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    WorkspaceId

    string

    必須

    ナレッジベースが属するワークスペースの ID。ワークスペース ID の取得方法については、「ワークスペースの使用方法」をご参照ください。

    llm-3shx2gu255oq6xxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    IndexName

    string

    任意

    ナレッジベースの名前。名前でナレッジベースを検索できます。名前の長さは 1～20 文字で、Unicode 文字カテゴリの文字 (英字、漢字、数字を含む) を含めることができます。また、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) も含めることができます。

    デフォルト値: 空。指定されたワークスペース内のすべてのナレッジベースを照会します。

    idx_status_score

    PageNumber

    string

    任意

    クエリするページ番号。最小値: 1。デフォルト値: 1。

    1

    PageSize

    string

    任意

    ページングクエリで 1 ページに表示するナレッジベースの数。最大値の制限はありません。 デフォルト値: 10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    17204B98-xxxx-4F9A-8464-2446A84821CA

    Data

    object

    返されるデータ。

    PageNumber

    integer

    指定されたページ番号。

    1

    PageSize

    integer

    指定されたページサイズ。

    10

    TotalCount

    integer

    返されるエントリの総数。

    48

    Indices

    array<object>

    ナレッジベースのリスト。

    array<object>

    ナレッジベースオブジェクト。

    Id

    string

    ナレッジベースの ID。CreateIndex 操作によって返される Data.Id です。

    lecxr5xxxx

    Name

    string

    ナレッジベースの名前。

    XXXX Product List

    Description

    string

    ナレッジベースの説明。

    このリストの製品は主に海外のお客様向けです

    StructureType

    string

    ナレッジベースのタイプ。有効な値:

    • UNSTRUCTURED: ドキュメント検索。

    UNSTRUCTURED

    ChunkSize

    integer

    推定チャンクサイズ。有効な値: 1～2048。

    5

    OverlapSize

    integer

    チャンクの重複サイズ。有効な値: 0～1024。

    10

    Separator

    string

    文の区切り文字。複数の区切り文字を使用する場合、| で区切ります。有効な値:


    • : 改行

    • ，: 中国語のカンマ

    • ,: 英語のカンマ

    • 。: 中国語のピリオド

    • .: 英語のピリオド

    • ！: 中国語の感嘆符

    • !: 英語の感嘆符

    • ；: 中国語のセミコロン

    • ;: 英語のセミコロン

    • ？: 中国語の疑問符

    • ?: 英語の疑問符

    \n

    EmbeddingModelName

    string

    埋め込みモデル名。有効な値:

    • text-embedding-v2: text-embedding-v2 モデル。

    text-embedding-v2

    RerankModelName

    string

    再ランキングモデル名。有効な値:

    • gte-rerank-hybrid: 公式再ランキング。

    • gte-rerank: gte-rerank 再ランキング。

    gte-rerank-hybrid

    RerankMinScore

    string

    類似度のしきい値。有効な値: 0.01～1.00。

    0.01

    SourceType

    string

    Alibaba Cloud Model Studio の アプリケーションデータにおけるデータの型。

    ドキュメント検索ナレッジベースの場合、有効な値:

    • DATA_CENTER_CATEGORY: カテゴリタイプ。

    • DATA_CENTER_FILE: ファイルタイプ。

    データクエリ/イメージ Q&A ナレッジベースの場合、有効な値:

    • DATA_CENTER_STRUCTURED_TABLE: データテーブルタイプ。

    DATA_CENTER_FILE

    DocumentIds

    array

    ファイル ID のリスト。

    string

    ファイル ID。

    file_8c67b438043848199ffaa903d29addd4_xxxxxxxx

    SinkType

    string

    ナレッジベースのベクターストレージタイプ。有効な値:

    • ES: 組み込みベクトルデータベース。

    • BUILT_IN: 組み込みベクトルデータベース。

    • ADB: AnalyticDB for PostgreSQL データベース。

    BUILT_IN

    SinkInstanceId

    string

    ナレッジベースのベクターストレージのインスタンス ID。

    gp-bp1gq62t1788yxxxx

    SinkRegion

    string

    ナレッジベースのベクターストレージインスタンスのリージョン。

    cn-hangzhou

    ConfgModel

    string

    このナレッジベースで使用される構成モード。有効な値:

    • recommend: 推奨構成。

    • user-defined: カスタム構成。

    recommend

    EnableRewrite

    boolean

    このナレッジベースでマルチターン会話の書き換えによる最適化が有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    false

    StructuredIndexConfig

    array<object>

    object

    Name

    string

    name

    Type

    string

    列挙値:

    • datetime :

      datetime

    • string :

      string

    • double :

      double

    • image_url :

      image_url

    • long :

      long

    string

    IsSearch

    boolean

    列挙値:

    • true :

      true

    • false :

      false

    true

    IsRecall

    boolean

    列挙値:

    • true :

      true

    • false :

      false

    true

    Code

    string

    エラー状態コード。

    Index.InvalidParameter

    Message

    string

    エラーメッセージ。

    必須パラメーター (%s) が欠落しているか有効ではありません。リクエストパラメーターを確認してください。

    Success

    boolean

    操作が成功したかどうかを示します。有効な値:

    • true: 成功。

    • false: 失敗。

    true

    Status

    string

    操作によって返される状態コード。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 48,
    "Indices": [
      {
        "Id": "lecxr5xxxx",
        "Name": "XXXX Product List",
        "Description": "このリストの製品は主に海外のお客様向けです",
        "StructureType": "UNSTRUCTURED",
        "ChunkSize": 5,
        "OverlapSize": 10,
        "Separator": "\\n",
        "EmbeddingModelName": "text-embedding-v2",
        "RerankModelName": "gte-rerank-hybrid",
        "RerankMinScore": "0.01",
        "SourceType": "DATA_CENTER_FILE",
        "DocumentIds": [
          "file_8c67b438043848199ffaa903d29addd4_xxxxxxxx"
        ],
        "SinkType": "BUILT_IN",
        "SinkInstanceId": "gp-bp1gq62t1788yxxxx",
        "SinkRegion": "cn-hangzhou",
        "ConfgModel": "recommend",
        "EnableRewrite": false,
        "StructuredIndexConfig": [
          {
            "Name": "name",
            "Type": "string",
            "IsSearch": true,
            "IsRecall": true
          }
        ]
      }
    ]
  },
  "Code": "Index.InvalidParameter",
  "Message": "必須パラメーター (%s) が欠落しているか有効ではありません。リクエストパラメーターを確認してください。",
  "Success": true,
  "Status": "200"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。