すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:ListIndexDocuments

    ドキュメントセンター

    Alibaba Cloud Model Studio:ListIndexDocuments

    最終更新日:Sep 01, 2026

    指定されたナレッジベースからファイルとそのまとめ情報を取得します。

    操作説明

    • Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio の API 権限（AliyunBailianDataFullAccess（sfm:ListIndexFiles 権限を含む）が必要）を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出すことができます。最新のModel Studio SDKを使用してこの操作を呼び出してください。
    • この操作を呼び出す前に、ナレッジベースが作成済みで削除されていないこと（つまり、ナレッジベース ID IndexId が有効であること）を確認してください。
    • この操作はべき等性を持ちます。

    速度制限: この操作は、頻繁に呼び出されると速度制限されます。1 秒あたり 15 回を超えないようにしてください。速度制限された場合は、後でリトライしてください。

    今すぐお試しください

    この 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:ListIndexFiles

    list

    *All Resource

    *

    		なしなし

    リクエスト構文 

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    WorkspaceId

    string

    必須

    ナレッジベースのワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。

    llm-3z7uw7fwz0vexxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    IndexId

    string

    必須

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

    79c0alxxxx

    DocumentStatus

    string

    任意

    ファイルインポートステータスで返されるファイルリストをフィルタリングします。有効な値:

    • INSERT_ERROR: インデックスへのインポートに失敗した。

    • RUNNING: インデックス構築中。

    • DELETED: 削除済み。

    • FINISH: インデックス構築成功。

    • PARSE_FAILED: 解析失敗。

    • DOC_PARSING: 解析中。

    デフォルト値: 空。ファイルインポートステータスによるフィルタリングを行いません。

    列挙値:

    • INSERT_ERROR :

      ファイルインポートに失敗した。

    • RUNNING :

      ファイルインポート中。

    • DELETED :

      ファイルが削除された。

    • FINISH :

      ファイルインポートが成功した。

    FINISH

    DocumentName

    string

    任意

    ファイル名（ファイル拡張子を除く）で返されるファイルリストをフィルタリングします。デフォルト値: 空。ファイル名によるフィルタリングを行いません。

    product-overview

    EnableNameLike

    string

    任意

    ファイル名のあいまい一致を有効にするかどうかを指定します。このパラメーターは DocumentName パラメーターと組み合わせて使用します。有効な値:

    • true: ファイル名に基づいて返されるファイルリストのあいまい一致を実行します。

    • false: ファイル名に基づいて返されるファイルリストの完全一致を実行します。

    デフォルト値: false。

    列挙値:

    • true :

      有効。

    • false :

      無効。

    false

    PageNumber

    integer

    任意

    ページ番号。最小値: 1。デフォルト値: 1。

    1

    PageSize

    integer

    任意

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

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    35A267BF-xxxx-54DB-8394-AA3B0742D833

    Code

    string

    エラー状態コード。

    InvalidParameter

    Message

    string

    エラーメッセージ。

    Required parameter(%s) missing or invalid, please check the request parameters.

    Success

    boolean

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

    • true: 成功。

    • false: 失敗。

    true

    Data

    object

    操作によって返されるデータフィールド。

    Documents

    array<object>

    ナレッジベース内のファイルリスト。ドキュメントインポート時間の降順でソートされます（コンソールと同じ）。

    object

    ファイルオブジェクト。

    SourceId

    string

    ドキュメント検索ナレッジベースの場合、このパラメーターはカテゴリ ID を指定します。これは AddCategory 操作で返される CategoryId です。アプリケーションデータのファイルタブでカテゴリ名の横にある ID アイコンをクリックして取得することもできます。

    データクエリまたはイメージ Q&A ナレッジベースの場合、このパラメーターはデータテーブル ID を指定します。アプリケーションデータのテーブルタブでデータテーブル名の横にある ID アイコンをクリックして取得できます。

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

    Id

    string

    ファイル ID。

    doc_c134aa2073204a5d936d870bf960f56axxxxxxxx

    Name

    string

    ファイル名。

    product-overview

    Size

    integer

    ファイルサイズ（バイト単位）。

    996765

    DocumentType

    string

    ファイル形式タイプ。有効な値: pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。

    pdf

    Status

    string

    ファイルインポートステータス。有効な値:

    • INSERT_ERROR: ファイルインポートに失敗した。

    • RUNNING: ファイルインポート中。

    • DELETED: ファイルが削除された。

    • FINISH: ファイルインポートが成功した。

    列挙値:

    • INSERT_ERROR :

      ファイルインポートに失敗した。

    • RUNNING :

      ファイルインポート中。

    • DELETED :

      ファイルが削除された。

    • FINISH :

      ファイルインポートが成功した。

    RUNNING

    Code

    string

    ファイルインポートのエラー状態コード。

    110002

    Message

    string

    ファイルインポートのエラーメッセージ。

    check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid

    GmtModified

    integer

    ファイルがナレッジベースにインポートされた時間（UNIX タイムスタンプフォーマット）。

    1744856423000

    IndexId

    string

    ナレッジベース ID。

    pno97txxxx

    TotalCount

    integer

    返された結果の総数。

    2437

    PageNumber

    integer

    返されたページ番号。

    1

    PageSize

    integer

    返された 1 ページあたりのエントリ数。

    10

    Status

    string

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

    200

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
        "Name": "product-overview",
        "Size": 996765,
        "DocumentType": "pdf",
        "Status": "RUNNING",
        "Code": "110002",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "GmtModified": 1744856423000
      }
    ],
    "IndexId": "pno97txxxx",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

    エラーコード

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

    変更履歴

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