[doc] Add YAML API documentation and quickstart example.#705
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
weiqingy
left a comment
There was a problem hiding this comment.
Thanks for putting this together — the YAML doc is dense in the right places (cross-language section + JSON Schema contract), and the quickstart mirrors the workflow-agent quickstart cleanly. Left a few comments inline on specific lines below.
| --- | ||
| title: Vector Stores | ||
| weight: 6 | ||
| weight: 7 |
There was a problem hiding this comment.
weight: 7 here ties with docs/content/docs/development/memory/_index.md, which is also pinned to weight: 7. At a tie, Hugo's sidebar order falls back to alphabetic path, so Memory and Vector Stores can swap depending on Hugo version. How do you feel about bumping Memory to 8 in the same PR so each entry in the development tree has a unique weight? Open to other ideas if there's a reason to keep Memory at 7.
| parameter_types: [java.lang.Integer, java.lang.Integer] | ||
| ``` | ||
|
|
||
| **Skills** — bundles of agent skill assets loaded from one or more sources. At least one of `paths` / `urls` / `classpath` / `package` must be non-empty; multiple sources can coexist. See [Agent Skills]({{< ref "docs/development/workflow_agent" >}}) for the skill loading model. |
There was a problem hiding this comment.
The Agent Skills cross-link here — [Agent Skills]({{< ref "docs/development/workflow_agent" >}}) — currently lands on workflow_agent.md, which doesn't have any Skills content yet (grep -i skills on that file is empty). Is there a different destination doc that's planned for the skill loading model — maybe one tracked by #696? If a Skills doc isn't on the way yet, would it work to drop the link and revisit once one lands, or do you have a different angle in mind?
| {input} | ||
|
|
||
| chat_model_setups: | ||
| - name: review_analysis_model |
There was a problem hiding this comment.
Noticed the Java sibling YAML (examples/src/main/resources/yaml/yaml_review_analysis_agent.yaml) has an inline comment right above this line explaining that processInput sends ChatRequestEvent("reviewAnalysisModel", ...) and the chat-model setup name has to match. The Python side has the same coupling — ReviewAnalysisAgent.process_input sends ChatRequestEvent(model="review_analysis_model", ...) — but the Python YAML doesn't mention it. Worth mirroring the same comment on this side so a reader who renames the setup sees the constraint upfront? Suggested wording, in case it helps:
# Action `process_input` sends `ChatRequestEvent(model="review_analysis_model", ...)`,
# so the chat-model setup MUST be named `review_analysis_model`.
chat_model_setups:
- name: review_analysis_model- Resolve the weight collision in the development tree (Memory 8, Tool Use 9, MCP 10, Integrate with Flink 11) so each sidebar entry has a unique weight and a stable order across Hugo versions. - Drop the dead Agent Skills cross-link from the YAML Skills section until a dedicated skills doc lands. - Mirror the chat-model naming-constraint comment onto the Python quickstart YAML, matching its Java sibling. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Thanks for the careful review @weiqingy! All three addressed in the latest commit:
|
Linked issue: #693
Purpose of change
Add YAML API documentation and quickstart example.
Tests
No
API
No
Documentation
doc-neededdoc-not-neededdoc-included