すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:ListChunks

    ドキュメントセンター

    Alibaba Cloud Model Studio:ListChunks

    最終更新日:Aug 26, 2026

    テキストチャンクのリストと情報を照会します。

    操作説明

    • ドキュメント検索ナレッジベースの場合、この操作は指定されたファイルのすべてのチャンクを照会します。データクエリまたはイメージ Q&A ナレッジベースの場合、この操作はすべてのテキストチャンクの情報を取得します。
    • Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio の API 権限 を取得し（AliyunBailianDataFullAccess が必要で、sfm:ChunkList 権限を含みます）、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出すことができます。最新のModel Studio SDKを使用してこの操作を呼び出してください。
    • この操作を呼び出す前に、ナレッジベースが作成済みで削除されていないこと（つまり、ナレッジベース ID IndexId が有効であること）を確認してください。
    • この操作はべき等性を持ちます。

    レート制限: この操作は、頻繁に呼び出されるとスロットリングされます。1 秒あたり 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:ChunkList

    list

    *All Resource

    *

    		なしなし

    リクエスト構文 

    POST /{WorkspaceId}/index/list_chunks HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    WorkspaceId

    string

    必須

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

    llm-3z7uw7fwz0vxxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    body

    object

    任意

    リクエストパラメーターの本文。

    Fields

    array

    任意

    この操作が返す Metadata フィールド内の非公開フィールド（アンダースコア _ で始まらないフィールド）をフィルターするために使用されるフィールド名の配列。デフォルトでは Fields は空で、Metadata 内のすべての非公開フィールドが返されます。Metadata 内の特定の非公開フィールドのみを返す場合（例: タイトル）、このパラメーターに title を渡してください。

    デフォルト値: 空。

    string

    任意

    フィールド名。

    name

    Filed

    string

    任意

    レガシ Model Studio SDK のファイル ID フィールド。使用方法とデフォルト値は FileId フィールドと同一です。以下のバージョン（またはそれ以降）の Model Studio SDK を使用している場合は、代わりに FileId フィールドを使用してください。SWIFT Model Studio SDK を使用している場合は、引き続きこのフィールドを使用してください。

    • Java (async): 1.0.18

    • Java: 1.10.2

    • TypeScript: 1.10.2

    • Go: 1.10.2

    • PHP: 1.10.2

    • Python: 1.10.2

    • C#: 1.10.2

    • C++: 1.10.17

    Model Studio SDK バージョンの確認方法: Model Studio SDK センターにアクセスし、左側のナビゲーションウィンドウで「インストール」をクリックし、API バージョンを「2023-12-29」に設定し、プログラミング言語を選択してから、「履歴バージョン」をクリックしてバージョンを確認してください。

    file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

    FileId

    string

    任意

    ファイル ID。AddFile 操作によって返される FileId です。データクエリまたはイメージ Q&A ナレッジベースの場合、このフィールドは必須ではありません。ドキュメント検索ナレッジベースの場合、このフィールドは必須です。アプリケーションデータのファイルタブでファイル名の横にある ID アイコンをクリックしてファイル ID を取得することもできます。ファイル ID を使用して、返されるチャンクをフィルターできます。デフォルト値: 空。

    .

    file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

    IndexId

    string

    必須

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

    otoru9xxxx

    PageNum

    integer

    任意

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

    1

    PageSize

    integer

    任意

    ページングクエリで 1 ページあたりに表示するテキストチャンクの数。最大値: 100。デフォルト値: 10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    エラー状態コード。

    Index.InvalidParameter

    Data

    object

    操作によって返されるビジネスデータ。

    Nodes

    array<object>

    テキストチャンクのリスト。

    object

    テキストチャンクオブジェクト。

    Metadata

    any

    チャンクのメタデータマップ。

    { "file_path": "https://bailian-***", "parent": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "is_displayed_chunk_content": "true", "image_url": [], "nid": "83***", "source": "0", "_score": 0, "title": "", "doc_id": "file_24e***", "content": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "_rc_score": 0, "workspace_id": "llm-zna***", "hier_title": "", "doc_name": "什么是阿里云百炼", "pipeline_id": "j6b***", "_id": "llm-zna5***" }

    Score

    number

    チャンクの類似スコア。

    0

    Text

    string

    チャンクのテキスト。

    阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。

    Total

    integer

    返された結果の総数。

    1

    Message

    string

    エラーメッセージ。

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

    RequestId

    string

    リクエスト ID。

    8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1

    Status

    string

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

    200

    Success

    boolean

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

    • true: 成功。

    • false: 失敗した。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "Index.InvalidParameter",
  "Data": {
    "Nodes": [
      {
        "Metadata": "{\n  \"file_path\": \"https://bailian-***\",\n  \"parent\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n  \"is_displayed_chunk_content\": \"true\",\n  \"image_url\": [],\n  \"nid\": \"83***\",\n  \"source\": \"0\",\n  \"_score\": 0,\n  \"title\": \"\",\n  \"doc_id\": \"file_24e***\",\n  \"content\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n  \"_rc_score\": 0,\n  \"workspace_id\": \"llm-zna***\",\n  \"hier_title\": \"\",\n  \"doc_name\": \"什么是阿里云百炼\",\n  \"pipeline_id\": \"j6b***\",\n  \"_id\": \"llm-zna5***\"\n}",
        "Score": 0,
        "Text": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。"
      }
    ],
    "Total": 1
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
  "Status": "200",
  "Success": true
}

    エラーコード

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

    変更履歴

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