Skip to content

fix: describe agent knowledge base graph status for knowledge-fs 1.0.3 (#1157) (backport to release/1.18.0) #1162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RiskeyL merged 1 commit into from
Oct 30, 2026
Merged

fix: describe agent knowledge base graph status for knowledge-fs 1.0.3 (#1157) (backport to release/1.18.0) #1162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions en/api-reference/openapi_service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2307,7 +2307,7 @@
"type": "boolean"
},
"can_retry": {
"description": "Whether the task can be retried now. For `task_kind: document`, retry it with [Retry Indexing Task](/en/api-reference/indexing-tasks/retry-indexing-task) using `id`. That operation accepts only `failed` or `canceled` tasks, while `can_retry` is also `true` for a `completed` indexing task whose semantic enrichment failed.",
"description": "Whether the task can be retried now. For `task_kind: document`, retry it with [Retry Indexing Task](/en/api-reference/indexing-tasks/retry-indexing-task) using `id`.",
"type": "boolean"
},
"completed_at": {
Expand Down Expand Up @@ -2422,7 +2422,7 @@
"$ref": "#/components/schemas/KnowledgeBaseSemanticEnrichment"
}
],
"description": "Knowledge graph building status for an indexing task's content. Deep and Research searches follow the knowledge graph. `null` for other kinds.",
"description": "Knowledge graph building after an indexing task publishes; `null` for other kinds. Indexing finishes the knowledge graph before publishing, so it doesn't schedule this step. `state` is `not_scheduled` while the task runs and `disabled` once it has ended. `nodes_completed` stays `0`.",
"nullable": true
},
"source_id": {
Expand All @@ -2436,7 +2436,7 @@
"type": "string"
},
"state": {
"description": "`queued`, `running`, `completed`, `failed`, or `canceled`, mapped from the task's own state:\n\n- An indexing task is `completed` once it has published, even while its semantic enrichment is still running.\n- A crawl preview waiting for its pages to be selected is `completed`.\n\nFor the exact state, read an indexing task with [Get Indexing Task](/en/api-reference/indexing-tasks/get-indexing-task) and a source run with [Get Source Run](/en/api-reference/source-syncs-and-imports/get-source-run).",
"description": "`queued`, `running`, `completed`, `failed`, or `canceled`, mapped from the task's own state. A crawl preview waiting for its pages to be selected is `completed`.\n\nFor the exact state, read an indexing task with [Get Indexing Task](/en/api-reference/indexing-tasks/get-indexing-task) and a source run with [Get Source Run](/en/api-reference/source-syncs-and-imports/get-source-run).",
"type": "string"
},
"task_kind": {
Expand Down Expand Up @@ -2952,19 +2952,19 @@
"$ref": "#/components/schemas/KnowledgeBaseSemanticEnrichment"
}
],
"description": "Knowledge graph building status for the indexed content. Deep and Research searches follow the knowledge graph. When building wasn't scheduled, `state` is `not_scheduled` while the task runs and `disabled` once it has ended.",
"description": "Knowledge graph building after the revision publishes. Indexing finishes the knowledge graph before publishing, so it doesn't schedule this step. `state` is `not_scheduled` while the task runs and `disabled` once it has ended. `nodes_completed` stays `0`.",
"nullable": true
},
"stage": {
"description": "Last checkpoint reached, in forward order: `queued`, `parsed`, `outline_built`, `nodes_generated`, `projection_built`, `smoke_eval_passed`, `published`. It stays at the last checkpoint when the task fails or is canceled, so read `state` for the outcome.",
"type": "string"
},
"state": {
"description": "Run state:\n\n- `dispatch_pending`, `queued`: waiting for a worker.\n- `retry_wait`: an automatic retry is scheduled at `retry_at`.\n- `running`: a worker is indexing.\n- `succeeded`: the revision is published and serves queries. `semantic_enrichment` can still be running.\n- `failed`: see `failure`. Restart it with [Retry Indexing Task](/en/api-reference/indexing-tasks/retry-indexing-task).\n- `canceled`.\n- `superseded`: a newer attempt replaced this one.\n\n`succeeded`, `failed`, `canceled`, and `superseded` are terminal.",
"description": "Run state:\n\n- `dispatch_pending`, `queued`: waiting for a worker.\n- `retry_wait`: an automatic retry is scheduled at `retry_at`.\n- `running`: a worker is indexing.\n- `succeeded`: the revision is published and serves queries.\n- `failed`: see `failure`. Restart it with [Retry Indexing Task](/en/api-reference/indexing-tasks/retry-indexing-task).\n- `canceled`.\n- `superseded`: a newer attempt replaced this one.\n\n`succeeded`, `failed`, `canceled`, and `superseded` are terminal.",
"type": "string"
},
"updated_at": {
"description": "When the task or its enrichment last changed, ISO 8601.",
"description": "When the task last changed, ISO 8601.",
"type": "string"
}
},
Expand Down Expand Up @@ -3656,7 +3656,7 @@
"type": "integer"
},
"state": {
"description": "`not_scheduled`, `pending`, `running`, `ready`, `failed`, or `disabled`. Knowledge graph building can still be `pending` or `running` after the indexing task has published its revision.",
"description": "`not_scheduled`, `pending`, `running`, `ready`, `failed`, or `disabled`.",
"type": "string"
},
"updated_at": {
Expand Down Expand Up @@ -20554,7 +20554,7 @@
},
"/knowledge-fs/spaces/{knowledge_base_id}/background-tasks": {
"get": {
"description": "Lists the knowledge base's background work in one feed, or looks up specific tasks by ID:\n\n- Without `task_ids`: the newest indexing tasks, bulk tasks, and source runs, merged newest first. An indexing task that belongs to a bulk task appears as the bulk task, except when its content is already in use but its knowledge graph is still being built or failed to build. Follow `next_cursor` for older tasks.\n- With `task_ids`: up to 100 indexing task or bulk task IDs. Unknown IDs, tasks the key can't see, and source run IDs are left out. The list isn't paged.\n\nTo follow a [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents) request here, look up its `bulk_job_id`.\n\nFor which task operation to use when, see [Track Indexing](/en/api-reference/guides/knowledge-base#track-indexing).",
"description": "Lists the knowledge base's background work in one feed, or looks up specific tasks by ID:\n\n- Without `task_ids`: the newest indexing tasks, bulk tasks, and source runs, merged newest first. An indexing task that belongs to a bulk task appears as the bulk task. Follow `next_cursor` for older tasks.\n- With `task_ids`: up to 100 indexing task or bulk task IDs. Unknown IDs, tasks the key can't see, and source run IDs are left out. The list isn't paged.\n\nTo follow a [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents) request here, look up its `bulk_job_id`.\n\nFor which task operation to use when, see [Track Indexing](/en/api-reference/guides/knowledge-base#track-indexing).",
"operationId": "listBackgroundTasks",
"parameters": [
{
Expand Down Expand Up @@ -20686,18 +20686,18 @@
"error_code": null,
"error_message": null,
"failure": null,
"nodes_completed": 18,
"nodes_total": 18,
"provider_calls": 12,
"provider_calls_maximum": 200,
"state": "ready",
"updated_at": "2026-10-20T08:17:30Z"
"nodes_completed": 0,
"nodes_total": null,
"provider_calls": null,
"provider_calls_maximum": null,
"state": "disabled",
"updated_at": null
},
"source_id": null,
"source_title": null,
"state": "completed",
"task_kind": "document",
"updated_at": "2026-10-20T08:17:30Z"
"updated_at": "2026-10-20T08:16:05Z"
}
],
"next_cursor": "eyJ2ZXJzaW9uIjoxLCJzb3VyY2UiOnsiY3JlYXRlZEF0IjoiMjAyNi0xMC0yMFQxMDowMDowMC4wMDBaIiwiaWQiOiJlMWYyYTNiNC1jNWQ2LTRlN2YtOGE5Yi0wYzFkMmUzZjRhNWIifSwiYnVsayI6eyJjcmVhdGVkQXQiOiIyMDI2LTEwLTIwVDA5OjMwOjAwLjAwMFoiLCJpZCI6ImM3ZDllMWYzLTVhN2ItNGM5ZC04ZTBmLTFhMmIzYzRkNWU2ZiJ9LCJkb2N1bWVudCI6eyJjcmVhdGVkQXQiOiIyMDI2LTEwLTIwVDA4OjE1OjQyLjAwMFoiLCJpZCI6ImM0ZThhMmY2LTFiM2QtNGU1Zi04YTliLTBjMWQyZTNmNGE1YiJ9fQ"
Expand Down Expand Up @@ -26729,18 +26729,18 @@
"error_code": null,
"error_message": null,
"failure": null,
"nodes_completed": 18,
"nodes_total": 18,
"provider_calls": 12,
"provider_calls_maximum": 200,
"state": "ready",
"updated_at": "2026-10-20T08:17:30Z"
"nodes_completed": 0,
"nodes_total": null,
"provider_calls": null,
"provider_calls_maximum": null,
"state": "disabled",
"updated_at": null
},
"source_id": null,
"source_title": null,
"state": "completed",
"task_kind": "document",
"updated_at": "2026-10-20T08:17:30Z"
"updated_at": "2026-10-20T08:16:05Z"
},
"provider_item_id": null,
"row_version": 4,
Expand Down Expand Up @@ -27090,18 +27090,18 @@
"error_code": null,
"error_message": null,
"failure": null,
"nodes_completed": 18,
"nodes_total": 18,
"provider_calls": 12,
"provider_calls_maximum": 200,
"state": "ready",
"updated_at": "2026-10-20T08:17:30Z"
"nodes_completed": 0,
"nodes_total": null,
"provider_calls": null,
"provider_calls_maximum": null,
"state": "disabled",
"updated_at": null
},
"source_id": null,
"source_title": null,
"state": "completed",
"task_kind": "document",
"updated_at": "2026-10-20T08:17:30Z"
"updated_at": "2026-10-20T08:16:05Z"
},
"provider_item_id": null,
"row_version": 4,
Expand Down Expand Up @@ -27450,16 +27450,16 @@
"error_code": null,
"error_message": null,
"failure": null,
"nodes_completed": 18,
"nodes_total": 18,
"provider_calls": 12,
"provider_calls_maximum": 200,
"state": "ready",
"updated_at": "2026-10-20T08:17:30Z"
"nodes_completed": 0,
"nodes_total": null,
"provider_calls": null,
"provider_calls_maximum": null,
"state": "disabled",
"updated_at": null
},
"stage": "published",
"state": "succeeded",
"updated_at": "2026-10-20T08:17:30Z"
"updated_at": "2026-10-20T08:16:05Z"
}
],
"next_cursor": null
Expand Down Expand Up @@ -27700,7 +27700,7 @@
},
"/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}": {
"get": {
"description": "Returns one indexing task of a document, with its progress and knowledge graph status. Poll it until `state` is `succeeded`, `failed`, `canceled`, or `superseded`.\n\nFor a task started by [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents), poll [Get Indexing Task](/en/api-reference/indexing-tasks/get-indexing-task) with `compilation_job.id` instead.\n\nFor which task operation to use when, see [Track Indexing](/en/api-reference/guides/knowledge-base#track-indexing).",
"description": "Returns one indexing task of a document, with its progress. Poll it until `state` is `succeeded`, `failed`, `canceled`, or `superseded`.\n\nFor a task started by [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents), poll [Get Indexing Task](/en/api-reference/indexing-tasks/get-indexing-task) with `compilation_job.id` instead.\n\nFor which task operation to use when, see [Track Indexing](/en/api-reference/guides/knowledge-base#track-indexing).",
"operationId": "getDocumentIndexingTask",
"parameters": [
{
Expand Down
Loading
Loading