Repository navigation
Conversation
Co-authored-by: hassieb.pakzad <hassieb.pakzad@clickhouse.com>
…elog Co-authored-by: hassieb.pakzad <hassieb.pakzad@clickhouse.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@claude review |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
Claude Code Review
No review was started: this request came from a bot account. Manual reviews can only be requested by someone with write access to this repository. Ask a maintainer to comment @claude review, or have your automation post the comment from a user account with write access.
Tip: disable this comment in your organization's Code Review settings.
…ullets-9ff5' into hassiebbot/max-review-fixes-8d40 # Conflicts: # content/docs/observability/sdk/upgrade-path/js-v5-to-v6.mdx # content/docs/observability/sdk/upgrade-path/python-v4-to-v5.mdx Co-authored-by: hassieb.pakzad <hassieb.pakzad@clickhouse.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d69ac17316
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <ChangelogHeader /> | ||
|
|
||
| Python SDK v5 and JS/TS SDK v6 are built for Langfuse v4. For most users, upgrading is a version bump: tracing, scoring, prompts, and the integrations work as before. | ||
| Python SDK v5 and JS/TS SDK v6 are built for Langfuse v4. They mostly remove APIs that were already deprecated, so the SDKs expose only the current, fastest APIs, and coding agents working with them default to those. For most users, upgrading is a version bump: tracing, scoring, prompts, and the integrations work as before. |
There was a problem hiding this comment.
🟡 nit (optional): "current, fastest APIs" in the new changelog intro is a vague, unsupported superlative, which the changelog guidelines in CLAUDE.md ask to avoid. Fix: drop "fastest" or name the concrete benefit (for example, the v2 observations and v3 scores endpoints).
Why this was flagged
The diff adds "so the SDKs expose only the current, fastest APIs" at 2026-10-14-python-sdk-v5-js-sdk-v6.mdx:13. CLAUDE.md's changelog rules say to be specific, avoid vague adjectives, and keep a non-marketing tone. Nothing in the entry or the linked guides backs up "fastest" with a measurement or a named endpoint. The base intro had no such claim.
Verification: nit. The diff adds a sentence at content/changelog/2026-10-14-python-sdk-v5-js-sdk-v6.mdx:13 saying the SDKs expose "only the current, fastest APIs". The base intro had no such claim. .agents/AGENTS.md line 129 says "Be specific — name actual filters, metrics, commands. Avoid vague adjectives." Nothing in the entry backs up "fastest". The impact is limited to copy quality.
33dba02
into
hassiebbot/sdk-majors-migration-guides-84a8
Applies review feedback from #4008 to the Python v4 → v5 and JS/TS v5 → v6 migration guides and to the changelog post. All anchors stay the same. Each edit replaces or deletes text inside an existing section.
Both guides
#scores-apiheading: now "api.scores.createtakes a list/array of scores".CreateScoreBatchResponse/CreateScoreBatchResults,GetScoresV3Request/GetScoresV3Response, andObservationV2(the Python batched-evaluation code comment keeps it).CreateScoreRequeststays because users import it.scores_v3.get_many_v3→scores.get_many,score_ids→id) instead of "Scores API v2/v3".Python guide: factual fix. v4 API deprecations use
typing_extensions.deprecated(..., category=None), which emits no runtime warning, and the trace IO setters are deprecated only in their docstrings. The guide no longer claims these raisedDeprecationWarningand points to type checkers instead.blocked_instrumentation_scopes, which does warn at runtime, is unchanged.Changelog
Relation to #4042: this branch merges in #4042 (checklists as plain bullets), with this PR's wording on the
api.scores.createchecklist item. It merges cleanly whether or not #4042 merges first.Verification
pnpm run format:check: "All matched files use Prettier code style!"node scripts/check-h1-headings.js: success.The PR appears safe to merge, with a non-blocking correction to the Python intro’s warning advice.
Summary
This PR makes the SDK migration guides clearer and updates the changelog.
hassiebp explicitly describes the removal of type-name documentation as intentional in the PR description.
Reviews (1) · Last reviewed commit: "docs: address review feedback on SDK v5/..." · Reviewed by Greptile