Skip to content

[doc] Add YAML API documentation and quickstart example.#705

Merged
xintongsong merged 2 commits into
apache:mainfrom
wenjin272:add-yaml-doc
May 27, 2026
Merged

[doc] Add YAML API documentation and quickstart example.#705
xintongsong merged 2 commits into
apache:mainfrom
wenjin272:add-yaml-doc

Conversation

@wenjin272
Copy link
Copy Markdown
Collaborator

@wenjin272 wenjin272 commented May 25, 2026

Linked issue: #693

Purpose of change

Add YAML API documentation and quickstart example.

Tests

No

API

No

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue. and removed doc-included Your PR already contains the necessary documentation updates. labels May 25, 2026
@wenjin272 wenjin272 requested a review from xintongsong May 25, 2026 15:01
Copy link
Copy Markdown
Collaborator

@weiqingy weiqingy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

@weiqingy weiqingy May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/content/docs/development/yaml.md Outdated
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.
Copy link
Copy Markdown
Collaborator

@weiqingy weiqingy May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

@weiqingy weiqingy May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@wenjin272
Copy link
Copy Markdown
Collaborator Author

Thanks for the careful review @weiqingy! All three addressed in the latest commit:

  1. weight collision — Good catch. Bumping Memory to 8 alone would have collided with Tool Use, so I shifted the tail of the development tree: Memory → 8, Tool Use → 9, MCP → 10, Integrate with Flink → 11. Every sidebar entry now has a unique weight (1–11).
  2. dead Agent Skills link — You're right, workflow_agent.md has no Skills content. We plan to add a dedicated Agent Skills chapter later, so I've dropped the link for now and will link it once that doc lands.
  3. missing comment on the Python YAML — Mirrored the naming-constraint comment from the Java sibling onto the Python quickstart YAML. Thanks for the suggested wording.

Copy link
Copy Markdown
Collaborator

@weiqingy weiqingy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@xintongsong xintongsong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@xintongsong xintongsong merged commit e05521b into apache:main May 27, 2026
47 of 50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants