Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(knowledge-fs): preserve model settings failure details (#44971)

Jyong03fe4879a432
diff --git a/api/controllers/console/knowledge_fs/error.py b/api/controllers/console/knowledge_fs/error.py
index a07d56cfbfb..dd5589be857 100644
--- a/api/controllers/console/knowledge_fs/error.py
+++ b/api/controllers/console/knowledge_fs/error.py
@@ -5,10 +5,15 @@ from services.knowledge_fs.product_dto import KnowledgeFSPublicFailureResponse
class _KnowledgeFSFailureHTTPError(BaseHTTPException):
+ details_model = KnowledgeFSPublicFailureResponse
+
def __init__(self, failure: KnowledgeFSPublicFailureResponse | None = None) -> None:
super().__init__(failure.message if failure else None)
if failure is not None and self.data is not None:
- self.data["failure"] = failure.model_dump(by_alias=True, exclude_none=True)
+ details = failure.model_dump(by_alias=True, exclude_none=True)
+ self.data["details"] = details
+ # Keep the legacy field for clients that do not consume the documented error details.
+ self.data["failure"] = details
class KnowledgeFSSpaceNotFoundHTTPError(_KnowledgeFSFailureHTTPError):
diff --git a/api/libs/external_api.py b/api/libs/external_api.py
index a4766e2a3f8..72bf7a7c3e1 100644
--- a/api/libs/external_api.py
+++ b/api/libs/external_api.py
@@ -1,3 +1,4 @@
+import json
import pkgutil
import re
from collections.abc import Callable, Iterable, Mapping
@@ -285,10 +286,12 @@ def _explicit_json_schema(response: Mapping[str, Any]) -> object | None:
def _comparable_schema(schema: object) -> object:
- """``schema`` with order-insensitive parts (``required``) normalized, for equality checks."""
+ """``schema`` with order-insensitive parts (``required``, ``enum``) normalized for equality checks."""
if isinstance(schema, dict):
return {
- key: sorted(value) if key == "required" and isinstance(value, list) else _comparable_schema(value)
+ key: sorted(value, key=lambda item: json.dumps(item, sort_keys=True))
+ if key in {"required", "enum"} and isinstance(value, list)
+ else _comparable_schema(value)
for key, value in schema.items()
}
if isinstance(schema, list):
diff --git a/api/tests/unit_tests/controllers/console/knowledge_fs/test_resources.py b/api/tests/unit_tests/controllers/console/knowledge_fs/test_resources.py
index b53bcd99050..90b6306aa13 100644
--- a/api/tests/unit_tests/controllers/console/knowledge_fs/test_resources.py
+++ b/api/tests/unit_tests/controllers/console/knowledge_fs/test_resources.py
@@ -3912,8 +3912,33 @@ class TestKnowledgeFsResourceDelegationCases:
"message": safe_message,
"status": status,
"failure": expected_failure,
+ "details": expected_failure,
}
+ @staticmethod
+ def test_console_settings_conflict_exposes_documented_failure_details() -> None:
+ from services.knowledge_fs.product_remote import KnowledgeFSProductRequestRejectedError
+
+ failure = KnowledgeFSPublicFailureResponse.model_validate(
+ {
+ "category": "conflict",
+ "code": "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS",
+ "message": "Private worker diagnostic",
+ "retryPolicy": "manual",
+ }
+ )
+ guarded = console_resources._knowledge_fs_errors(
+ raising(KnowledgeFSProductRequestRejectedError(status_code=409, failure=failure))
+ )
+
+ with pytest.raises(KnowledgeFSConflictHTTPError) as raised:
+ guarded()
+
+ assert raised.value.data is not None
+ assert raised.value.data["details"] == failure.model_dump(by_alias=True, exclude_none=True)
+ assert raised.value.data["failure"] == raised.value.data["details"]
+ assert "Private worker diagnostic" not in str(raised.value.data)
+
@staticmethod
def test_console_request_rejection_preserves_safe_failure_metadata() -> None:
from services.knowledge_fs.product_remote import KnowledgeFSProductRequestRejectedError
@@ -3939,6 +3964,7 @@ class TestKnowledgeFsResourceDelegationCases:
"code": "knowledge_fs_request_rejected",
"message": "The Agent Knowledge Base operation requires a configuration change before it can continue.",
"status": 422,
+ "details": failure.model_dump(by_alias=True, exclude_none=True),
"failure": {
"action": "configure_model",
"category": "configuration",
diff --git a/api/tests/unit_tests/libs/test_external_api.py b/api/tests/unit_tests/libs/test_external_api.py
index 0ea321ff6f3..88013d61343 100644
--- a/api/tests/unit_tests/libs/test_external_api.py
+++ b/api/tests/unit_tests/libs/test_external_api.py
@@ -1,5 +1,6 @@
from collections.abc import Callable
from functools import wraps
+from typing import Literal
import pytest
from flask import Blueprint, Flask
@@ -623,6 +624,35 @@ def test_details_model_definitions_must_not_collide_with_different_schemas():
attach_error_response_schema(document, ErrorResponse, _resolve_by_class)
+class _EnumConflictDetails(BaseModel):
+ state: Literal["retry", "configure", 1]
+
+
+class _EnumConflictError(BaseHTTPException):
+ error_code = "enum_conflict"
+ code = 409
+ details_model = _EnumConflictDetails
+
+
+def test_details_model_reuses_registered_schema_with_reordered_enum_values() -> None:
+ # Response schema registration sorts enums; their order does not change the contract.
+ schema = _EnumConflictDetails.model_json_schema(mode="serialization")
+ schema["properties"]["state"]["enum"].reverse()
+ document: dict[str, object] = {
+ "components": {"schemas": {"_EnumConflictDetails": schema}},
+ "paths": {
+ "/items": {"get": {"responses": {}, "x-dify-error-codes": _documented_names_for(_EnumConflictError)}}
+ },
+ }
+
+ attach_error_response_schema(document, ErrorResponse, _resolve_by_class)
+
+ schemas = document["components"]["schemas"] # type: ignore[index]
+ assert schemas["EnumConflictError"]["allOf"][1]["properties"]["details"] == {
+ "$ref": "#/components/schemas/_EnumConflictDetails"
+ }
+
+
def test_error_component_names_must_not_collide():
document: dict[str, object] = {
"components": {"schemas": {"DocumentedConflictError": {"type": "object"}}},
diff --git a/packages/contracts/generated/api/console/knowledge-fs/errors.gen.ts b/packages/contracts/generated/api/console/knowledge-fs/errors.gen.ts
index e4193dea48b..f4220f8e43a 100644
--- a/packages/contracts/generated/api/console/knowledge-fs/errors.gen.ts
+++ b/packages/contracts/generated/api/console/knowledge-fs/errors.gen.ts
@@ -10,10 +10,157 @@ const zErrorResponse = /* @__PURE__ */ (() =>
status: z.int(),
}))()
+const zKnowledgeFsPublicFailureResponse = /* @__PURE__ */ (() =>
+ z.object({
+ action: z
+ .enum([
+ 'configure_model',
+ 'configure_parser',
+ 'configure_source',
+ 'contact_admin',
+ 'retry',
+ 'reupload',
+ ])
+ .nullish(),
+ category: z.enum([
+ 'authorization',
+ 'canceled',
+ 'configuration',
+ 'conflict',
+ 'dependency',
+ 'internal',
+ 'not_found',
+ 'rate_limit',
+ 'timeout',
+ 'validation',
+ ]),
+ code: z.enum([
+ 'DOCUMENT_COMPILATION_FAILED',
+ 'DOCUMENT_COMPILATION_LEASE_LOST',
+ 'DOCUMENT_COMPILATION_PROFILE_CHANGED',
+ 'DOCUMENT_COMPILATION_RETRYABLE',
+ 'DOCUMENT_COUNT_QUOTA_EXCEEDED',
+ 'DOCUMENT_COUNT_QUOTA_UNAVAILABLE',
+ 'DOCUMENT_DISABLED',
+ 'DOCUMENT_PARSER_INPUT_INVALID',
+ 'DOCUMENT_PARSER_NOT_CONFIGURED',
+ 'DOCUMENT_PARSER_RATE_LIMITED',
+ 'DOCUMENT_PARSER_RESPONSE_INVALID',
+ 'DOCUMENT_PARSER_TIMEOUT',
+ 'DOCUMENT_PARSER_UNAVAILABLE',
+ 'DOCUMENT_PARSER_UNSUPPORTED_TYPE',
+ 'DOCUMENT_PDF_RENDER_FAILED',
+ 'DURABLE_DELETION_IDEMPOTENCY_CONFLICT',
+ 'EMBEDDING_DIMENSION_INVALID',
+ 'EMBEDDING_DIMENSION_UNSUPPORTED',
+ 'EXECUTION_ATTEMPTS_EXHAUSTED',
+ 'KNOWLEDGE_FS_ACCESS_DENIED',
+ 'KNOWLEDGE_FS_CONFLICT',
+ 'KNOWLEDGE_FS_INTERNAL_ERROR',
+ 'KNOWLEDGE_FS_INVALID_REQUEST',
+ 'KNOWLEDGE_FS_NOT_FOUND',
+ 'KNOWLEDGE_FS_RATE_LIMITED',
+ 'KNOWLEDGE_FS_TIMEOUT',
+ 'KNOWLEDGE_FS_UNAVAILABLE',
+ 'KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND',
+ 'KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED',
+ 'KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS',
+ 'KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED',
+ 'KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT',
+ 'LOGICAL_DOCUMENT_CAS_CONFLICT',
+ 'MODEL_CAPABILITY_MISMATCH',
+ 'MODEL_CONFIGURATION_STALE',
+ 'MODEL_CREDENTIAL_INVALID',
+ 'MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE',
+ 'MODEL_IDENTITY_MISMATCH',
+ 'MODEL_PREFLIGHT_CANCELED',
+ 'MODEL_PREFLIGHT_FAILED',
+ 'MODEL_PREFLIGHT_TIMEOUT',
+ 'MODEL_PREFLIGHT_UNAVAILABLE',
+ 'MODEL_PROFILE_ACTIVATION_INCOMPLETE',
+ 'MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED',
+ 'MODEL_RUNTIME_CONTEXT_LIMIT',
+ 'MODEL_RUNTIME_FAILED',
+ 'MODEL_RUNTIME_OUTPUT_LIMIT',
+ 'MODEL_RUNTIME_RESPONSE_INVALID',
+ 'MODEL_RUNTIME_TIMEOUT',
+ 'MODEL_RUNTIME_UNAVAILABLE',
+ 'MODEL_SELECTION_NOT_FOUND',
+ 'RESEARCH_TASK_CAPABILITY_REVOKED',
+ 'RESEARCH_TASK_DISPATCH_DEAD',
+ 'RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED',
+ 'RESEARCH_TASK_FAILED',
+ 'RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID',
+ 'RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID',
+ 'RETRIEVAL_DELETION_IN_PROGRESS',
+ 'RETRIEVAL_EXECUTION_LEASE_LOST',
+ 'SOURCE_BULK_ACTION_FAILED',
+ 'SOURCE_CONNECTION_UNAVAILABLE',
+ 'SOURCE_CRAWL_PAGE_NOT_FOUND',
+ 'SOURCE_CRAWL_PROVIDER_UNAVAILABLE',
+ 'SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED',
+ 'SOURCE_CREDENTIAL_CONFIG_INVALID',
+ 'SOURCE_CREDENTIAL_MUTATION_FAILED',
+ 'SOURCE_CREDENTIAL_TEST_FAILED',
+ 'SOURCE_CREDENTIAL_UNAVAILABLE',
+ 'SOURCE_DOCUMENT_COMPILATION_FAILED',
+ 'SOURCE_DOCUMENT_MATERIALIZATION_FAILED',
+ 'SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED',
+ 'SOURCE_IMPORT_PARTIAL_FAILURE',
+ 'SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID',
+ 'SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED',
+ 'SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED',
+ 'SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED',
+ 'SOURCE_ONLINE_DOCUMENT_UNAVAILABLE',
+ 'SOURCE_ONLINE_DRIVE_CONFIG_INVALID',
+ 'SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED',
+ 'SOURCE_ONLINE_DRIVE_IMPORT_FAILED',
+ 'SOURCE_ONLINE_DRIVE_REQUEST_FAILED',
+ 'SOURCE_ONLINE_DRIVE_UNAVAILABLE',
+ 'SOURCE_OPERATION_FAILED',
+ 'SOURCE_PROVIDER_REJECTED',
+ 'SOURCE_PROVIDER_TIMEOUT',
+ 'SOURCE_PROVIDER_UNAVAILABLE',
+ 'SOURCE_SECRET_INTEGRITY_FAILED',
+ 'SOURCE_SECRET_REF_CONFLICT',
+ 'SOURCE_SYNC_FAILED',
+ 'SOURCE_SYNC_SELECTION_MISMATCH',
+ 'SOURCE_VERSION_CONFLICT',
+ 'SOURCE_WEBSITE_CRAWL_CONFIG_INVALID',
+ 'SOURCE_WEBSITE_CRAWL_FAILED',
+ 'SOURCE_WORKFLOW_CONTENT_MISSING',
+ 'SOURCE_WORKFLOW_CONTENT_TOO_LARGE',
+ 'SOURCE_WORKFLOW_EXTERNAL_TIMEOUT',
+ 'SOURCE_WORKFLOW_FAILED',
+ 'UPLOAD_INITIALIZATION_FAILED',
+ 'UPLOAD_INTEGRITY_MISMATCH',
+ 'VECTOR_SPACE_QUOTA_EXCEEDED',
+ 'VECTOR_SPACE_QUOTA_UNAVAILABLE',
+ ]),
+ message: z.string().min(1).max(1024),
+ parameters: z
+ .record(z.string(), z.union([z.string(), z.int(), z.number(), z.boolean()]))
+ .nullish(),
+ retryPolicy: z.enum(['after_configuration', 'automatic', 'manual', 'never']),
+ stage: z
+ .string()
+ .min(1)
+ .max(128)
+ .regex(/^[a-z][a-z0-9_.-]{0,127}$/)
+ .nullish(),
+ traceId: z
+ .string()
+ .min(1)
+ .max(128)
+ .regex(/^[A-Za-z0-9._:-]{1,128}$/)
+ .nullish(),
+ }))()
+
const zKnowledgeFsInvalidRequestError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_invalid_request'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(400),
}),
))()
@@ -22,6 +169,7 @@ const zKnowledgeFsAccessDeniedError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_access_denied'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(403),
}),
))()
@@ -30,6 +178,7 @@ const zKnowledgeFsRequestRejectedError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_request_rejected'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(422),
}),
))()
@@ -38,6 +187,7 @@ const zKnowledgeFsOperationUnavailableError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_operation_unavailable'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(503),
}),
))()
@@ -46,6 +196,7 @@ const zKnowledgeFsUpstreamUnavailableError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_upstream_unavailable'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(503),
}),
))()
@@ -54,6 +205,7 @@ const zKnowledgeFsConflictError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_conflict'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(409),
}),
))()
@@ -62,6 +214,7 @@ const zKnowledgeFsSpaceNotFoundError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_space_not_found'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(404),
}),
))()
@@ -70,6 +223,7 @@ const zKnowledgeFsResourceNotFoundError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_resource_not_found'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(404),
}),
))()
@@ -78,6 +232,7 @@ const zKnowledgeFsRequestTooLargeError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_request_too_large'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(413),
}),
))()
@@ -86,6 +241,7 @@ const zKnowledgeFsRateLimitExceededError = /* @__PURE__ */ (() =>
zErrorResponse.and(
z.object({
code: z.literal('knowledge_fs_rate_limit_exceeded'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
status: z.literal(429),
}),
))()
diff --git a/packages/contracts/generated/api/console/knowledge-fs/types.gen.ts b/packages/contracts/generated/api/console/knowledge-fs/types.gen.ts
index 1770bb97f2b..a2994773e47 100644
--- a/packages/contracts/generated/api/console/knowledge-fs/types.gen.ts
+++ b/packages/contracts/generated/api/console/knowledge-fs/types.gen.ts
@@ -36,26 +36,31 @@ export type KnowledgeFsAdmittedQueryRequest = {
export type KnowledgeFsInvalidRequestError = ErrorResponse & {
code: 'knowledge_fs_invalid_request'
+ details?: KnowledgeFsPublicFailureResponse
status: 400
}
export type KnowledgeFsAccessDeniedError = ErrorResponse & {
code: 'knowledge_fs_access_denied'
+ details?: KnowledgeFsPublicFailureResponse
status: 403
}
export type KnowledgeFsRequestRejectedError = ErrorResponse & {
code: 'knowledge_fs_request_rejected'
+ details?: KnowledgeFsPublicFailureResponse
status: 422
}
export type KnowledgeFsOperationUnavailableError = ErrorResponse & {
code: 'knowledge_fs_operation_unavailable'
+ details?: KnowledgeFsPublicFailureResponse
status: 503
}
export type KnowledgeFsUpstreamUnavailableError = ErrorResponse & {
code: 'knowledge_fs_upstream_unavailable'
+ details?: KnowledgeFsPublicFailureResponse
status: 503
}
@@ -144,11 +149,13 @@ export type KnowledgeFsSpaceCreateResponse = {
export type KnowledgeFsConflictError = ErrorResponse & {
code: 'knowledge_fs_conflict'
+ details?: KnowledgeFsPublicFailureResponse
status: 409
}
export type KnowledgeFsSpaceNotFoundError = ErrorResponse & {
code: 'knowledge_fs_space_not_found'
+ details?: KnowledgeFsPublicFailureResponse
status: 404
}
@@ -176,6 +183,7 @@ export type KnowledgeFsSpaceUpdatePayload = {
export type KnowledgeFsResourceNotFoundError = ErrorResponse & {
code: 'knowledge_fs_resource_not_found'
+ details?: KnowledgeFsPublicFailureResponse
status: 404
}
@@ -273,11 +281,13 @@ export type KnowledgeFsDocumentCreateAcceptedResponse =
export type KnowledgeFsRequestTooLargeError = ErrorResponse & {
code: 'knowledge_fs_request_too_large'
+ details?: KnowledgeFsPublicFailureResponse
status: 413
}
export type KnowledgeFsRateLimitExceededError = ErrorResponse & {
code: 'knowledge_fs_rate_limit_exceeded'
+ details?: KnowledgeFsPublicFailureResponse
status: 429
}
@@ -1392,6 +1402,137 @@ export type KnowledgeFsQueryImageReference = {
uploadFileId: string
}
+export type KnowledgeFsPublicFailureResponse = {
+ action?:
+ | 'configure_model'
+ | 'configure_parser'
+ | 'configure_source'
+ | 'contact_admin'
+ | 'retry'
+ | 'reupload'
+ | null
+ category:
+ | 'authorization'
+ | 'canceled'
+ | 'configuration'
+ | 'conflict'
+ | 'dependency'
+ | 'internal'
+ | 'not_found'
+ | 'rate_limit'
+ | 'timeout'
+ | 'validation'
+ code:
+ | 'DOCUMENT_COMPILATION_FAILED'
+ | 'DOCUMENT_COMPILATION_LEASE_LOST'
+ | 'DOCUMENT_COMPILATION_PROFILE_CHANGED'
+ | 'DOCUMENT_COMPILATION_RETRYABLE'
+ | 'DOCUMENT_COUNT_QUOTA_EXCEEDED'
+ | 'DOCUMENT_COUNT_QUOTA_UNAVAILABLE'
+ | 'DOCUMENT_DISABLED'
+ | 'DOCUMENT_PARSER_INPUT_INVALID'
+ | 'DOCUMENT_PARSER_NOT_CONFIGURED'
+ | 'DOCUMENT_PARSER_RATE_LIMITED'
+ | 'DOCUMENT_PARSER_RESPONSE_INVALID'
+ | 'DOCUMENT_PARSER_TIMEOUT'
+ | 'DOCUMENT_PARSER_UNAVAILABLE'
+ | 'DOCUMENT_PARSER_UNSUPPORTED_TYPE'
+ | 'DOCUMENT_PDF_RENDER_FAILED'
+ | 'DURABLE_DELETION_IDEMPOTENCY_CONFLICT'
+ | 'EMBEDDING_DIMENSION_INVALID'
+ | 'EMBEDDING_DIMENSION_UNSUPPORTED'
+ | 'EXECUTION_ATTEMPTS_EXHAUSTED'
+ | 'KNOWLEDGE_FS_ACCESS_DENIED'
+ | 'KNOWLEDGE_FS_CONFLICT'
+ | 'KNOWLEDGE_FS_INTERNAL_ERROR'
+ | 'KNOWLEDGE_FS_INVALID_REQUEST'
+ | 'KNOWLEDGE_FS_NOT_FOUND'
+ | 'KNOWLEDGE_FS_RATE_LIMITED'
+ | 'KNOWLEDGE_FS_TIMEOUT'
+ | 'KNOWLEDGE_FS_UNAVAILABLE'
+ | 'KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND'
+ | 'KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED'
+ | 'KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS'
+ | 'KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED'
+ | 'KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT'
+ | 'LOGICAL_DOCUMENT_CAS_CONFLICT'
+ | 'MODEL_CAPABILITY_MISMATCH'
+ | 'MODEL_CONFIGURATION_STALE'
+ | 'MODEL_CREDENTIAL_INVALID'
+ | 'MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE'
+ | 'MODEL_IDENTITY_MISMATCH'
+ | 'MODEL_PREFLIGHT_CANCELED'
+ | 'MODEL_PREFLIGHT_FAILED'
+ | 'MODEL_PREFLIGHT_TIMEOUT'
+ | 'MODEL_PREFLIGHT_UNAVAILABLE'
+ | 'MODEL_PROFILE_ACTIVATION_INCOMPLETE'
+ | 'MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED'
+ | 'MODEL_RUNTIME_CONTEXT_LIMIT'
+ | 'MODEL_RUNTIME_FAILED'
+ | 'MODEL_RUNTIME_OUTPUT_LIMIT'
+ | 'MODEL_RUNTIME_RESPONSE_INVALID'
+ | 'MODEL_RUNTIME_TIMEOUT'
+ | 'MODEL_RUNTIME_UNAVAILABLE'
+ | 'MODEL_SELECTION_NOT_FOUND'
+ | 'RESEARCH_TASK_CAPABILITY_REVOKED'
+ | 'RESEARCH_TASK_DISPATCH_DEAD'
+ | 'RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED'
+ | 'RESEARCH_TASK_FAILED'
+ | 'RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID'
+ | 'RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID'
+ | 'RETRIEVAL_DELETION_IN_PROGRESS'
+ | 'RETRIEVAL_EXECUTION_LEASE_LOST'
+ | 'SOURCE_BULK_ACTION_FAILED'
+ | 'SOURCE_CONNECTION_UNAVAILABLE'
+ | 'SOURCE_CRAWL_PAGE_NOT_FOUND'
+ | 'SOURCE_CRAWL_PROVIDER_UNAVAILABLE'
+ | 'SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED'
+ | 'SOURCE_CREDENTIAL_CONFIG_INVALID'
+ | 'SOURCE_CREDENTIAL_MUTATION_FAILED'
+ | 'SOURCE_CREDENTIAL_TEST_FAILED'
+ | 'SOURCE_CREDENTIAL_UNAVAILABLE'
+ | 'SOURCE_DOCUMENT_COMPILATION_FAILED'
+ | 'SOURCE_DOCUMENT_MATERIALIZATION_FAILED'
+ | 'SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED'
+ | 'SOURCE_IMPORT_PARTIAL_FAILURE'
+ | 'SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID'
+ | 'SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED'
+ | 'SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED'
+ | 'SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED'
+ | 'SOURCE_ONLINE_DOCUMENT_UNAVAILABLE'
+ | 'SOURCE_ONLINE_DRIVE_CONFIG_INVALID'
+ | 'SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED'
+ | 'SOURCE_ONLINE_DRIVE_IMPORT_FAILED'
+ | 'SOURCE_ONLINE_DRIVE_REQUEST_FAILED'
+ | 'SOURCE_ONLINE_DRIVE_UNAVAILABLE'
+ | 'SOURCE_OPERATION_FAILED'
+ | 'SOURCE_PROVIDER_REJECTED'
+ | 'SOURCE_PROVIDER_TIMEOUT'
+ | 'SOURCE_PROVIDER_UNAVAILABLE'
+ | 'SOURCE_SECRET_INTEGRITY_FAILED'
+ | 'SOURCE_SECRET_REF_CONFLICT'
+ | 'SOURCE_SYNC_FAILED'
+ | 'SOURCE_SYNC_SELECTION_MISMATCH'
+ | 'SOURCE_VERSION_CONFLICT'
+ | 'SOURCE_WEBSITE_CRAWL_CONFIG_INVALID'
+ | 'SOURCE_WEBSITE_CRAWL_FAILED'
+ | 'SOURCE_WORKFLOW_CONTENT_MISSING'
+ | 'SOURCE_WORKFLOW_CONTENT_TOO_LARGE'
+ | 'SOURCE_WORKFLOW_EXTERNAL_TIMEOUT'
+ | 'SOURCE_WORKFLOW_FAILED'
+ | 'UPLOAD_INITIALIZATION_FAILED'
+ | 'UPLOAD_INTEGRITY_MISMATCH'
+ | 'VECTOR_SPACE_QUOTA_EXCEEDED'
+ | 'VECTOR_SPACE_QUOTA_UNAVAILABLE'
+ message: string
+ parameters?: {
+ [key: string]: string | number | number | boolean
+ } | null
+ retryPolicy: 'after_configuration' | 'automatic' | 'manual' | 'never'
+ stage?: string | null
+ traceId?: string | null
+}
+
export type JsonValue = unknown
export type KnowledgeFsInitialSourcePreviewDocumentResponse = {
@@ -1546,137 +1687,6 @@ export type KnowledgeFsAppSpaceJoinType = 'agent' | 'workflow'
export type KnowledgeFsAppSpaceJoinStatus = 'active' | 'revoked'
-export type KnowledgeFsPublicFailureResponse = {
- action?:
- | 'configure_model'
- | 'configure_parser'
- | 'configure_source'
- | 'contact_admin'
- | 'retry'
- | 'reupload'
- | null
- category:
- | 'authorization'
- | 'canceled'
- | 'configuration'
- | 'conflict'
- | 'dependency'
- | 'internal'
- | 'not_found'
- | 'rate_limit'
- | 'timeout'
- | 'validation'
- code:
- | 'DOCUMENT_COMPILATION_FAILED'
- | 'DOCUMENT_COMPILATION_LEASE_LOST'
- | 'DOCUMENT_COMPILATION_PROFILE_CHANGED'
- | 'DOCUMENT_COMPILATION_RETRYABLE'
- | 'DOCUMENT_COUNT_QUOTA_EXCEEDED'
- | 'DOCUMENT_COUNT_QUOTA_UNAVAILABLE'
- | 'DOCUMENT_DISABLED'
- | 'DOCUMENT_PARSER_INPUT_INVALID'
- | 'DOCUMENT_PARSER_NOT_CONFIGURED'
- | 'DOCUMENT_PARSER_RATE_LIMITED'
- | 'DOCUMENT_PARSER_RESPONSE_INVALID'
- | 'DOCUMENT_PARSER_TIMEOUT'
- | 'DOCUMENT_PARSER_UNAVAILABLE'
- | 'DOCUMENT_PARSER_UNSUPPORTED_TYPE'
- | 'DOCUMENT_PDF_RENDER_FAILED'
- | 'DURABLE_DELETION_IDEMPOTENCY_CONFLICT'
- | 'EMBEDDING_DIMENSION_INVALID'
- | 'EMBEDDING_DIMENSION_UNSUPPORTED'
- | 'EXECUTION_ATTEMPTS_EXHAUSTED'
- | 'KNOWLEDGE_FS_ACCESS_DENIED'
- | 'KNOWLEDGE_FS_CONFLICT'
- | 'KNOWLEDGE_FS_INTERNAL_ERROR'
- | 'KNOWLEDGE_FS_INVALID_REQUEST'
- | 'KNOWLEDGE_FS_NOT_FOUND'
- | 'KNOWLEDGE_FS_RATE_LIMITED'
- | 'KNOWLEDGE_FS_TIMEOUT'
- | 'KNOWLEDGE_FS_UNAVAILABLE'
- | 'KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND'
- | 'KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED'
- | 'KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS'
- | 'KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED'
- | 'KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT'
- | 'LOGICAL_DOCUMENT_CAS_CONFLICT'
- | 'MODEL_CAPABILITY_MISMATCH'
- | 'MODEL_CONFIGURATION_STALE'
- | 'MODEL_CREDENTIAL_INVALID'
- | 'MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE'
- | 'MODEL_IDENTITY_MISMATCH'
- | 'MODEL_PREFLIGHT_CANCELED'
- | 'MODEL_PREFLIGHT_FAILED'
- | 'MODEL_PREFLIGHT_TIMEOUT'
- | 'MODEL_PREFLIGHT_UNAVAILABLE'
- | 'MODEL_PROFILE_ACTIVATION_INCOMPLETE'
- | 'MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED'
- | 'MODEL_RUNTIME_CONTEXT_LIMIT'
- | 'MODEL_RUNTIME_FAILED'
- | 'MODEL_RUNTIME_OUTPUT_LIMIT'
- | 'MODEL_RUNTIME_RESPONSE_INVALID'
- | 'MODEL_RUNTIME_TIMEOUT'
- | 'MODEL_RUNTIME_UNAVAILABLE'
- | 'MODEL_SELECTION_NOT_FOUND'
- | 'RESEARCH_TASK_CAPABILITY_REVOKED'
- | 'RESEARCH_TASK_DISPATCH_DEAD'
- | 'RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED'
- | 'RESEARCH_TASK_FAILED'
- | 'RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID'
- | 'RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID'
- | 'RETRIEVAL_DELETION_IN_PROGRESS'
- | 'RETRIEVAL_EXECUTION_LEASE_LOST'
- | 'SOURCE_BULK_ACTION_FAILED'
- | 'SOURCE_CONNECTION_UNAVAILABLE'
- | 'SOURCE_CRAWL_PAGE_NOT_FOUND'
- | 'SOURCE_CRAWL_PROVIDER_UNAVAILABLE'
- | 'SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED'
- | 'SOURCE_CREDENTIAL_CONFIG_INVALID'
- | 'SOURCE_CREDENTIAL_MUTATION_FAILED'
- | 'SOURCE_CREDENTIAL_TEST_FAILED'
- | 'SOURCE_CREDENTIAL_UNAVAILABLE'
- | 'SOURCE_DOCUMENT_COMPILATION_FAILED'
- | 'SOURCE_DOCUMENT_MATERIALIZATION_FAILED'
- | 'SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED'
- | 'SOURCE_IMPORT_PARTIAL_FAILURE'
- | 'SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID'
- | 'SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED'
- | 'SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED'
- | 'SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED'
- | 'SOURCE_ONLINE_DOCUMENT_UNAVAILABLE'
- | 'SOURCE_ONLINE_DRIVE_CONFIG_INVALID'
- | 'SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED'
- | 'SOURCE_ONLINE_DRIVE_IMPORT_FAILED'
- | 'SOURCE_ONLINE_DRIVE_REQUEST_FAILED'
- | 'SOURCE_ONLINE_DRIVE_UNAVAILABLE'
- | 'SOURCE_OPERATION_FAILED'
- | 'SOURCE_PROVIDER_REJECTED'
- | 'SOURCE_PROVIDER_TIMEOUT'
- | 'SOURCE_PROVIDER_UNAVAILABLE'
- | 'SOURCE_SECRET_INTEGRITY_FAILED'
- | 'SOURCE_SECRET_REF_CONFLICT'
- | 'SOURCE_SYNC_FAILED'
- | 'SOURCE_SYNC_SELECTION_MISMATCH'
- | 'SOURCE_VERSION_CONFLICT'
- | 'SOURCE_WEBSITE_CRAWL_CONFIG_INVALID'
- | 'SOURCE_WEBSITE_CRAWL_FAILED'
- | 'SOURCE_WORKFLOW_CONTENT_MISSING'
- | 'SOURCE_WORKFLOW_CONTENT_TOO_LARGE'
- | 'SOURCE_WORKFLOW_EXTERNAL_TIMEOUT'
- | 'SOURCE_WORKFLOW_FAILED'
- | 'UPLOAD_INITIALIZATION_FAILED'
- | 'UPLOAD_INTEGRITY_MISMATCH'
- | 'VECTOR_SPACE_QUOTA_EXCEEDED'
- | 'VECTOR_SPACE_QUOTA_UNAVAILABLE'
- message: string
- parameters?: {
- [key: string]: string | number | number | boolean
- } | null
- retryPolicy: 'after_configuration' | 'automatic' | 'manual' | 'never'
- stage?: string | null
- traceId?: string | null
-}
-
export type KnowledgeFsBackgroundTaskFailureResponse = {
document_id: string
document_title?: string | null
diff --git a/packages/contracts/generated/api/console/knowledge-fs/zod.gen.ts b/packages/contracts/generated/api/console/knowledge-fs/zod.gen.ts
index d403817f88b..f34d1bfce4b 100644
--- a/packages/contracts/generated/api/console/knowledge-fs/zod.gen.ts
+++ b/packages/contracts/generated/api/console/knowledge-fs/zod.gen.ts
@@ -27,66 +27,6 @@ export const zKnowledgeFsFeaturesResponse = z.object({
upload_enabled: z.boolean(),
})
-/**
- * KnowledgeFsInvalidRequestError
- *
- * Agent Knowledge Base request is invalid.
- */
-export const zKnowledgeFsInvalidRequestError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_invalid_request'),
- status: z.literal(400),
- }),
-)
-
-/**
- * KnowledgeFsAccessDeniedError
- *
- * Agent Knowledge Base operation is not allowed.
- */
-export const zKnowledgeFsAccessDeniedError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_access_denied'),
- status: z.literal(403),
- }),
-)
-
-/**
- * KnowledgeFsRequestRejectedError
- *
- * Agent Knowledge Base request was rejected.
- */
-export const zKnowledgeFsRequestRejectedError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_request_rejected'),
- status: z.literal(422),
- }),
-)
-
-/**
- * KnowledgeFsOperationUnavailableError
- *
- * Agent Knowledge Base operation is not available.
- */
-export const zKnowledgeFsOperationUnavailableError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_operation_unavailable'),
- status: z.literal(503),
- }),
-)
-
-/**
- * KnowledgeFsUpstreamUnavailableError
- *
- * Agent Knowledge Base is unavailable.
- */
-export const zKnowledgeFsUpstreamUnavailableError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_upstream_unavailable'),
- status: z.literal(503),
- }),
-)
-
/**
* KnowledgeFSInitialSourcePreviewJobCreateResponse
*/
@@ -95,42 +35,6 @@ export const zKnowledgeFsInitialSourcePreviewJobCreateResponse = z.object({
status: z.literal('pending').optional().default('pending'),
})
-/**
- * KnowledgeFsConflictError
- *
- * Agent Knowledge Base operation conflicts with the current resource state.
- */
-export const zKnowledgeFsConflictError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_conflict'),
- status: z.literal(409),
- }),
-)
-
-/**
- * KnowledgeFsSpaceNotFoundError
- *
- * Agent Knowledge Base was not found.
- */
-export const zKnowledgeFsSpaceNotFoundError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_space_not_found'),
- status: z.literal(404),
- }),
-)
-
-/**
- * KnowledgeFsResourceNotFoundError
- *
- * Agent Knowledge Base resource was not found.
- */
-export const zKnowledgeFsResourceNotFoundError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_resource_not_found'),
- status: z.literal(404),
- }),
-)
-
/**
* KnowledgeFSResolvedDocumentReferenceResponse
*/
@@ -146,30 +50,6 @@ export const zKnowledgeFsDocumentStagedUploadPayload = z.object({
upload_id: z.string().min(1).max(255),
})
-/**
- * KnowledgeFsRequestTooLargeError
- *
- * Agent Knowledge Base request is too large.
- */
-export const zKnowledgeFsRequestTooLargeError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_request_too_large'),
- status: z.literal(413),
- }),
-)
-
-/**
- * KnowledgeFsRateLimitExceededError
- *
- * Agent Knowledge Base request rate limit exceeded.
- */
-export const zKnowledgeFsRateLimitExceededError = zErrorResponse.and(
- z.object({
- code: z.literal('knowledge_fs_rate_limit_exceeded'),
- status: z.literal(429),
- }),
-)
-
/**
* KnowledgeFSDocumentReindexPayload
*/
@@ -746,263 +626,19 @@ export const zKnowledgeFsResearchTaskPlanPayload = z.object({
topK: z.int().gte(1).lte(50).nullish(),
})
-export const zJsonValue = z.unknown()
-
-/**
- * KnowledgeFSInitialSourcePreviewPayload
- */
-export const zKnowledgeFsInitialSourcePreviewPayload = z.object({
- credentialId: z.string().min(1).max(255),
- datasource: z.string().min(1).max(255),
- kind: z.enum(['online_document', 'online_drive']),
- parameters: z.record(z.string(), zJsonValue).optional(),
- pluginId: z.string().min(1).max(255),
- provider: z.string().min(1).max(255),
- providerDisplayName: z.string().min(1).max(255).nullish(),
-})
-
-/**
- * KnowledgeFSInitialWebsiteSourcePreviewPayload
- */
-export const zKnowledgeFsInitialWebsiteSourcePreviewPayload = z.object({
- credentialId: z.string().min(1).max(255),
- datasource: z.string().min(1).max(255),
- kind: z.literal('website_crawl'),
- parameters: z.record(z.string(), zJsonValue).optional(),
- pluginId: z.string().min(1).max(255),
- provider: z.string().min(1).max(255),
- providerDisplayName: z.string().min(1).max(255).nullish(),
-})
-
-/**
- * KnowledgeFSInitialSourcePreviewDocumentResponse
- */
-export const zKnowledgeFsInitialSourcePreviewDocumentResponse = z.object({
- last_edited_time: z.string().nullish(),
- name: z.string(),
- page_id: z.string(),
- provider_item_id: z.string(),
- type: z.string(),
- workspace_id: z.string(),
- workspace_name: z.string().nullish(),
-})
-
-/**
- * KnowledgeFSInitialSourcePreviewFileResponse
- */
-export const zKnowledgeFsInitialSourcePreviewFileResponse = z.object({
- bucket: z.string().nullish(),
- id: z.string(),
- mime_type: z.string().nullish(),
- name: z.string(),
- provider_item_id: z.string(),
- size: z.int().gte(0),
- type: z.string(),
-})
-
-/**
- * KnowledgeFSInitialSourcePreviewPageResponse
- */
-export const zKnowledgeFsInitialSourcePreviewPageResponse = z.object({
- description: z.string().nullish(),
- page_id: z.string().nullish(),
- source_url: z.string(),
- title: z.string().nullish(),
-})
-
-/**
- * KnowledgeFSInitialSourcePreviewResponse
- */
-export const zKnowledgeFsInitialSourcePreviewResponse = z.object({
- configuration_fingerprint: z.string().nullish(),
- documents: z.array(zKnowledgeFsInitialSourcePreviewDocumentResponse).optional(),
- files: z.array(zKnowledgeFsInitialSourcePreviewFileResponse).optional(),
- kind: z.enum(['online_document', 'online_drive', 'website_crawl']),
- next_page_parameters: z.record(z.string(), zJsonValue).nullish(),
- pages: z.array(zKnowledgeFsInitialSourcePreviewPageResponse).optional(),
-})
-
-/**
- * KnowledgeFSInitialSourcePreviewJobResponse
- */
-export const zKnowledgeFsInitialSourcePreviewJobResponse = z.object({
- job_id: z.string(),
- result: zKnowledgeFsInitialSourcePreviewResponse.nullish(),
- status: z.enum(['canceled', 'completed', 'failed', 'pending', 'running']),
-})
-
-/**
- * KnowledgeFSModelIntent
- */
-export const zKnowledgeFsModelIntent = z.object({
- model: z.string().min(1).max(255),
- plugin_id: z.string().min(1).max(255),
- provider: z.string().min(1).max(255),
-})
-
-/**
- * KnowledgeFSSpaceCreateMemberPayload
- */
-export const zKnowledgeFsSpaceCreateMemberPayload = z.object({
- account_id: z.string().min(1).max(255),
- role: z.literal('viewer'),
-})
-
-/**
- * KnowledgeFSControlSpaceVisibility
- */
-export const zKnowledgeFsControlSpaceVisibility = z.enum([
- 'all_team_members',
- 'only_me',
- 'partial_members',
-])
-
/**
- * KnowledgeFSSpaceUpdatePayload
+ * KnowledgeFSPublicFailureResponse
*/
-export const zKnowledgeFsSpaceUpdatePayload = z.object({
- description: z.string().max(2000).nullish(),
- icon: z
- .string()
- .max(72)
- .regex(/^(?:builtin:)?[+a-z0-9_-]{1,64}$/)
- .nullish(),
- icon_background: z
- .string()
- .regex(/^#[0-9A-Fa-f]{6}$/)
- .nullish(),
- name: z.string().min(1).max(40).nullish(),
- visibility: zKnowledgeFsControlSpaceVisibility.nullish(),
-})
-
-/**
- * KnowledgeFSControlSpaceState
- */
-export const zKnowledgeFsControlSpaceState = z.enum([
- 'active',
- 'deleted',
- 'deleting',
- 'error',
- 'provisioning',
-])
-
-/**
- * KnowledgeFSSpaceCreateResponse
- */
-export const zKnowledgeFsSpaceCreateResponse = z.object({
- control_space_id: z.string(),
- model_setup_required: z.boolean(),
- operation_id: z.string(),
- state: zKnowledgeFsControlSpaceState,
-})
-
-/**
- * KnowledgeFSProductPermission
- *
- * Product-level capability of a caller on one Agent Knowledge Base.
- *
- * These values are what the console returns as ``permission_keys`` so the web can gate
- * its UI. Enterprise RBAC is not evaluated in this vocabulary: Agent Knowledge Bases reuse
- * the Classic Knowledge Base (``dataset_*``) permission points, and each capability is
- * granted when the caller holds the dataset permission it maps to (see
- * :data:`RBAC_PERMISSION_BY_PRODUCT_PERMISSION`).
- */
-export const zKnowledgeFsProductPermission = z.enum([
- 'knowledge_space_access_config',
- 'knowledge_space_create',
- 'knowledge_space_delete',
- 'knowledge_space_document_write',
- 'knowledge_space_edit',
- 'knowledge_space_query',
- 'knowledge_space_read',
-])
-
-/**
- * KnowledgeFSTechnicalSummary
- */
-export const zKnowledgeFsTechnicalSummary = z.object({
- description: z.string().nullish(),
- document_count: z.int().gte(0).optional().default(0),
- icon: z.string().nullish(),
- icon_background: z
- .string()
- .regex(/^#[0-9A-Fa-f]{6}$/)
- .nullish(),
- index_state: z.string().nullish(),
- knowledge_space_id: z.string(),
- last_job_state: z.string().nullish(),
- model_profile: z.record(z.string(), z.unknown()).nullish(),
- name: z.string(),
- revision: z.int().gte(0),
- slug: z.string(),
-})
-
-/**
- * KnowledgeFSSpaceDetailResponse
- */
-export const zKnowledgeFsSpaceDetailResponse = z.object({
- control_space_id: z.string(),
- created_at: z.iso.datetime(),
- knowledge_space_id: z.string().nullable(),
- owner_account_id: z.string(),
- permission_keys: z.array(zKnowledgeFsProductPermission),
- resource_version: z.int(),
- state: zKnowledgeFsControlSpaceState,
- technical_status: z.enum(['available', 'not_ready', 'unavailable']),
- technical_summary: zKnowledgeFsTechnicalSummary.nullish(),
- updated_at: z.iso.datetime(),
- visibility: zKnowledgeFsControlSpaceVisibility,
-})
-
-/**
- * KnowledgeFSAppSpaceJoinType
- */
-export const zKnowledgeFsAppSpaceJoinType = z.enum(['agent', 'workflow'])
-
-/**
- * KnowledgeFSAppBindingPayload
- */
-export const zKnowledgeFsAppBindingPayload = z.object({
- app_id: z.string().min(1),
- caller_kind: zKnowledgeFsAppSpaceJoinType,
-})
-
-/**
- * KnowledgeFSAppSpaceJoinStatus
- */
-export const zKnowledgeFsAppSpaceJoinStatus = z.enum(['active', 'revoked'])
-
-/**
- * KnowledgeFSAppBindingResponse
- */
-export const zKnowledgeFsAppBindingResponse = z.object({
- app_id: z.string(),
- caller_kind: zKnowledgeFsAppSpaceJoinType,
- id: z.string(),
- revision: z.int(),
- status: zKnowledgeFsAppSpaceJoinStatus,
-})
-
-/**
- * KnowledgeFSAppBindingListResponse
- */
-export const zKnowledgeFsAppBindingListResponse = z.object({
- data: z.array(zKnowledgeFsAppBindingResponse),
-})
-
-/**
- * KnowledgeFSPublicFailureResponse
- */
-export const zKnowledgeFsPublicFailureResponse = z.object({
- action: z
- .enum([
- 'configure_model',
- 'configure_parser',
- 'configure_source',
- 'contact_admin',
- 'retry',
- 'reupload',
- ])
+export const zKnowledgeFsPublicFailureResponse = z.object({
+ action: z
+ .enum([
+ 'configure_model',
+ 'configure_parser',
+ 'configure_source',
+ 'contact_admin',
+ 'retry',
+ 'reupload',
+ ])
.nullish(),
category: z.enum([
'authorization',
@@ -1138,6 +774,136 @@ export const zKnowledgeFsPublicFailureResponse = z.object({
.nullish(),
})
+/**
+ * KnowledgeFsInvalidRequestError
+ *
+ * Agent Knowledge Base request is invalid.
+ */
+export const zKnowledgeFsInvalidRequestError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_invalid_request'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(400),
+ }),
+)
+
+/**
+ * KnowledgeFsAccessDeniedError
+ *
+ * Agent Knowledge Base operation is not allowed.
+ */
+export const zKnowledgeFsAccessDeniedError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_access_denied'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(403),
+ }),
+)
+
+/**
+ * KnowledgeFsRequestRejectedError
+ *
+ * Agent Knowledge Base request was rejected.
+ */
+export const zKnowledgeFsRequestRejectedError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_request_rejected'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(422),
+ }),
+)
+
+/**
+ * KnowledgeFsOperationUnavailableError
+ *
+ * Agent Knowledge Base operation is not available.
+ */
+export const zKnowledgeFsOperationUnavailableError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_operation_unavailable'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(503),
+ }),
+)
+
+/**
+ * KnowledgeFsUpstreamUnavailableError
+ *
+ * Agent Knowledge Base is unavailable.
+ */
+export const zKnowledgeFsUpstreamUnavailableError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_upstream_unavailable'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(503),
+ }),
+)
+
+/**
+ * KnowledgeFsConflictError
+ *
+ * Agent Knowledge Base operation conflicts with the current resource state.
+ */
+export const zKnowledgeFsConflictError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_conflict'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(409),
+ }),
+)
+
+/**
+ * KnowledgeFsSpaceNotFoundError
+ *
+ * Agent Knowledge Base was not found.
+ */
+export const zKnowledgeFsSpaceNotFoundError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_space_not_found'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(404),
+ }),
+)
+
+/**
+ * KnowledgeFsResourceNotFoundError
+ *
+ * Agent Knowledge Base resource was not found.
+ */
+export const zKnowledgeFsResourceNotFoundError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_resource_not_found'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(404),
+ }),
+)
+
+/**
+ * KnowledgeFsRequestTooLargeError
+ *
+ * Agent Knowledge Base request is too large.
+ */
+export const zKnowledgeFsRequestTooLargeError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_request_too_large'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(413),
+ }),
+)
+
+/**
+ * KnowledgeFsRateLimitExceededError
+ *
+ * Agent Knowledge Base request rate limit exceeded.
+ */
+export const zKnowledgeFsRateLimitExceededError = zErrorResponse.and(
+ z.object({
+ code: z.literal('knowledge_fs_rate_limit_exceeded'),
+ details: zKnowledgeFsPublicFailureResponse.optional(),
+ status: z.literal(429),
+ }),
+)
+
/**
* KnowledgeFSDocumentCompilationJobResponse
*/
@@ -1443,6 +1209,250 @@ export const zKnowledgeFsSourceCredentialTestResponse = z.object({
valid: z.boolean(),
})
+export const zJsonValue = z.unknown()
+
+/**
+ * KnowledgeFSInitialSourcePreviewPayload
+ */
+export const zKnowledgeFsInitialSourcePreviewPayload = z.object({
+ credentialId: z.string().min(1).max(255),
+ datasource: z.string().min(1).max(255),
+ kind: z.enum(['online_document', 'online_drive']),
+ parameters: z.record(z.string(), zJsonValue).optional(),
+ pluginId: z.string().min(1).max(255),
+ provider: z.string().min(1).max(255),
+ providerDisplayName: z.string().min(1).max(255).nullish(),
+})
+
+/**
+ * KnowledgeFSInitialWebsiteSourcePreviewPayload
+ */
+export const zKnowledgeFsInitialWebsiteSourcePreviewPayload = z.object({
+ credentialId: z.string().min(1).max(255),
+ datasource: z.string().min(1).max(255),
+ kind: z.literal('website_crawl'),
+ parameters: z.record(z.string(), zJsonValue).optional(),
+ pluginId: z.string().min(1).max(255),
+ provider: z.string().min(1).max(255),
+ providerDisplayName: z.string().min(1).max(255).nullish(),
+})
+
+/**
+ * KnowledgeFSInitialSourcePreviewDocumentResponse
+ */
+export const zKnowledgeFsInitialSourcePreviewDocumentResponse = z.object({
+ last_edited_time: z.string().nullish(),
+ name: z.string(),
+ page_id: z.string(),
+ provider_item_id: z.string(),
+ type: z.string(),
+ workspace_id: z.string(),
+ workspace_name: z.string().nullish(),
+})
+
+/**
+ * KnowledgeFSInitialSourcePreviewFileResponse
+ */
+export const zKnowledgeFsInitialSourcePreviewFileResponse = z.object({
+ bucket: z.string().nullish(),
+ id: z.string(),
+ mime_type: z.string().nullish(),
+ name: z.string(),
+ provider_item_id: z.string(),
+ size: z.int().gte(0),
+ type: z.string(),
+})
+
+/**
+ * KnowledgeFSInitialSourcePreviewPageResponse
+ */
+export const zKnowledgeFsInitialSourcePreviewPageResponse = z.object({
+ description: z.string().nullish(),
+ page_id: z.string().nullish(),
+ source_url: z.string(),
+ title: z.string().nullish(),
+})
+
+/**
+ * KnowledgeFSInitialSourcePreviewResponse
+ */
+export const zKnowledgeFsInitialSourcePreviewResponse = z.object({
+ configuration_fingerprint: z.string().nullish(),
+ documents: z.array(zKnowledgeFsInitialSourcePreviewDocumentResponse).optional(),
+ files: z.array(zKnowledgeFsInitialSourcePreviewFileResponse).optional(),
+ kind: z.enum(['online_document', 'online_drive', 'website_crawl']),
+ next_page_parameters: z.record(z.string(), zJsonValue).nullish(),
+ pages: z.array(zKnowledgeFsInitialSourcePreviewPageResponse).optional(),
+})
+
+/**
+ * KnowledgeFSInitialSourcePreviewJobResponse
+ */
+export const zKnowledgeFsInitialSourcePreviewJobResponse = z.object({
+ job_id: z.string(),
+ result: zKnowledgeFsInitialSourcePreviewResponse.nullish(),
+ status: z.enum(['canceled', 'completed', 'failed', 'pending', 'running']),
+})
+
+/**
+ * KnowledgeFSModelIntent
+ */
+export const zKnowledgeFsModelIntent = z.object({
+ model: z.string().min(1).max(255),
+ plugin_id: z.string().min(1).max(255),
+ provider: z.string().min(1).max(255),
+})
+
+/**
+ * KnowledgeFSSpaceCreateMemberPayload
+ */
+export const zKnowledgeFsSpaceCreateMemberPayload = z.object({
+ account_id: z.string().min(1).max(255),
+ role: z.literal('viewer'),
+})
+
+/**
+ * KnowledgeFSControlSpaceVisibility
+ */
+export const zKnowledgeFsControlSpaceVisibility = z.enum([
+ 'all_team_members',
+ 'only_me',
+ 'partial_members',
+])
+
+/**
+ * KnowledgeFSSpaceUpdatePayload
+ */
+export const zKnowledgeFsSpaceUpdatePayload = z.object({
+ description: z.string().max(2000).nullish(),
+ icon: z
+ .string()
+ .max(72)
+ .regex(/^(?:builtin:)?[+a-z0-9_-]{1,64}$/)
+ .nullish(),
+ icon_background: z
+ .string()
+ .regex(/^#[0-9A-Fa-f]{6}$/)
+ .nullish(),
+ name: z.string().min(1).max(40).nullish(),
+ visibility: zKnowledgeFsControlSpaceVisibility.nullish(),
+})
+
+/**
+ * KnowledgeFSControlSpaceState
+ */
+export const zKnowledgeFsControlSpaceState = z.enum([
+ 'active',
+ 'deleted',
+ 'deleting',
+ 'error',
+ 'provisioning',
+])
+
+/**
+ * KnowledgeFSSpaceCreateResponse
+ */
+export const zKnowledgeFsSpaceCreateResponse = z.object({
+ control_space_id: z.string(),
+ model_setup_required: z.boolean(),
+ operation_id: z.string(),
+ state: zKnowledgeFsControlSpaceState,
+})
+
+/**
+ * KnowledgeFSProductPermission
+ *
+ * Product-level capability of a caller on one Agent Knowledge Base.
+ *
+ * These values are what the console returns as ``permission_keys`` so the web can gate
+ * its UI. Enterprise RBAC is not evaluated in this vocabulary: Agent Knowledge Bases reuse
+ * the Classic Knowledge Base (``dataset_*``) permission points, and each capability is
+ * granted when the caller holds the dataset permission it maps to (see
+ * :data:`RBAC_PERMISSION_BY_PRODUCT_PERMISSION`).
+ */
+export const zKnowledgeFsProductPermission = z.enum([
+ 'knowledge_space_access_config',
+ 'knowledge_space_create',
+ 'knowledge_space_delete',
+ 'knowledge_space_document_write',
+ 'knowledge_space_edit',
+ 'knowledge_space_query',
+ 'knowledge_space_read',
+])
+
+/**
+ * KnowledgeFSTechnicalSummary
+ */
+export const zKnowledgeFsTechnicalSummary = z.object({
+ description: z.string().nullish(),
+ document_count: z.int().gte(0).optional().default(0),
+ icon: z.string().nullish(),
+ icon_background: z
+ .string()
+ .regex(/^#[0-9A-Fa-f]{6}$/)
+ .nullish(),
+ index_state: z.string().nullish(),
+ knowledge_space_id: z.string(),
+ last_job_state: z.string().nullish(),
+ model_profile: z.record(z.string(), z.unknown()).nullish(),
+ name: z.string(),
+ revision: z.int().gte(0),
+ slug: z.string(),
+})
+
+/**
+ * KnowledgeFSSpaceDetailResponse
+ */
+export const zKnowledgeFsSpaceDetailResponse = z.object({
+ control_space_id: z.string(),
+ created_at: z.iso.datetime(),
+ knowledge_space_id: z.string().nullable(),
+ owner_account_id: z.string(),
+ permission_keys: z.array(zKnowledgeFsProductPermission),
+ resource_version: z.int(),
+ state: zKnowledgeFsControlSpaceState,
+ technical_status: z.enum(['available', 'not_ready', 'unavailable']),
+ technical_summary: zKnowledgeFsTechnicalSummary.nullish(),
+ updated_at: z.iso.datetime(),
+ visibility: zKnowledgeFsControlSpaceVisibility,
+})
+
+/**
+ * KnowledgeFSAppSpaceJoinType
+ */
+export const zKnowledgeFsAppSpaceJoinType = z.enum(['agent', 'workflow'])
+
+/**
+ * KnowledgeFSAppBindingPayload
+ */
+export const zKnowledgeFsAppBindingPayload = z.object({
+ app_id: z.string().min(1),
+ caller_kind: zKnowledgeFsAppSpaceJoinType,
+})
+
+/**
+ * KnowledgeFSAppSpaceJoinStatus
+ */
+export const zKnowledgeFsAppSpaceJoinStatus = z.enum(['active', 'revoked'])
+
+/**
+ * KnowledgeFSAppBindingResponse
+ */
+export const zKnowledgeFsAppBindingResponse = z.object({
+ app_id: z.string(),
+ caller_kind: zKnowledgeFsAppSpaceJoinType,
+ id: z.string(),
+ revision: z.int(),
+ status: zKnowledgeFsAppSpaceJoinStatus,
+})
+
+/**
+ * KnowledgeFSAppBindingListResponse
+ */
+export const zKnowledgeFsAppBindingListResponse = z.object({
+ data: z.array(zKnowledgeFsAppBindingResponse),
+})
+
/**
* KnowledgeFSBackgroundTaskFailureResponse
*/
diff --git a/web/features/new-rag/knowledge-fs-task-error.ts b/web/features/new-rag/knowledge-fs-task-error.ts
index e6b28969943..4aa9d705dab 100644
--- a/web/features/new-rag/knowledge-fs-task-error.ts
+++ b/web/features/new-rag/knowledge-fs-task-error.ts
@@ -232,9 +232,14 @@ export async function knowledgeFsRequestFailureMessageKey(error: unknown) {
} else {
return
}
- if (typeof body === 'object' && body !== null && 'failure' in body) {
- const failure = zKnowledgeFsPublicFailureResponse.safeParse(body.failure)
- if (failure.success) return knowledgeFsTaskFailureMessageKey(failure.data)
+ if (typeof body === 'object' && body !== null) {
+ for (const value of [
+ 'details' in body ? body.details : undefined,
+ 'failure' in body ? body.failure : undefined,
+ ]) {
+ const failure = zKnowledgeFsPublicFailureResponse.safeParse(value)
+ if (failure.success) return knowledgeFsTaskFailureMessageKey(failure.data)
+ }
}
}
diff --git a/web/features/new-rag/settings/__tests__/form.spec.tsx b/web/features/new-rag/settings/__tests__/form.spec.tsx
index f2d53671338..8725d4696a6 100644
--- a/web/features/new-rag/settings/__tests__/form.spec.tsx
+++ b/web/features/new-rag/settings/__tests__/form.spec.tsx
@@ -13,6 +13,7 @@ import type {
import type { AccountWithRoleResponse } from '@dify/contracts/api/console/workspaces/types.gen'
import type { QueryClient } from '@tanstack/react-query'
import type { ComponentProps, ReactNode } from 'react'
+import { settings as settingsContract } from '@dify/contracts/api/console/knowledge-fs/orpc.gen'
import {
zKnowledgeFsSettingsResponse,
zKnowledgeFsSpaceDetailResponse,
@@ -20,6 +21,8 @@ import {
import { act, fireEvent, screen, waitFor, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { consoleQuery } from '@/service/console'
+import { validateDefinedErrors } from '@/service/console/defined-errors'
+import { createHttpError } from '@/service/http-error'
import { createConsoleQueryClient, renderWithConsoleQuery } from '@/test/console/query-data'
import { KnowledgeSettingsPage } from '../page'
@@ -1047,20 +1050,30 @@ describe('KnowledgeSettingsPage workflows', () => {
expect(serviceMock.patchSpace).not.toHaveBeenCalled()
})
- it('shows a specific busy message without discarding the selected model', async () => {
+ it('preserves compilation guidance through the generated contract and lets the selected model be saved again', async () => {
const user = userEvent.setup()
- serviceMock.patchSettings.mockRejectedValueOnce(
- new Response(
- JSON.stringify({
- failure: {
- code: 'KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS',
- category: 'conflict',
- retryPolicy: 'manual',
- message: 'internal details',
- },
- }),
- { status: 409 },
- ),
+ const failure = {
+ code: 'KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS',
+ category: 'conflict',
+ retryPolicy: 'manual',
+ message: 'Private document processing detail must not become UI copy',
+ }
+ serviceMock.patchSettings.mockImplementationOnce(() =>
+ validateDefinedErrors({ settings: settingsContract })({
+ context: {},
+ input: undefined,
+ path: ['settings', 'patch'],
+ next: () =>
+ Promise.reject(
+ createHttpError(new Response(null, { status: 409 }), {
+ code: 'knowledge_fs_conflict',
+ status: 409,
+ message: failure.message,
+ details: failure,
+ failure,
+ }),
+ ),
+ }),
)
await renderForm()
const selector = screen.getByRole('button', {
@@ -1070,15 +1083,36 @@ describe('KnowledgeSettingsPage workflows', () => {
expectNoWrites()
await saveChanges(user)
- await waitFor(() =>
- expect(toastMock.error).toHaveBeenCalledWith(
- 'knowledgeErrors.settings.compilationInProgress',
- ),
+ expect(await screen.findByRole('alert')).toHaveTextContent(
+ 'knowledgeErrors.settings.compilationInProgress',
)
+ expect(screen.getByRole('alert')).not.toHaveTextContent(failure.message)
expect(selector).toHaveTextContent('openrouter/auto')
expect(selector).toBeEnabled()
+ expect(
+ screen.getByRole('button', { name: 'knowledgeSettings.settings.saveChanges' }),
+ ).toBeEnabled()
expect(serviceMock.patchSettings).toHaveBeenCalledTimes(1)
expect(serviceMock.patchSpace).not.toHaveBeenCalled()
+
+ await saveChanges(user)
+ await waitFor(() => expect(serviceMock.patchSettings).toHaveBeenCalledTimes(2))
+ expect(serviceMock.patchSettings).toHaveBeenNthCalledWith(
+ 2,
+ expect.objectContaining({
+ body: expect.objectContaining({
+ retrieval: expect.objectContaining({
+ reasoningModel: {
+ model: 'openrouter/auto',
+ pluginId: 'langgenius/openrouter',
+ provider: 'openrouter',
+ },
+ }),
+ }),
+ }),
+ )
+ await waitFor(() => expect(screen.queryByRole('alert')).not.toBeInTheDocument())
+ expect(toastMock.success).toHaveBeenCalledWith('common.api.actionSuccess')
})
it('requires an explicit reload on revision conflict before saving against the latest settings', async () => {
diff --git a/web/features/new-rag/settings/__tests__/save-error.spec.ts b/web/features/new-rag/settings/__tests__/save-error.spec.ts
index 063578b6aa9..7af7d71352d 100644
--- a/web/features/new-rag/settings/__tests__/save-error.spec.ts
+++ b/web/features/new-rag/settings/__tests__/save-error.spec.ts
@@ -1,6 +1,53 @@
+import { settings } from '@dify/contracts/api/console/knowledge-fs/orpc.gen'
+import { validateDefinedErrors } from '@/service/console/defined-errors'
+import { createHttpError } from '@/service/http-error'
import { settingsSaveErrorMessageKey } from '../save-error'
describe('settings save error messages', () => {
+ it.each([
+ [
+ 409,
+ 'knowledge_fs_conflict',
+ 'KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS',
+ 'conflict',
+ 'settings.compilationInProgress',
+ ],
+ [
+ 422,
+ 'knowledge_fs_request_rejected',
+ 'MODEL_CREDENTIAL_INVALID',
+ 'configuration',
+ 'taskFailure.modelConfiguration',
+ ],
+ [
+ 503,
+ 'knowledge_fs_operation_unavailable',
+ 'MODEL_PREFLIGHT_TIMEOUT',
+ 'timeout',
+ 'taskFailure.modelService',
+ ],
+ ] as const)(
+ 'preserves HTTP %s %s failure guidance through the generated contract',
+ async (status, code, failureCode, category, key) => {
+ const failure = {
+ code: failureCode,
+ category,
+ retryPolicy: 'manual',
+ message: 'Private provider detail must not become UI copy',
+ }
+ const body = { code, status, message: failure.message, details: failure, failure }
+ const error = await validateDefinedErrors({ settings })({
+ context: {},
+ input: undefined,
+ path: ['settings', 'patch'],
+ next: () => Promise.reject(createHttpError(new Response(null, { status }), body)),
+ }).catch((rejected: unknown) => rejected)
+
+ expect(error).toMatchObject({ defined: true, data: { details: failure } })
+ expect(await settingsSaveErrorMessageKey(error)).toBe(key)
+ },
+ )
+
it.each([
['KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS', 'settings.compilationInProgress'],
['KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT', 'settings.revisionConflict'],