From 2ff0812184ad5cd7ec96413a59e20dfcf009dd02 Mon Sep 17 00:00:00 2001 From: Jay Feng <1569941651@qq.com> Date: Thu, 15 Oct 2026 16:46:28 +0800 Subject: [PATCH] docs: point the README at the v5 SDK and its migration guide The README still describes v4 as the latest SDK and only links the v2 to v3 and v3 to v4 upgrade paths, even though v5.0.1 was released on 2026-10-14 and its release notes already point at the v4 to v5 migration guide. Update the banner to name v5 as the latest SDK, link the v4 to v5 migration guide, and keep the existing history links intact. This matches the repo guidance in code_review.md ("Update README examples, .env.template, or generated reference docs when changed behavior would make them stale"). --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35b3bb5e7..d1e304e14 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ [![YC W23](https://img.shields.io/badge/Y%20Combinator-W23-orange?style=flat-square)](https://www.ycombinator.com/companies/langfuse) > [!IMPORTANT] -> The SDK was rewritten in v4 and released in March 2026. Refer to the [v4 migration guide](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4) for instructions on updating your code. +> The SDK was rewritten in v4 and released in March 2026, and v5 was released in October 2026. Refer to the [v5 migration guide](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v4-to-v5) for instructions on updating your code. > -> **This is the latest Langfuse Python SDK (v4, OpenTelemetry).** The legacy v2 client API (`trace()`, `span()`, `generation()`, `api.trace.list`) is **deprecated**. Do **not** use it for new instrumentation. +> **This is the latest Langfuse Python SDK (v5, OpenTelemetry).** The legacy v2 client API (`trace()`, `span()`, `generation()`, `api.trace.list`) is **deprecated**. Do **not** use it for new instrumentation. > -> **Latest Python SDK (OpenTelemetry):** `pip install langfuse`. Use `get_client()` + `start_as_current_observation` / `@observe`. Prompts/datasets/scores: the same `langfuse` package. Docs: https://langfuse.com/docs/observability/sdk/overview. Upgrade: [v2 to v3](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v2-to-v3), [v3 to v4](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4). +> **Latest Python SDK (OpenTelemetry):** `pip install langfuse`. Use `get_client()` + `start_as_current_observation` / `@observe`. Prompts/datasets/scores: the same `langfuse` package. Docs: https://langfuse.com/docs/observability/sdk/overview. Upgrade: [v2 to v3](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v2-to-v3), [v3 to v4](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4), [v4 to v5](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v4-to-v5). > > Query traces with [Observations API v2](https://langfuse.com/docs/api-and-data-platform/features/observations-api) (`GET /api/public/v2/observations`, [API reference](https://api.reference.langfuse.com/#tag/observationsv2)), not `GET /api/public/traces` / `api.trace.list`. >