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

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

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

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

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

Response

{
  "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
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

knowledge_base_idstringrequired#

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

task_idstringrequired#

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

Responses

application/json

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

base_head_revisioninteger#

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

candidate_fingerprintstring#

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

candidate_publication_idstring#

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

completed_atnumber#

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

created_atnumber#

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

document_asset_idstring#

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

errorstring#

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

execution_attemptsinteger#

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

failureobject#

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

Show child attributes

actionstring#

推奨される次の対応です。ある場合は configure_model、configure_parser、configure_source、contact_admin、reupload、retry のいずれかです。該当しない場合は null で、HTTP エラーのボディでは省略されます。

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

失敗の内容を補足する最大 8 個の値です。キーは attempt、currentRowVersion、documentCount、expectedRowVersion、fileSizeBytes、limit、maxFileSizeBytes、maxItems、modelType、providerKind、retryAfterSeconds、status のいずれかです。値がない場合は null で、HTTP エラーのボディでは省略されます。

retryPolicystring#

再試行で解決できるかどうかです。automatic（サービスが自動で再試行）、manual（呼び出し側で再試行）、after_configuration（先に Dify でナレッジベースの設定を修正）、never（リクエストを変更）のいずれかです。

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは null になることがあり、HTTP エラーのボディでは省略されることがあります。

idstring#

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

knowledge_space_idstring#

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

max_execution_attemptsinteger#

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

run_statestring#

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

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

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

stagestring#

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

queued
parsed
outline_built
nodes_generated
projection_built
smoke_eval_passed
published

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

updated_atnumber#

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

versioninteger#

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

ドキュメントを再インデックスインデックスタスクをキャンセル