Files
f2027a89f8 feat(config)!: trim Configuration inputs and rewrite tooltips (#150)
Remove settings the user should not have to touch, and make every tooltip
plain-language:

- knowledge_base path: removed; the Knowledge Base ships in the package, so the
  path is fixed rather than a prompted input.
- prompt_target: removed (reserved; to be replaced in V3).
- prompt_separator: removed; always ',' this version. Both keep their compiler
  defaults, just no longer exposed as node inputs.
- analyzer_system_prompt (Configuration) and system_prompt (Scene Analyzer):
  removed. A user-authored system prompt is not UX-friendly; the built-in analyzer
  prompt is always used.
- Rewrite all node tooltips in plain language reflecting the current nodes.

Example workflow and node tests updated; docs/nodes.md refreshed.

BREAKING CHANGE: the Configuration node's knowledge_base, prompt_target,
prompt_separator, and analyzer_system_prompt inputs and the Scene Analyzer's
system_prompt input are removed.

Co-authored-by: kunail0804 <kunail0804@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-16 17:37:28 +02:00

3.6 KiB

ComfyUI node reference

The exact inputs, outputs, and data types of the shipped Scene Compiler nodes. All nodes appear under the Scene Compiler category. Data flows between nodes as typed objects; the inter-stage types are SCENE, RESOLVED_TAGS, CATEGORY_MAP, KNOWLEDGE_BASE, and COMPILER_CONFIG.

Nodes are thin adapters: all behaviour lives in the compiler package, which never imports ComfyUI.

Every stage node also exposes a raw string output — a JSON dump of that node's data output — for inspecting the pipeline (wire it into a text/preview node). The Knowledge Base Loader's raw summarizes the loaded entries. A relative Knowledge Base path is resolved against the installed package, so the default knowledge_base/ works regardless of ComfyUI's working directory.

Pipeline nodes

Node Inputs Outputs
Scene Analyzer natural_language (STRING), config (COMPILER_CONFIG, optional — supplies model/temperature/retries/timeout) scene (SCENE), warnings (STRING), errors (STRING)
Scene Validator scene (SCENE), config (COMPILER_CONFIG, optional) scene (SCENE), warnings (STRING), errors (STRING)
Resolver scene (SCENE), knowledge_base (KNOWLEDGE_BASE), config (COMPILER_CONFIG, optional) resolved_tags (RESOLVED_TAGS), warnings (STRING), errors (STRING)
Category Splitter resolved_tags (RESOLVED_TAGS) category_map (CATEGORY_MAP), warnings (STRING), errors (STRING)
Prompt Builder category_map (CATEGORY_MAP), config (COMPILER_CONFIG, optional) one STRING per category (character, appearance, hair, face, eyes, expression, body, clothing, accessories, pose, action, interaction, objects, environment, camera, lighting, style, quality, miscellaneous) plus reserved negative and scene (STRING)

The Category Splitter produces the intermediate Category Map; the per-category prompt strings are produced by the Prompt Builder.

Support nodes

Node Inputs Outputs
Configuration the settings a user needs to touch: analyzer (model, temperature, retries, timeout), resolver (strict mode, aliases, expansion, depth, include_nsfw, optional resolver_knowledge_base_version), validator (allow_unknown_fields), prompt_remove_duplicate_tags, the opt-in semantic-fallback settings, debug, and knowledge_base_reload. The Knowledge Base path is fixed (not user-facing); prompt_target/prompt_separator are not exposed (fixed defaults). config (COMPILER_CONFIG), knowledge_base (KNOWLEDGE_BASE), warnings (STRING), errors (STRING)
Debug Viewer scene (SCENE, optional), resolved_tags (RESOLVED_TAGS, optional), category_map (CATEGORY_MAP, optional), warnings (STRING, optional), errors (STRING, optional) report (STRING)
  • The Configuration node is the single place for compiler settings. Its config output feeds the optional config input of the Scene Analyzer, Validator, and Resolver, and it also loads the Knowledge Base from the configured path/version and emits it on its knowledge_base output (wired into the Resolver's knowledge_base input) — so the Knowledge Base directory is entered in one place. There is no separate Knowledge Base Loader node. Bump knowledge_base_reload to force a fresh read (no automatic file watching).
  • The Debug Viewer is read-only; connect any intermediate state to inspect it.

A ready-to-use workflow wiring all of these is in examples/workflows/scene_compiler_pipeline.json.