すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:ListIndexFileDetails

    ドキュメントセンター

    Alibaba Cloud Model Studio:ListIndexFileDetails

    最終更新日:Oct 11, 2026

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

    操作説明

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

    今すぐお試しください

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

    list

    *すべてのリソース。

    *

    		なしなし

    リクエスト構文 

    POST /{WorkspaceId}/index/list_index_file_detail 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: 解析中です。

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

    FINISH。

    DocumentName

    string

    任意

    ファイル名に基づいて、返されるファイル詳細リストをフィルタリングします。デフォルト値: 空。ファイル名によるフィルタリングは行われません。

    TranslationPlatformO&MDocument.

    PageNumber

    integer

    任意

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

    1

    PageSize

    integer

    任意

    ページングクエリで 1 ページに表示するファイル数。最大値: 10。

    10

    EnableNameLike

    string

    任意

    ファイル名のあいまいマッチングを有効にするかどうかを指定します。このパラメーターは DocumentName パラメーターと併用します。有効な値:

    • true: ファイル名に基づいて、返されるファイルリストに対してあいまいマッチングを実行します。

    • false: ファイル名に基づいて、返されるファイルリストに対して完全一致マッチングを実行します。

    デフォルト値: false。

    列挙値:

    • true :

      有効。

    • false :

      無効。

    false。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    35A267BF-xxxx-54DB-8394-AA3B0742D833

    Code

    string

    エラー状態コード。

    InvalidParameter

    Message

    string

    エラーメッセージ。

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

    Success

    boolean

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

    • true: 成功。

    • false: 失敗。

    true。

    Data

    object

    操作のビジネスデータフィールド。

    Documents

    array<object>

    ナレッジベース内のファイルのリスト。ファイルのインポート時間の降順でソートされます (コンソールと同じ順序)。

    object

    ファイルオブジェクト。

    Status

    string

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

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

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

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

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

    RUNNING。

    EnableHeaders

    string

    Excel ファイルのヘッダーの連結がサポートされているかどうかを示します。

    true。

    Message

    string

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

    fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] が有効でないことを確認してください。

    Size

    integer

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

    996764

    SourceId

    string

    カテゴリ ID。

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx。

    DocumentType

    string

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

    pdf。

    Id

    string

    ファイル ID。

    doc_c134aa2073204a5d936d870bf960f56axxxxxxxx。

    Code

    string

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

    110002

    Name

    string

    ファイル名。

    TranslationPlatformO&MDocument.

    ChunkSize

    string

    チャンクの長さ。テキストチャンク内の文字数です。

    600

    OverlapSize

    string

    チャンクの重複の長さ。

    100

    ChunkMode

    string

    カスタムチャンクモード。

    DashSplitter。

    GmtModified

    integer

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

    1744856423000

    separator

    string

    文の区切り文字。

    " "

    MetaExtractInfo

    string

    { "doc_summary": ["Example 1."], "health_rule": ["Example 2"] }

    IndexId

    string

    ナレッジベースの ID。

    79c0alxxxx。

    TotalCount

    integer

    返された結果の総数。

    2437

    PageNumber

    integer

    返されたページ番号。

    1

    PageSize

    integer

    返された 1 ページあたりの項目数。

    10

    Status

    string

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

    200

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter",
  "Message": "必須パラメーター (%s) が欠落しているか有効ではありません。リクエストパラメーターを確認してください。",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "Status": "RUNNING。",
        "EnableHeaders": "true。",
        "Message": "fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] が有効でないことを確認してください。",
        "Size": 996764,
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx。",
        "DocumentType": "pdf。",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx。",
        "Code": "110002",
        "Name": "TranslationPlatformO&MDocument.",
        "ChunkSize": "600",
        "OverlapSize": "100",
        "ChunkMode": "DashSplitter。",
        "GmtModified": 1744856423000,
        "separator": "\" \"",
        "MetaExtractInfo": "{\n  \"doc_summary\": [\"Example 1.\"],\n  \"health_rule\": [\"Example 2\"]\n}"
      }
    ],
    "IndexId": "79c0alxxxx。",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

    エラーコード

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

    変更履歴

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