获取设置迁移

GET

knowledge-fs

spaces

{knowledge_base_id}

settings

migrations

{migration_id}

获取设置迁移

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

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_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

{
  "candidate_publication_fingerprint": "projection-set-sha256:9ce0b7c3b431e0f6550f3f16020732e205ce28e1a5f86426e0cf79e7499563b8",
  "changed_kind": "embedding",
  "checkpoint": "candidate-built",
  "completed_at": null,
  "created_at": "2026-10-20T03:10:00Z",
  "error_code": null,
  "evaluation_summary": null,
  "id": "a7c3e9f1-2b4d-4c6e-8f0a-1b3d5f7a9c2e",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "rebuild_scope": "full-vector-space",
  "run_state": "running",
  "updated_at": "2026-10-20T03:14:12Z"
}

Authorizations

Authorization

string

header

required

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path Parameters

knowledge_base_id

string<uuid>

required

知识库 ID：即知识库 API 访问对话框中所示服务 API 端点的最后一段（…/knowledge-fs/spaces/<knowledge base ID>），也是地址栏中 /datasets/new/ 之后的那一段。

migration_id

string<uuid>

required

迁移 ID：更新知识库设置的 202 响应中的 migration.id。其他操作都不会返回该 ID。

Response

该迁移。

candidate_publication_fingerprint

string | null

内部字段，跟踪迁移时无需使用。

changed_kind

string

本次更改涉及的部分：embedding 或 retrieval。

checkpoint

string

已到达的最后一步：queued、candidate-built、evaluated 或 activated。

completed_at

string | null

迁移结束（succeeded、failed 或 canceled）的时间，ISO 8601 格式。运行期间为 null。

created_at

string

迁移开始时间，ISO 8601 格式。

error_code

string | null

最近一次失败的错误码，例如 PROFILE_MIGRATION_ATTEMPTS_EXHAUSTED 或 VECTOR_SPACE_QUOTA_EXCEEDED。没有失败时为 null。

evaluation_summary

object | null

为重建的索引记录的评估结果（扁平键值映射）。未记录时为 null。

string

迁移 ID，可传给获取设置迁移。

knowledge_space_id

string

知识库的内部 ID，并非路径中的知识库 ID。

rebuild_scope

string

迁移重建的内容：

full-vector-space：更换嵌入模型，重新嵌入所有文档。
full-page-index-summary-outline：更换推理模型，重建页面索引、摘要和大纲。
clone-publication：其他检索设置更改，复用当前索引。

run_state

string

迁移进度：

queued、running：进行中。
succeeded：新设置已生效。
failed：已停止，原因见 error_code。再次尝试更改前，先通过获取知识库设置检查模型。
canceled：此迁移尚未完成时，同类的新更改取代了它。改为跟踪新的迁移。

updated_at

string

迁移最后变更时间，ISO 8601 格式。

获取设置迁移

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

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_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

{
  "candidate_publication_fingerprint": "projection-set-sha256:9ce0b7c3b431e0f6550f3f16020732e205ce28e1a5f86426e0cf79e7499563b8",
  "changed_kind": "embedding",
  "checkpoint": "candidate-built",
  "completed_at": null,
  "created_at": "2026-10-20T03:10:00Z",
  "error_code": null,
  "evaluation_summary": null,
  "id": "a7c3e9f1-2b4d-4c6e-8f0a-1b3d5f7a9c2e",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "rebuild_scope": "full-vector-space",
  "run_state": "running",
  "updated_at": "2026-10-20T03:14:12Z"
}