インデックスタスクを再試行
run_state が failed または canceled のインデックスタスクを、同じタスク ID のまま再開し、更新後のタスクを返します。その後は、同じ ID で インデックスタスクを取得 をポーリングしてください。
タスクが published になった後でドキュメントをもう一度インデックスするには、ドキュメントを再インデックス を使用します。再インデックスの流れについては、再インデックスとインデックス処理の追跡 を参照してください。
run_state: superseded の試行は、stage が canceled であっても再試行できません。再インデックスのレスポンスから新しいタスク ID を保存している場合は、そのタスクをポーリングしてください。
curl --request POST \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry', 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}/retry",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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}/retry"
req, _ := http.NewRequest("POST", 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.post("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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": 0,
"failure": null,
"id": "e4a1f0b2-7c3d-4e5f-9a1b-2c3d4e5f6a7b",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"max_execution_attempts": 3,
"run_state": "dispatch_pending",
"stage": "outline_built",
"updated_at": 1788681800000,
"version": 1
}Authorizations
すべてのリクエストは、Authorization: Bearer {API_KEY} ヘッダーに指定した API キーで認証します。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401(unauthorized)が返ります。
Path Parameters
インデックスタスク ID です。どこで得た値も同じです。ドキュメントを再インデックス のレスポンスでは queued 項目の compilation_job.id、ドキュメントを取得 では latest_task.id です。ドキュメントのインデックスタスク一覧を取得 では id、バックグラウンドタスク一覧を取得 では document タスクの id です。
Response
再開されたタスクです。run_state は dispatch_pending で、error と completed_at は null です。
インデックス処理中のドキュメントファイルの ID です。ドキュメントファイルを取得 で使用できます。ドキュメント ID を送信した場合でも、タスクを開始した ドキュメントを再インデックス の項目の asset.id になります。
これまでの試行回数です。インデックスタスクを再試行 で 0 にリセットされるため、再試行を繰り返しても、それだけで試行回数の上限に達することはありません。
現在の試行のスケジューラ上の状態です:
dispatch_pending:受け付け済みで、ワーカーへの割り当てを待っています。queued:割り当て済みで、ワーカーを待っています。running:ワーカーがタスクを実行しています。retry_wait:自動再試行が予定されています。stageは変わりません。succeeded:stage: publishedとともに返されます。failed、canceled:最終状態です。superseded:新しい試行に置き換えられました。最終状態で、stage: canceledとともに返されます。キャンセルも再試行も受け付けません。
未設定の場合は null です。インデックスタスクを再試行 で dispatch_pending に設定されます。
インデックス処理の段階です。次の順に進みます:
queuedparsedoutline_builtnodes_generatedprojection_builtsmoke_eval_passedpublished
published は、新しいリビジョンがアクティブになったことを示します。最終状態を表すほかの値は failed と canceled です。インデックスタスクを再試行 では試行が到達したチェックポイントが維持されるため、再試行後にこの値が queued になることはほとんどありません。
Was this page helpful?
curl --request POST \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry', 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}/retry",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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}/retry"
req, _ := http.NewRequest("POST", 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.post("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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": 0,
"failure": null,
"id": "e4a1f0b2-7c3d-4e5f-9a1b-2c3d4e5f6a7b",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"max_execution_attempts": 3,
"run_state": "dispatch_pending",
"stage": "outline_built",
"updated_at": 1788681800000,
"version": 1
}