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(agent): resolve workflow variables in knowledge metadata filters (#43854)

Jasonfish3842f0b86a25
diff --git a/api/core/workflow/nodes/agent_v2/runtime_request_builder.py b/api/core/workflow/nodes/agent_v2/runtime_request_builder.py
index 5cb9f220333..224d6c90bd9 100644
--- a/api/core/workflow/nodes/agent_v2/runtime_request_builder.py
+++ b/api/core/workflow/nodes/agent_v2/runtime_request_builder.py
@@ -20,6 +20,7 @@ from dify_agent.layers.execution_context import (
from dify_agent.layers.knowledge import (
DifyKnowledgeBaseLayerConfig,
DifyKnowledgeDatasetConfig,
+ DifyKnowledgeMetadataConditions,
DifyKnowledgeMetadataFilteringConfig,
DifyKnowledgeModelConfig,
DifyKnowledgeQueryConfig,
@@ -55,6 +56,7 @@ from extensions.tracing import application_tracing_hooks
from graphon.file import File, FileTransferMethod
from graphon.variables.segments import Segment
from graphon.variables.template_resolution import convert_template
+from libs.workflow_template_values import resolve_template_value
from models.agent import Agent, AgentConfigSnapshot, WorkflowAgentNodeBinding
from models.agent_config_entities import (
AgentKnowledgeMetadataFilteringConfig,
@@ -284,7 +286,7 @@ class WorkflowAgentRuntimeRequestBuilder:
),
tools=tool_layers.plugin_tools,
core_tools=tool_layers.core_tools,
- knowledge=build_knowledge_layer_config(agent_soul),
+ knowledge=build_knowledge_layer_config(agent_soul, variable_pool=context.variable_pool),
knowledge_fs=knowledge_fs_config,
config_layer_config=config_layer_config,
include_shell=dify_config.AGENT_SHELL_ENABLED,
@@ -762,7 +764,9 @@ def build_shell_layer_config(agent_soul: AgentSoulConfig) -> DifyShellLayerConfi
)
-def build_knowledge_layer_config(agent_soul: AgentSoulConfig) -> DifyKnowledgeBaseLayerConfig | None:
+def build_knowledge_layer_config(
+ agent_soul: AgentSoulConfig, *, variable_pool: VariablePoolReader | None = None
+) -> DifyKnowledgeBaseLayerConfig | None:
"""Map Agent Soul knowledge sets into one Dify knowledge-base layer.
Agent Soul DTO validation owns malformed set rejection. Runtime mapping is
@@ -770,6 +774,11 @@ def build_knowledge_layer_config(agent_soul: AgentSoulConfig) -> DifyKnowledgeBa
policy, dataset refs, retrieval controls, and metadata-filtering controls.
``score_threshold=None`` means disabled threshold filtering and maps to the
inner retrieval request's ``0.0`` default through the Agent backend DTO.
+ Preconditions: ``agent_soul`` is validated. Workflow callers provide the
+ current run's variable pool; ``None`` preserves standalone literal filters.
+ Postconditions: Return no layer for empty sets, otherwise map every set
+ without mutating the saved configuration. Missing manual-filter references
+ raise ``WorkflowAgentRuntimeRequestBuildError``.
"""
if not agent_soul.knowledge.sets:
return None
@@ -793,7 +802,9 @@ def build_knowledge_layer_config(agent_soul: AgentSoulConfig) -> DifyKnowledgeBa
value=knowledge_set.query.value,
),
retrieval=_knowledge_retrieval_config(knowledge_set.retrieval),
- metadata_filtering=_knowledge_metadata_filtering_config(knowledge_set.metadata_filtering),
+ metadata_filtering=_knowledge_metadata_filtering_config(
+ knowledge_set.metadata_filtering, variable_pool=variable_pool
+ ),
)
for knowledge_set in agent_soul.knowledge.sets
],
@@ -840,17 +851,42 @@ def _knowledge_retrieval_config(retrieval: AgentKnowledgeRetrievalConfig) -> Dif
def _knowledge_metadata_filtering_config(
metadata_filtering: AgentKnowledgeMetadataFilteringConfig,
+ *,
+ variable_pool: VariablePoolReader | None,
) -> DifyKnowledgeMetadataFilteringConfig:
+ """Map validated metadata settings to the runtime DTO.
+
+ Preconditions: A supplied pool belongs to the current workflow run.
+ Postconditions: Resolve only value-taking manual filters with a pool,
+ preserving saved settings and stripping editor-only fields. Value-free
+ operators ignore retained templates. Missing required references raise
+ ``WorkflowAgentRuntimeRequestBuildError`` without changing the settings.
+ """
+ conditions = metadata_filtering.conditions
+ if conditions is not None and metadata_filtering.mode == "manual" and variable_pool is not None:
+ try:
+ conditions = conditions.model_copy(
+ update={
+ "conditions": [
+ condition.model_copy(update={"value": resolve_template_value(condition.value, variable_pool)})
+ if condition.comparison_operator not in ("empty", "not empty")
+ else condition
+ for condition in conditions.conditions
+ ]
+ }
+ )
+ except ValueError as error:
+ raise WorkflowAgentRuntimeRequestBuildError(
+ "agent_metadata_filter_variable_not_found", str(error)
+ ) from error
+
return DifyKnowledgeMetadataFilteringConfig(
mode=metadata_filtering.mode,
model_config=_knowledge_model_config(metadata_filtering.metadata_model_config),
- conditions=cast(
- Any,
- metadata_filtering.conditions.model_dump(
- mode="json", exclude={"conditions": {"__all__": {"id", "metadata_id"}}}
- ),
+ conditions=DifyKnowledgeMetadataConditions.model_validate(
+ conditions.model_dump(mode="json", exclude={"conditions": {"__all__": {"id", "metadata_id"}}}),
)
- if metadata_filtering.conditions is not None
+ if conditions is not None
else None,
)
diff --git a/api/core/workflow/workflow_entry.py b/api/core/workflow/workflow_entry.py
index 84dc399dc85..7649a1f2b0d 100644
--- a/api/core/workflow/workflow_entry.py
+++ b/api/core/workflow/workflow_entry.py
@@ -27,6 +27,7 @@ from core.workflow.node_factory import (
is_start_node_type,
resolve_workflow_node_class,
)
+from core.workflow.nodes.agent_v2.binding_resolver import WorkflowAgentBindingResolver
from core.workflow.nodes.human_input.boundary import HumanInputFormEventFilter
from core.workflow.system_variables import (
default_system_variables,
@@ -41,6 +42,7 @@ from core.workflow.workflow_tool_container_handler import (
WorkflowToolEventListenerFactory,
WorkflowToolNestedContainerHandler,
)
+from domain.workflow.agent_node import is_dify_agent_node_data
from extensions.otel.runtime import is_instrument_flag_enabled
from factories import file_factory
from graphon.engine import Engine
@@ -60,6 +62,8 @@ from graphon.nodes.base.node import Node
from graphon.nodes.container_effects import ContainerAwaitRequest
from graphon.runtime import ReadOnlyRuntimeStateWrapper, RuntimeState, VariablePool
from graphon.variable_loader import DUMMY_VARIABLE_LOADER, VariableLoader, load_into_variable_pool
+from libs.workflow_template_values import template_value_selectors
+from models.agent_config_entities import AgentSoulConfig
from models.workflow import Workflow
from services.workflow_node_variables import add_node_input_to_variable_pool, load_additional_node_variables
@@ -228,7 +232,13 @@ class WorkflowEntry:
execution_driver: "WorkflowRunDriver | None",
) -> tuple[Node, Generator[NodeEvent | ContainerAwaitRequest]]:
"""
- Single step run workflow node
+ Single step run workflow node.
+
+ Preconditions: The workflow owns the requested node and its Agent binding.
+ Postconditions: Preload node references, including manual Agent knowledge
+ filters, into the supplied pool before constructing the node. Value-free
+ filter operators do not introduce variable dependencies. Legacy Agent
+ nodes do not resolve an Agent Soul binding.
:param workflow: Workflow instance
:param node_id: node id
:param user_id: user id
@@ -290,6 +300,29 @@ class WorkflowEntry:
)
except NotImplementedError:
variable_mapping = {}
+ if is_dify_agent_node_data(node_config_data):
+ # Agent Soul lives in its owned snapshot, outside graph node data.
+ # Single-step execution must also load references used only by its
+ # retrieval filters, which are absent from the task prompt.
+ bundle = WorkflowAgentBindingResolver().resolve(
+ tenant_id=workflow.tenant_id,
+ app_id=workflow.app_id,
+ workflow_id=workflow.id,
+ node_id=node_id,
+ )
+ agent_soul = AgentSoulConfig.model_validate(bundle.snapshot.config_snapshot_dict)
+ variable_mapping = {
+ **variable_mapping,
+ **{
+ f"{node_id}.metadata_filter.{'.'.join(selector)}": selector
+ for knowledge_set in agent_soul.knowledge.sets
+ if knowledge_set.metadata_filtering.mode == "manual"
+ and knowledge_set.metadata_filtering.conditions is not None
+ for condition in knowledge_set.metadata_filtering.conditions.conditions
+ if condition.comparison_operator not in ("empty", "not empty")
+ for selector in template_value_selectors(condition.value)
+ },
+ }
variable_mapping = inject_default_system_variable_mappings(
node_id=node_id,
node_type=node_type,
diff --git a/api/libs/workflow_template_values.py b/api/libs/workflow_template_values.py
new file mode 100644
index 00000000000..8beab994c09
--- /dev/null
+++ b/api/libs/workflow_template_values.py
@@ -0,0 +1,62 @@
+from collections.abc import Iterator, Sequence
+from typing import Protocol
+
+from graphon.nodes.base.variable_template_parser import extract_selectors_from_template
+from graphon.variables.segments import Segment
+from graphon.variables.template_resolution import VARIABLE_PATTERN
+
+type TemplateValue = str | Sequence[str] | int | float | None
+
+
+class TemplateVariablePool(Protocol):
+ def get(self, selector: Sequence[str], /) -> Segment | None: ...
+
+
+def template_value_selectors(value: TemplateValue) -> Iterator[list[str]]:
+ """Extract workflow references from a scalar string or string sequence.
+
+ Preconditions: ``value`` is a validated metadata condition value.
+ Postconditions: Yield selectors without changing the value; constants
+ yield nothing.
+ """
+ values = [value] if isinstance(value, str) else value
+ if isinstance(values, Sequence):
+ for template in values:
+ for reference in extract_selectors_from_template(template):
+ yield list(reference.value_selector)
+
+
+def resolve_template_value(value: TemplateValue, variable_pool: TemplateVariablePool) -> TemplateValue:
+ """Resolve scalar values and string sequences against a workflow variable pool.
+
+ Preconditions: ``value`` is a validated metadata condition value and the
+ pool belongs to the current run.
+ Postconditions: Return the resolved value without changing either input.
+ A whole scalar reference retains its string or numeric type;
+ interpolated text and elements of string lists remain strings. Missing
+ references fail explicitly rather than becoming literal selector text.
+ """
+
+ def get_segment(selector: str) -> Segment:
+ """Return an existing dot-separated selector or raise ``ValueError``."""
+ segment = variable_pool.get(selector.split("."))
+ if segment is None:
+ raise ValueError(f"Workflow variable {selector} is not available.")
+ return segment
+
+ def resolve_template(template: str) -> str | int | float | None:
+ """Resolve a string template without changing the pool; fail on missing refs."""
+ if match := VARIABLE_PATTERN.fullmatch(template):
+ resolved = get_segment(match.group(1)).to_object()
+ if resolved is None or isinstance(resolved, str | float):
+ return resolved
+ if isinstance(resolved, int) and not isinstance(resolved, bool):
+ return resolved
+ return str(resolved)
+ return VARIABLE_PATTERN.sub(lambda match: get_segment(match.group(1)).text, template)
+
+ if isinstance(value, str):
+ return resolve_template(value)
+ if isinstance(value, Sequence):
+ return [str(resolve_template(item)) for item in value]
+ return value
diff --git a/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_runtime_request_builder.py b/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_runtime_request_builder.py
index acb0da114f0..a59f635c50a 100644
--- a/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_runtime_request_builder.py
+++ b/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_runtime_request_builder.py
@@ -11,6 +11,7 @@ from dify_agent.layers.prompt import Config as PromptConfig
from dify_agent.protocol import DIFY_AGENT_HISTORY_LAYER_ID, DIFY_AGENT_MODEL_LAYER_ID, DIFY_AGENT_OUTPUT_LAYER_ID
from dify_agent.protocol.snapshot import SessionSnapshot
from flask import Flask
+from sqlalchemy.orm import Session
from clients.agent_backend import (
DIFY_CONFIG_LAYER_ID,
@@ -21,6 +22,7 @@ from clients.agent_backend import (
from clients.agent_backend.request_builder import DIFY_SHELL_LAYER_ID
from core.app.entities.app_invoke_entities import DifyRunContext, InvokeFrom, UserFrom
from core.workflow.file_reference import build_file_reference
+from core.workflow.nodes.agent.agent_node import AgentNode as LegacyAgentNode
from core.workflow.nodes.agent_v2.dify_tools_builder import WorkflowAgentDifyToolsBuilder
from core.workflow.nodes.agent_v2.runtime_request_builder import (
WorkflowAgentRuntimeBuildContext,
@@ -29,8 +31,10 @@ from core.workflow.nodes.agent_v2.runtime_request_builder import (
build_knowledge_layer_config,
build_shell_layer_config,
)
+from core.workflow.workflow_entry import WorkflowEntry
from extensions.tracing import bind_tracing
from graphon.file import File, FileTransferMethod, FileType
+from graphon.runtime.variable_pool import VariablePool
from graphon.variables.segments import ArrayFileSegment, FileSegment, StringSegment
from models.agent import (
Agent,
@@ -50,6 +54,7 @@ from models.agent_config_entities import (
DeclaredOutputType,
WorkflowNodeJobConfig,
)
+from models.workflow import Workflow
from services.tracing.adapters import CeleryTraceEmitter
from tests.helpers.unit.config_override import apply_config_overrides
from tests.helpers.unit.knowledge_fs_core_fakes import RecordingModelFactory, llm_schema
@@ -276,6 +281,225 @@ def _request_layers(result) -> dict[str, dict[str, object]]:
return {layer["name"]: layer for layer in dumped["composition"]["layers"]}
+def _metadata_filter_context() -> WorkflowAgentRuntimeBuildContext:
+ context = _context()
+ soul = context.snapshot.config_snapshot_dict
+ soul["knowledge"] = {
+ "sets": [
+ {
+ "id": "exhibits",
+ "name": "Exhibits",
+ "datasets": [{"id": "dataset-1"}],
+ "query": {"mode": "generated_query"},
+ "retrieval": {"mode": "multiple", "top_k": 4},
+ "metadata_filtering": {
+ "mode": "manual",
+ "conditions": {
+ "logical_operator": "and",
+ "conditions": [
+ {"name": name, "comparison_operator": "=", "value": "{{#start." + name + "#}}"}
+ for name in ("guide_program_id", "guide_item_id")
+ ],
+ },
+ },
+ }
+ ],
+ }
+ context.snapshot.config_snapshot = soul
+ return context
+
+
+def test_workflow_metadata_filters_resolve_current_run_values_without_mutating_snapshot():
+ context = _metadata_filter_context()
+ saved_snapshot = context.snapshot.config_snapshot_dict
+ builder = WorkflowAgentRuntimeRequestBuilder()
+
+ for program_id, item_id in [(123, 456), (789, 0), ("00123", "00456")]:
+ pool = VariablePool()
+ pool.add(["start", "guide_program_id"], program_id)
+ pool.add(["start", "guide_item_id"], item_id)
+ pool.add(["sys", "query"], "Describe this exhibit")
+ result = builder.build(replace(context, variable_pool=pool))
+ layer = result.request.model_dump(mode="json")["composition"]["layers"]
+ knowledge = next(item for item in layer if item["name"] == "knowledge")
+ filtering = knowledge["config"]["sets"][0]["metadata_filtering"]
+
+ assert filtering["conditions"] == {
+ "logical_operator": "and",
+ "conditions": [
+ {"name": "guide_program_id", "comparison_operator": "=", "value": program_id},
+ {"name": "guide_item_id", "comparison_operator": "=", "value": item_id},
+ ],
+ }
+ assert context.snapshot.config_snapshot_dict == saved_snapshot
+
+
+def test_workflow_metadata_filter_rejects_missing_variable_before_starting_agent():
+ context = _metadata_filter_context()
+ with pytest.raises(WorkflowAgentRuntimeRequestBuildError, match="start.guide_program_id"):
+ WorkflowAgentRuntimeRequestBuilder().build(replace(context, variable_pool=VariablePool()))
+
+
[email protected]("operator", ["empty", "not empty"])
+def test_value_free_metadata_filters_ignore_retained_variable_template(operator):
+ context = _metadata_filter_context()
+ soul = context.snapshot.config_snapshot_dict
+ saved_conditions = soul["knowledge"]["sets"][0]["metadata_filtering"]["conditions"]["conditions"]
+ # The editor changes the operator without clearing the previously selected variable.
+ saved_conditions[0]["comparison_operator"] = operator
+ context.snapshot.config_snapshot = soul
+ pool = VariablePool()
+ pool.add(["start", "guide_item_id"], 456)
+ pool.add(["sys", "query"], "Describe this exhibit")
+
+ result = WorkflowAgentRuntimeRequestBuilder().build(replace(context, variable_pool=pool))
+
+ conditions = _request_layers(result)["knowledge"]["config"]["sets"][0]["metadata_filtering"]["conditions"][
+ "conditions"
+ ]
+ assert conditions[0]["comparison_operator"] == operator
+ assert conditions[1] == {"name": "guide_item_id", "comparison_operator": "=", "value": 456}
+ assert saved_conditions[0]["value"] == "{{#start.guide_program_id#}}"
+
+
[email protected]("operator", ["=", "empty", "not empty"])
+def test_single_step_loads_variables_referenced_only_by_knowledge_filters(
+ sqlite_session: Session, monkeypatch: pytest.MonkeyPatch, operator: str
+):
+ apply_config_overrides(monkeypatch, AGENT_BACKEND_BASE_URL="http://agent-backend.invalid")
+ context = _metadata_filter_context()
+ soul = context.snapshot.config_snapshot_dict
+ soul["knowledge"]["sets"][0]["metadata_filtering"]["conditions"]["conditions"][0]["comparison_operator"] = operator
+ context.snapshot.config_snapshot = soul
+ context.binding.workflow_version = "draft"
+ context.binding.binding_type = WorkflowAgentBindingType.INLINE_AGENT
+ context.agent.scope = AgentScope.WORKFLOW_ONLY
+ context.agent.source = AgentSource.WORKFLOW
+ sqlite_session.add_all([context.agent, context.snapshot, context.binding])
+ sqlite_session.commit()
+ workflow = Workflow(
+ id=context.workflow_id,
+ tenant_id=context.dify_context.tenant_id,
+ app_id=context.dify_context.app_id,
+ graph=json.dumps(
+ {
+ "nodes": [
+ {
+ "id": context.node_id,
+ "data": {"type": "agent", "version": "2", "agent_node_kind": "dify_agent", "title": "Agent"},
+ }
+ ],
+ "edges": [],
+ }
+ ),
+ )
+ source_pool = VariablePool()
+ if operator == "=":
+ source_pool.add(["start", "guide_program_id"], "00123")
+ source_pool.add(["start", "guide_item_id"], 456)
+
+ requested_selectors: list[list[str]] = []
+
+ class DraftVariableLoader:
+ def load_variables(self, selectors):
+ requested_selectors.extend(list(selector) for selector in selectors)
+ return [value for selector in selectors if (value := source_pool.get(selector)) is not None]
+
+ pool = VariablePool()
+ WorkflowEntry.single_step_run(
+ workflow=workflow,
+ node_id=context.node_id,
+ user_id=context.dify_context.user_id,
+ user_inputs={},
+ variable_pool=pool,
+ variable_loader=DraftVariableLoader(),
+ execution_driver=None,
+ )
+ if operator != "=":
+ assert ["start", "guide_program_id"] not in requested_selectors
+ result = WorkflowAgentRuntimeRequestBuilder().build(replace(context, variable_pool=pool))
+ conditions = _request_layers(result)["knowledge"]["config"]["sets"][0]["metadata_filtering"]["conditions"][
+ "conditions"
+ ]
+ assert conditions[0]["comparison_operator"] == operator
+ assert conditions[1]["value"] == 456
+ if operator == "=":
+ assert conditions[0]["value"] == "00123"
+
+
+def test_single_step_legacy_agent_v2_does_not_resolve_new_agent_binding(monkeypatch):
+ monkeypatch.setattr(WorkflowEntry, "_run_node_with_layers", lambda *_args, **_kwargs: iter(()))
+
+ def reject_new_agent_binding(*_args, **_kwargs):
+ raise AssertionError("Legacy Agent must not resolve an Agent v2 binding")
+
+ monkeypatch.setattr("core.workflow.workflow_entry.WorkflowAgentBindingResolver.resolve", reject_new_agent_binding)
+ workflow = Workflow(
+ id="workflow-id",
+ tenant_id="tenant-id",
+ app_id="app-id",
+ graph=json.dumps(
+ {
+ "nodes": [{"id": "legacy-agent", "data": {"type": "agent", "version": "2", "title": "Legacy Agent"}}],
+ "edges": [],
+ }
+ ),
+ )
+ node, _ = WorkflowEntry.single_step_run(
+ workflow=workflow,
+ node_id="legacy-agent",
+ user_id="user-id",
+ user_inputs={},
+ variable_pool=VariablePool(),
+ execution_driver=None,
+ )
+ assert isinstance(node, LegacyAgentNode)
+ assert node.id == "legacy-agent"
+
+
+ ("value", "expected"),
+ [
+ ("program:{{#start.guide_program_id#}}/{{#start.guide_item_id#}}", "program:123/00456"),
+ (["{{#start.guide_program_id#}}", "{{#start.guide_item_id#}}", "constant"], ["123", "00456", "constant"]),
+ (0, 0),
+ (None, None),
+ ("", ""),
+ ],
+)
+def test_metadata_filters_resolve_templates_and_lists_preserving_constants(value, expected):
+ context = _metadata_filter_context()
+ soul = context.snapshot.config_snapshot_dict
+ condition = soul["knowledge"]["sets"][0]["metadata_filtering"]["conditions"]["conditions"][0]
+ condition.update(value=value, id="condition-1", metadata_id="program-metadata")
+ context.snapshot.config_snapshot = soul
+ pool = VariablePool()
+ pool.add(["start", "guide_program_id"], 123)
+ pool.add(["start", "guide_item_id"], "00456")
+ result = WorkflowAgentRuntimeRequestBuilder().build(replace(context, variable_pool=pool))
+ conditions = _request_layers(result)["knowledge"]["config"]["sets"][0]["metadata_filtering"]["conditions"][
+ "conditions"
+ ]
+ assert conditions[0] == {"name": "guide_program_id", "comparison_operator": "=", "value": expected}
+
+
[email protected]("mode", ["disabled", "automatic"])
+def test_inactive_manual_filters_do_not_require_workflow_variables(mode):
+ context = _metadata_filter_context()
+ soul = context.snapshot.config_snapshot_dict
+ soul["knowledge"]["sets"][0]["metadata_filtering"]["mode"] = mode
+ if mode == "automatic":
+ soul["knowledge"]["sets"][0]["metadata_filtering"]["model_config"] = {
+ "provider": "openai",
+ "name": "gpt-test",
+ "mode": "chat",
+ "completion_params": {},
+ }
+ context.snapshot.config_snapshot = soul
+ result = WorkflowAgentRuntimeRequestBuilder().build(replace(context, variable_pool=VariablePool()))
+ assert _request_layers(result)["knowledge"]["config"]["sets"][0]["metadata_filtering"]["mode"] == mode
+
+
def _workflow_user_prompt(result) -> str:
from clients.agent_backend import WORKFLOW_USER_PROMPT_LAYER_ID
diff --git a/api/tests/unit_tests/libs/test_workflow_template_values.py b/api/tests/unit_tests/libs/test_workflow_template_values.py
new file mode 100644
index 00000000000..9ef7025b8bc
--- /dev/null
+++ b/api/tests/unit_tests/libs/test_workflow_template_values.py
@@ -0,0 +1,27 @@
+import pytest
+
+from graphon.runtime.variable_pool import VariablePool
+from libs.workflow_template_values import resolve_template_value, template_value_selectors
+
+
[email protected]("value", [0, 1.5, None])
+def test_constant_filter_values_do_not_request_workflow_variables(value: int | float | None) -> None:
+ assert list(template_value_selectors(value)) == []
+
+
+ ("value", "expected"),
+ [
+ (True, "True"),
+ (False, "False"),
+ (["I10", "I20"], "['I10', 'I20']"),
+ ({"guide_item_id": "I10"}, "{'guide_item_id': 'I10'}"),
+ ],
+)
+def test_boolean_and_collection_filter_references_resolve_to_strings(
+ value: bool | list[str] | dict[str, str], expected: str
+) -> None:
+ pool = VariablePool()
+ pool.add(["start", "filter_value"], value)
+
+ assert resolve_template_value("{{#start.filter_value#}}", pool) == expected
diff --git a/api/tests/unit_tests/services/test_workflow_service.py b/api/tests/unit_tests/services/test_workflow_service.py
index dcd7747699a..1ee84995bb2 100644
--- a/api/tests/unit_tests/services/test_workflow_service.py
+++ b/api/tests/unit_tests/services/test_workflow_service.py
@@ -4277,9 +4277,37 @@ class TestWorkflowAgentPreviewIdentityCases:
"edges": [],
},
)
+ agent = Agent(
+ id=str(uuid4()),
+ tenant_id=tenant_id,
+ name="Preview Agent",
+ scope=AgentScope.WORKFLOW_ONLY,
+ source=AgentSource.WORKFLOW,
+ app_id=app_id,
+ workflow_id=workflow_id,
+ workflow_node_id=node_id,
+ )
+ snapshot = AgentConfigSnapshot(
+ id=str(uuid4()),
+ tenant_id=tenant_id,
+ agent_id=agent.id,
+ version=1,
+ config_snapshot=AgentSoulConfig(),
+ )
+ binding = WorkflowAgentNodeBinding(
+ tenant_id=tenant_id,
+ app_id=app_id,
+ workflow_id=workflow_id,
+ workflow_version=workflow.version,
+ node_id=node_id,
+ binding_type=WorkflowAgentBindingType.INLINE_AGENT,
+ agent_id=agent.id,
+ current_snapshot_id=snapshot.id,
+ node_job_config={},
+ )
sessions = sessionmaker(sqlite_engine, expire_on_commit=False)
with sessions.begin() as session:
- session.add_all([app, account, workflow])
+ session.add_all([app, account, workflow, agent, snapshot, binding])
repository = SQLAlchemyWorkflowNodeExecutionRepository(
sessions, tenant_id, account, app_id, WorkflowNodeExecutionTriggeredFrom.SINGLE_STEP
)
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/index.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/index.tsx
index 6691320921b..60bb9bee0e8 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/index.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/index.tsx
@@ -180,7 +180,7 @@ export function AgentOrchestratePanel({
<AgentTools />
</>
)}
- <AgentKnowledgeRetrieval />
+ <AgentKnowledgeRetrieval workflowNodeId={nodeId} />
{!isTemplatePreview && <AgentAdvancedSettings />}
</AgentBuildDraftChangedKeysProvider>
</AgentOrchestrateAddActionsProvider>
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/__tests__/index.spec.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/__tests__/index.spec.tsx
index 2761741559b..81d8b425217 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/__tests__/index.spec.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/__tests__/index.spec.tsx
@@ -1,10 +1,12 @@
import type { KnowledgeFsSpaceListItemResponse } from '@dify/contracts/api/console/knowledge-fs/types.gen'
+import type { Node, Var } from '@/app/components/workflow/types'
import type { AgentKnowledgeRetrievalItem } from '@/features/agent-v2/agent-composer/form-state'
import { zKnowledgeFsSpaceListResponse } from '@dify/contracts/api/console/knowledge-fs/zod.gen'
import { ORPCError } from '@orpc/client'
import { act, screen, waitFor, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { useAtomValue } from 'jotai'
+import { ReactFlowProvider } from 'reactflow'
import { beforeEach, describe, expect, it, vi } from 'vite-plus/test'
import {
ComparisonOperator,
@@ -12,6 +14,7 @@ import {
MetadataFilteringModeEnum,
MetadataFilteringVariableType,
} from '@/app/components/workflow/nodes/knowledge-retrieval/types'
+import { BlockEnum, VarType } from '@/app/components/workflow/types'
import {
agentSoulConfigToFormState,
formStateToAgentSoulConfig,
@@ -39,6 +42,29 @@ import {
} from '../../read-only-context'
import { AgentKnowledgeRetrieval } from '../index'
+vi.mock('@/app/components/workflow/nodes/_base/hooks/use-available-var-list', () => ({
+ default: (_nodeId: string, { filterVar }: { filterVar: (value: Var) => boolean }) => ({
+ availableVars: [
+ {
+ nodeId: 'start',
+ title: 'Start',
+ isStartNode: true,
+ vars: [
+ { variable: 'program_input', type: VarType.number },
+ { variable: 'item_input', type: VarType.string },
+ ].filter(filterVar),
+ },
+ ],
+ availableNodesWithParent: [
+ {
+ id: 'start',
+ position: { x: 0, y: 0 },
+ data: { type: BlockEnum.Start, title: 'Start', desc: '' },
+ } satisfies Node,
+ ],
+ }),
+}))
+
const render = createNuqsTestRenderer(renderWithConsoleQuery)
const { getDatasets, getDataset, getSpaces, getRules } = vi.hoisted(() => ({
@@ -153,6 +179,7 @@ function setup(
label = 'snapshot',
spaces = [space(), space(SECOND, 'Engineering')],
hasMore = false,
+ workflowNodeId = undefined as string | undefined,
} = {},
) {
const queryClient = createConsoleQueryClient()
@@ -178,7 +205,9 @@ function setup(
>
<AgentOrchestrateViewingVersionContext value={viewingVersion}>
<AgentOrchestrateReadOnlyContext value={readOnly}>
- <AgentKnowledgeRetrieval />
+ <ReactFlowProvider>
+ <AgentKnowledgeRetrieval workflowNodeId={workflowNodeId} />
+ </ReactFlowProvider>
</AgentOrchestrateReadOnlyContext>
</AgentOrchestrateViewingVersionContext>
<Snapshot label={label} />
@@ -233,6 +262,62 @@ async function toggleDatasets(
}
describe('shared knowledge binding dialog', () => {
+ it.each([
+ ['string', 'item_input', 'program_input', ComparisonOperator.is],
+ ['number', 'program_input', 'item_input', ComparisonOperator.equal],
+ ] as const)(
+ 'saves a matching workflow variable for %s metadata in the shared dialog',
+ async (metadataType, variableName, otherTypeVariable, comparisonOperator) => {
+ const user = userEvent.setup()
+ const dataset = createDatasetFixture({
+ doc_metadata: [{ id: 'guide-metadata', name: 'guide_id', type: metadataType }],
+ })
+ getDataset.mockResolvedValue(dataset)
+ setup(
+ [
+ {
+ id: 'classic',
+ name: 'Guide retrieval',
+ selectedDatasets: [dataset],
+ metadataFilterMode: MetadataFilteringModeEnum.manual,
+ metadataFilteringConditions: {
+ logical_operator: LogicalOperator.and,
+ conditions: [
+ {
+ id: 'condition-1',
+ metadata_id: 'guide-metadata',
+ name: 'guide_id',
+ comparison_operator: comparisonOperator,
+ value: metadataType === 'number' ? 1 : 'previous',
+ },
+ ],
+ },
+ },
+ ],
+ { enabled: false, workflowNodeId: 'agent-node' },
+ )
+ const dialog = await open(user)
+ await advanced(user, dialog)
+ await user.click(await screen.findByRole('button', { name: /metadata.panel.conditions/ }))
+ await user.click(screen.getByRole('button', { name: 'Constant' }))
+ await user.click(screen.getByText('Variable', { exact: true }))
+ await user.click(
+ screen.getByText('workflowModels.nodes.knowledgeRetrieval.metadata.panel.select'),
+ )
+ expect(screen.queryByText(otherTypeVariable)).not.toBeInTheDocument()
+ await user.click(screen.getByText(variableName))
+ await user.keyboard('{Escape}')
+ await user.click(within(dialog).getByRole('button', { name: /operation.confirm/ }))
+ expect(screen.queryByRole('dialog')).not.toBeInTheDocument()
+ expect(
+ snapshot().knowledge.sets[0].metadata_filtering.conditions.conditions[0],
+ ).toMatchObject({
+ name: 'guide_id',
+ value: `{{#start.${variableName}#}}`,
+ })
+ },
+ )
+
beforeEach(() => getDatasets.mockResolvedValue(datasetPage()))
it.each([false, true])(
@@ -679,6 +764,22 @@ describe('shared knowledge binding dialog', () => {
value: 'abc',
valid: false,
},
+ {
+ title: 'retains numeric workflow variable conditions',
+ from: MetadataFilteringVariableType.number,
+ to: MetadataFilteringVariableType.number,
+ operator: ComparisonOperator.equal,
+ value: '{{#start.program_input#}}',
+ valid: true,
+ },
+ {
+ title: 'rejects interpolated text on numeric fields',
+ from: MetadataFilteringVariableType.number,
+ to: MetadataFilteringVariableType.number,
+ operator: ComparisonOperator.equal,
+ value: 'prefix-{{#start.program_input#}}',
+ valid: false,
+ },
{
title: 'retains compatible numeric conditions',
from: MetadataFilteringVariableType.number,
@@ -746,6 +847,7 @@ describe('shared knowledge binding dialog', () => {
await confirmDatasetPicker(user, picker)
await user.click(within(dialog).getByRole('button', { name: /operation.confirm/ }))
if (valid) {
+ expect(dialog).not.toBeInTheDocument()
expect(snapshot().knowledge.sets[0].metadata_filtering.conditions.conditions).toEqual([
{
id: 'condition',
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/classic-settings.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/classic-settings.tsx
index cd626857521..219b4d6583b 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/classic-settings.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/classic-settings.tsx
@@ -27,8 +27,8 @@ import AddKnowledge from '@/app/components/workflow/nodes/knowledge-retrieval/co
import {
comparisonOperatorNotRequireValue,
getOperators,
+ VARIABLE_REGEX,
} from '@/app/components/workflow/nodes/knowledge-retrieval/components/metadata/condition-list/utils'
-import MetadataFilter from '@/app/components/workflow/nodes/knowledge-retrieval/components/metadata/metadata-filter'
import RetrievalConfig from '@/app/components/workflow/nodes/knowledge-retrieval/components/retrieval-config'
import {
ComparisonOperator,
@@ -44,9 +44,11 @@ import {
} from '@/features/agent-v2/agent-composer/knowledge-validation'
import { consoleQuery } from '@/service/console'
import { RETRIEVE_TYPE } from '@/types/app'
+import { AgentMetadataFilter } from './metadata-filter'
type KnowledgeRetrievalQueryMode = 'agent' | 'custom'
type Props = {
+ workflowNodeId?: string
item: AgentKnowledgeRetrievalItem
onChange: (patch: Partial<AgentKnowledgeRetrievalItem>) => void
errors?: KnowledgeValidationResult['byId'][string]
@@ -93,6 +95,12 @@ const isMetadataConditionCompatible = (
if (!getOperators(type).some((operator) => operator === condition.comparison_operator))
return false
if (comparisonOperatorNotRequireValue(condition.comparison_operator)) return true
+ if (
+ type === MetadataFilteringVariableType.number &&
+ typeof condition.value === 'string' &&
+ condition.value.match(VARIABLE_REGEX)?.[0] === condition.value
+ )
+ return true
if (type === MetadataFilteringVariableType.number || type === MetadataFilteringVariableType.time)
return typeof condition.value === 'number' && Number.isFinite(condition.value)
if (
@@ -145,6 +153,7 @@ const createMetadataCondition = ({
})
function ClassicSettingsFields({
+ workflowNodeId,
item,
onChange,
errors,
@@ -374,7 +383,8 @@ function ClassicSettingsFields({
{/* The shared workflow filter brings its own px-4 gutter; cancel it to line up with the fields above. */}
<div className="-mx-4 py-2">
{/* Keep saved conditions until an explicit edit; catalog loading must not prune them. */}
- <MetadataFilter
+ <AgentMetadataFilter
+ workflowNodeId={workflowNodeId}
metadataList={metadataList}
metadataFilterMode={metadataFilterMode}
metadataFilteringConditions={metadataFilteringConditions}
@@ -437,7 +447,7 @@ function ClassicSettingsFields({
}
/** Only mounted inside the shared binding dialog's advanced settings. */
-export function ClassicKnowledgeSettings({ item, onChange, errors }: Props) {
+export function ClassicKnowledgeSettings({ item, onChange, errors, workflowNodeId }: Props) {
const { t } = useTranslation(['common'])
const ids = item.datasetRefs?.flatMap((dataset) => (dataset.id ? [dataset.id] : [])) ?? []
const queries = useQueries({
@@ -515,6 +525,7 @@ export function ClassicKnowledgeSettings({ item, onChange, errors }: Props) {
)
return (
<ClassicSettingsFields
+ workflowNodeId={workflowNodeId}
item={item}
onChange={onChange}
errors={errors}
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/dialog.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/dialog.tsx
index 08acb2d26ae..b376f95d79d 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/dialog.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/dialog.tsx
@@ -45,6 +45,7 @@ import { useClassicKnowledgeCatalog } from './classic-catalog'
import { ClassicKnowledgeSettings } from './classic-settings'
type Props = {
+ workflowNodeId?: string
open: boolean
knowledgeFsEnabled: boolean
initialBindings: AgentKnowledgeRetrievalItem[]
@@ -214,6 +215,7 @@ function CatalogState({
/** Draft state lives as long as the dialog content: each opening starts from the saved bindings. */
function AgentKnowledgeRetrievalForm({
+ workflowNodeId,
initialBindings: bindings,
knowledgeFsEnabled,
onConfirm,
@@ -578,6 +580,7 @@ function AgentKnowledgeRetrievalForm({
</Field>
{!item.controlSpaceId && (
<ClassicKnowledgeSettings
+ workflowNodeId={workflowNodeId}
item={item}
onChange={(patch) => update(item.id, patch)}
errors={submitted ? errors : undefined}
@@ -614,6 +617,7 @@ function AgentKnowledgeRetrievalForm({
/** The composer changes only on explicit confirmation. */
export function AgentKnowledgeRetrievalDialog({
+ workflowNodeId,
open,
initialBindings,
knowledgeFsEnabled,
@@ -628,6 +632,7 @@ export function AgentKnowledgeRetrievalDialog({
growing would re-center it and slide the list under the pointer. */}
<DialogContent initialFocus={filterRef} className="h-[min(40rem,80dvh)] w-xl overflow-hidden">
<AgentKnowledgeRetrievalForm
+ workflowNodeId={workflowNodeId}
initialBindings={initialBindings}
knowledgeFsEnabled={knowledgeFsEnabled}
filterRef={filterRef}
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/index.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/index.tsx
index b8cfbc86ea8..59b31786edc 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/index.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/index.tsx
@@ -61,7 +61,7 @@ function AgentKnowledgeRetrievalRow({
)
}
-export function AgentKnowledgeRetrieval() {
+export function AgentKnowledgeRetrieval({ workflowNodeId }: { workflowNodeId?: string }) {
const { t } = useTranslation(['agentV2'])
const retrievals = useAtomValue(agentComposerKnowledgeRetrievalsAtom)
const enabled = useAtomValue(agentKnowledgeFsEnabledAtom)
@@ -124,6 +124,7 @@ export function AgentKnowledgeRetrieval() {
)}
</ConfigureSection>
<AgentKnowledgeRetrievalDialog
+ workflowNodeId={workflowNodeId}
open={isDialogOpen && !readOnly}
knowledgeFsEnabled={enabled}
initialBindings={retrievals}
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/metadata-filter.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/metadata-filter.tsx
new file mode 100644
index 00000000000..d7b711eff69
--- /dev/null
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/knowledge/metadata-filter.tsx
@@ -0,0 +1,40 @@
+import type { ComponentProps } from 'react'
+import type { Var } from '@/app/components/workflow/types'
+import useAvailableVarList from '@/app/components/workflow/nodes/_base/hooks/use-available-var-list'
+import MetadataFilter from '@/app/components/workflow/nodes/knowledge-retrieval/components/metadata/metadata-filter'
+import { VarType } from '@/app/components/workflow/types'
+
+type Props = ComponentProps<typeof MetadataFilter> & {
+ workflowNodeId?: string
+}
+
+const filterStringVar = (variable: Var) => variable.type === VarType.string
+const filterNumberVar = (variable: Var) => variable.type === VarType.number
+
+function WorkflowMetadataFilter({ workflowNodeId, ...props }: Props & { workflowNodeId: string }) {
+ const strings = useAvailableVarList(workflowNodeId, {
+ onlyLeafNodeVar: false,
+ filterVar: filterStringVar,
+ })
+ const numbers = useAvailableVarList(workflowNodeId, {
+ onlyLeafNodeVar: false,
+ filterVar: filterNumberVar,
+ })
+
+ return (
+ <MetadataFilter
+ {...props}
+ availableStringVars={strings.availableVars}
+ availableStringNodesWithParent={strings.availableNodesWithParent}
+ availableNumberVars={numbers.availableVars}
+ availableNumberNodesWithParent={numbers.availableNodesWithParent}
+ />
+ )
+}
+
+export function AgentMetadataFilter({ workflowNodeId, ...props }: Props) {
+ // Standalone Agent composers do not have a workflow canvas or variable scope.
+ if (workflowNodeId) return <WorkflowMetadataFilter {...props} workflowNodeId={workflowNodeId} />
+
+ return <MetadataFilter {...props} />
+}