索引任务
获取索引任务
返回一个索引任务的状态。索引任务负责把文档文件的某个版本变成生效的修订版本。
轮询直到 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))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}")
.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}")
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
每个请求都通过 API 密钥认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API 密钥,知识库接口使用知识库 API 密钥(快速开始)。
API 密钥应保存在服务端,切勿嵌入客户端代码。缺失或无效的密钥会返回 HTTP 401(unauthorized)。
Path Parameters
索引任务 ID,以下各处出现的都是同一个值:重新索引文档 响应中 queued 条目的 compilation_job.id、获取文档 返回的 latest_task.id、获取文档的索引任务列表 返回的 id,以及 获取后台任务列表 中 document 任务的 id。
Response
索引任务。
已执行的尝试次数。重试索引任务 会将其重置为 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?
⌘I
获取索引任务
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))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}")
.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}")
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
}