Configure AI-Q Workflows
Use this skill when a developer or operator needs a new configs/config_*.yml
file.
Start Here
- Confirm this is config composition — not deploy (
aiq-deploy), live research (aiq-research), prompt edits (aiq-customize-prompts-models), or new NAT packages (aiq-add-tool/aiq-add-data-source). - Copy the closest shipped
configs/*.ymlprofile; merge feature blocks from others. - Every produced config must pass
validate_config.pybefore hand-off.
Authoritative References
docs/source/customization/configuration-reference.md— all fields and defaultsdocs/source/customization/tools-and-sources.mddocs/source/deployment/observability.md— tracing setup detailfrontends/aiq_api/README.mdconfigs/config_web_default_llamaindex.yml/configs/config_cli_default.yml
Bundle:
- references/config-profiles.md — pick a starting profile.
- references/composing-config.md — holistic config map
(
general,llms,functions,workflow, telemetry,aiq_api) and how to tune them. - references/env-vars.md — environment variables by config feature.
- references/config-schema.md — validator checks only.
- assets/config-scaffold.yml — fallback scaffold.
Workflow
- Scaffold —
cp configs/<profile>.yml configs/config_<name>.yml(or assets/config-scaffold.yml + merge blocks). - Compose — references/composing-config.md:
adjust registry, tools, agents, LLMs, telemetry,
aiq_api, workflow flags. Useconfig_web_default_llamaindex.ymlas the live default for webgeneral:blocks;configuration-reference.mdfor every option. Use references/env-vars.md for feature-specific env vars. - Validate (required) —
uv run python .agents/skills/aiq-configure-workflow/scripts/validate_config.py configs/config_<name>.yml
Fix every ERROR:; re-run until exit code 0. Then hand off to aiq-deploy or:
dotenv -f deploy/.env run nat serve --config_file configs/config_<name>.yml --port 8000
Validation
uv run python .agents/skills/aiq-configure-workflow/scripts/validate_config.py <config.yml>
See references/config-schema.md. Expected: exit 0.
Common Mistakes
- Skipping
validate_config.pyon a new config. - Undefined
llms:alias or registry tool not declared underfunctions:. - Missing functions required by the selected workflow: the chat workflow needs
intent_classifier,shallow_research_agent, anddeep_research_agent; the direct DS workflow needsdata_science_agent. use_async_deep_research: truewithoutgeneral.front_end(aiq_api).- Inventing feature YAML — copy from a shipped profile.
Related Skills
aiq-deployaiq-researchaiq-customize-prompts-modelsaiq-add-toolaiq-add-data-sourceaiq-release-qaaiq-prepare-pr