子チャンク一覧を取得

特定の親チャンク配下の子チャンクのページネーションリストを返します。

GET /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks

子チャンク一覧を取得

cURL

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

success

{
  "data": [
    {
      "id": "d7e8f9a0-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
      "segment_id": "f3d1c7be-9f3a-40d8-8eb8-3a1ef9c3f2c1",
      "content": "Dify is an open-source platform.",
      "position": 1,
      "word_count": 6,
      "type": "customized",
      "created_at": 1741267200,
      "updated_at": 1741267200
    }
  ],
  "total": 1,
  "total_pages": 1,
  "page": 1,
  "limit": 20
}

Authorizations

Authorization · string · header · required

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path Parameters

dataset_id · string<uuid> · required

ナレッジベース ID です。ナレッジベースリストを取得 から取得します。

document_id · string<uuid> · required

ドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。

segment_id · string<uuid> · required

親チャンク ID です。チャンク一覧を取得 から取得します。

Query Parameters

page · integer · default: 1

ページ番号。

Required range: x >= 1

limit · integer · default: 20

1 ページあたりの項目数です。サーバーの上限は 100 です。

Required range: x >= 1

keyword · string

検索キーワードです。

Response

200

application/json

子チャンクのリストです。

data · object[]

子チャンクのリスト。

Show child attributes

total · integer

子チャンクの合計数です。

total_pages · integer

合計ページ数です。

page · integer

現在のページ番号です。

limit · integer

1 ページあたりの件数です。