|
1 | 1 |  |
2 | 2 |
|
3 | | -# Langfuse Python SDK |
| 3 | +# Langfuse Python SDK (legacy v2) |
4 | 4 |
|
5 | 5 | [](https://opensource.org/licenses/MIT) |
6 | 6 | [](https://github.com/langfuse/langfuse-python/actions/workflows/ci.yml?query=branch%3Amain) |
|
9 | 9 | [](https://discord.gg/7NXusRtqYU) |
10 | 10 | [](https://www.ycombinator.com/companies/langfuse) |
11 | 11 |
|
12 | | -## Installation |
13 | | - |
14 | 12 | > [!IMPORTANT] |
15 | | -> The SDK was rewritten in v2 and released on December 17, 2023. Refer to the [v2 migration guide](https://langfuse.com/docs/sdk/python/low-level-sdk#upgrading-from-v1xx-to-v2xx) for instructions on updating your code. |
| 13 | +> **`langfuse` v2 is not the latest Langfuse Python SDK.** This branch publishes the **deprecated** v2 client (`Langfuse()`, `trace()`, `span()`, `generation()`, `api.trace.list`). Unpinned `pip install langfuse` installs the current v4. Do **not** use v2 for new instrumentation. |
| 14 | +> |
| 15 | +> **Latest Python SDK (OpenTelemetry)**, developed on [`main`](https://github.com/langfuse/langfuse-python/tree/main): `pip install langfuse`. Use `get_client()` + `start_as_current_observation` / `@observe`. 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). |
| 16 | +> |
| 17 | +> 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`. |
| 18 | +> |
| 19 | +> **Data freshness:** the only real-time path is OpenTelemetry ingestion (`langfuse` >= 4.7.0, or any OTel exporter sending `x-langfuse-ingestion-version: 4`) combined with the [Observations API v2](https://langfuse.com/docs/api-and-data-platform/features/observations-api) and [Metrics API v2](https://langfuse.com/docs/metrics/features/metrics-api). All other GET APIs from all SDK versions can be up to 10 minutes behind. |
16 | 20 |
|
17 | | -``` |
18 | | -pip install langfuse |
19 | | -``` |
| 21 | +## Installation |
20 | 22 |
|
21 | | -## Docs |
| 23 | +This branch is the **legacy v2** SDK, in maintenance mode with critical bug fixes only. For new work, install the current v4 (`pip install langfuse`). |
22 | 24 |
|
23 | | -- Decorators: https://langfuse.com/docs/sdk/python/decorators |
24 | | -- Low-level SDK: https://langfuse.com/docs/sdk/python/low-level-sdk |
25 | | -- Langchain integration: https://langfuse.com/docs/integrations/langchain/tracing |
| 25 | +## Docs |
26 | 26 |
|
27 | | -## Interfaces |
| 27 | +- Current SDK (v4): https://langfuse.com/docs/observability/sdk/overview |
| 28 | +- Upgrade from this major: https://langfuse.com/docs/observability/sdk/upgrade-path/python-v2-to-v3 |
| 29 | +- Machine-readable docs index (for AI agents): https://langfuse.com/llms.txt |
| 30 | +- REST API reference (Observations API v2, Metrics API v2, Scores API v3): https://api.reference.langfuse.com |
| 31 | +- Data freshness and real-time ingestion: https://langfuse.com/docs/compatibility#faq-delay |
28 | 32 |
|
29 | | -Interfaces: |
| 33 | +## Legacy v2 interfaces (do not use for new work) |
30 | 34 |
|
31 | 35 | - `@observe()` decorator ([docs](https://langfuse.com/docs/sdk/python/decorators)) |
32 | 36 | - Low-level tracing SDK ([docs](https://langfuse.com/docs/sdk/python/low-level-sdk)) |
33 | 37 | - Wrapper of Langfuse public API |
34 | 38 |
|
35 | | -Integrations |
| 39 | +Integrations (legacy) |
36 | 40 |
|
37 | 41 | - OpenAI SDK ([docs](https://langfuse.com/docs/integrations/openai)) |
38 | 42 | - LlamaIndex ([docs](https://langfuse.com/docs/integrations/llama-index)) |
|
0 commit comments