インデックスタスク

インデックスタスクを取得

インデックスタスク 1 件の状態を返します。インデックスタスクとは、ドキュメントファイルの 1 つのバージョンをアクティブなリビジョンにする処理です。

stage が published、failed、canceled のいずれかになるまでポーリングしてください。stage が変わらない間は、run_state を見ると、タスクが待機中（queued、dispatch_pending、retry_wait）か running かがわかります。再インデックスの流れについては、再インデックスとインデックス処理の追跡を参照してください。

GET

knowledge-fs

spaces

{knowledge_base_id}

jobs

{task_id}

インデックスタスクを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}"

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}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}', 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}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}",
  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}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}")

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

{
  "base_head_revision": 1,
  "candidate_fingerprint": null,
  "candidate_publication_id": null,
  "completed_at": null,
  "created_at": 1788681600000,
  "document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
  "error": null,
  "execution_attempts": 1,
  "failure": null,
  "id": "e4a1f0b2-7c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "max_execution_attempts": 3,
  "run_state": "running",
  "stage": "outline_built",
  "updated_at": 1788681645000,
  "version": 1
}

Authorizations

Authorization

string

header

required

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

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

Path Parameters

knowledge_base_id

string<uuid>

required

ナレッジベース ID です。ナレッジベースの API アクセスダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

task_id

string<uuid>

required

インデックスタスク ID です。どこで得た値も同じです。ドキュメントを再インデックスのレスポンスでは queued 項目の compilation_job.id、ドキュメントを取得では latest_task.id です。ドキュメントのインデックスタスク一覧を取得では id、バックグラウンドタスク一覧を取得では document タスクの id です。

Response

インデックスタスクです。

base_head_revision

integer | null

内部用です。タスクの追跡には不要です。

candidate_fingerprint

string | null

内部用です。タスクの追跡には不要です。

candidate_publication_id

string | null

内部用です。タスクの追跡には不要です。

completed_at

number | null

タスクが最終状態に達した日時（エポックミリ秒）です。実行中と再試行後は null です。

created_at

number

タスクの作成日時（エポックミリ秒）です。

document_asset_id

string

インデックス処理中のドキュメントファイルの ID です。ドキュメントファイルを取得で使用できます。ドキュメント ID を送信した場合でも、タスクを開始したドキュメントを再インデックスの項目の asset.id になります。

error

string | null

短い失敗メッセージです。failure.message と異なる場合があります。stage または run_state が failed の場合にのみ設定されます。それ以外の場合は、キャンセルされたタスクも含めて null です。

execution_attempts

integer | null

これまでの試行回数です。インデックスタスクを再試行で 0 にリセットされるため、再試行を繰り返しても、それだけで試行回数の上限に達することはありません。

failure

object | null

タスクが失敗した場合のエラー詳細です。それ以外の場合は null です。

Show child attributes

string

インデックスタスク ID です。

knowledge_space_id

string

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

max_execution_attempts

integer | null

タスクが失敗となるまでに許可される試行回数です。

run_state

string | null

現在の試行のスケジューラ上の状態です：

dispatch_pending：受け付け済みで、ワーカーへの割り当てを待っています。
queued：割り当て済みで、ワーカーを待っています。
running：ワーカーがタスクを実行しています。
retry_wait：自動再試行が予定されています。stage は変わりません。
succeeded：stage: published とともに返されます。
failed、canceled：最終状態です。
superseded：新しい試行に置き換えられました。最終状態で、stage: canceled とともに返されます。キャンセルも再試行も受け付けません。

未設定の場合は null です。インデックスタスクを再試行で dispatch_pending に設定されます。

stage

string

インデックス処理の段階です。次の順に進みます：

queued
parsed
outline_built
nodes_generated
projection_built
smoke_eval_passed
published

published は、新しいリビジョンがアクティブになったことを示します。最終状態を表すほかの値は failed と canceled です。インデックスタスクを再試行では試行が到達したチェックポイントが維持されるため、再試行後にこの値が queued になることはほとんどありません。

updated_at

number

タスクが最後に変更された日時（エポックミリ秒）です。

version

integer

インデックス処理中のドキュメントファイルのバージョンです。

インデックスタスクを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}"

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}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}', 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}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}",
  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}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}")

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

{
  "base_head_revision": 1,
  "candidate_fingerprint": null,
  "candidate_publication_id": null,
  "completed_at": null,
  "created_at": 1788681600000,
  "document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
  "error": null,
  "execution_attempts": 1,
  "failure": null,
  "id": "e4a1f0b2-7c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "max_execution_attempts": 3,
  "run_state": "running",
  "stage": "outline_built",
  "updated_at": 1788681645000,
  "version": 1
}

ガイド

アプリ API

ナレッジ API

インデックスタスクを取得

Authorizations

Path Parameters

Response