|
| 1 | +{# |
| 2 | +Root page of https://python.reference.langfuse.com. |
| 3 | +
|
| 4 | +pdoc's default index is a bare `<meta http-equiv="refresh">` stub with no |
| 5 | +title, no links and no canonical URL, because a single root module makes |
| 6 | +`langfuse.html` the entry point. Search engines read that stub as a |
| 7 | +soft-redirecting duplicate of `/index.html`. Setting `root_module_name` to |
| 8 | +false -- the escape hatch the default template documents -- renders the real |
| 9 | +module list instead, and the `content` block below gives that page something |
| 10 | +to say, since pdoc's own version leaves the main column empty. |
| 11 | +#} |
| 12 | +{% set canonical_base_url = env.get("PDOC_CANONICAL_BASE_URL", "https://python.reference.langfuse.com/").rstrip("/") ~ "/" %} |
| 13 | +{% set root_module_name = false %} |
| 14 | +{% extends "default/index.html.jinja2" %} |
| 15 | + |
| 16 | +{% block title %}Langfuse Python SDK API reference{% endblock %} |
| 17 | + |
| 18 | +{% block head %} |
| 19 | + <link rel="canonical" href="{{ canonical_base_url }}"/> |
| 20 | + <meta name="description" |
| 21 | + content="Generated API reference for the Langfuse Python SDK: clients, tracing, prompt management, datasets, evaluation and the underlying API models."/> |
| 22 | +{% endblock %} |
| 23 | + |
| 24 | +{% block content %} |
| 25 | + <header class="pdoc"> |
| 26 | + {{ self.logo() }} |
| 27 | + {% if search %} |
| 28 | + <input type="search" placeholder="Search API Documentation..." aria-label="search box"> |
| 29 | + {% endif %} |
| 30 | + </header> |
| 31 | + <main class="pdoc"> |
| 32 | + <section> |
| 33 | + <h1>Langfuse Python SDK API reference</h1> |
| 34 | + <p> |
| 35 | + Generated reference for the <code>langfuse</code> package. It documents |
| 36 | + every public symbol; the hand-written guides on |
| 37 | + <a href="https://langfuse.com/docs">langfuse.com/docs</a> are the better |
| 38 | + starting point if you are setting Langfuse up for the first time. |
| 39 | + </p> |
| 40 | + <h2>Start here</h2> |
| 41 | + {# |
| 42 | + These keep the `.html` suffix even though the hosted site serves |
| 43 | + clean URLs. pdoc generates its own sidebar links that way, and |
| 44 | + extensionless paths 404 both under pdoc's dev server and when the |
| 45 | + built output is served locally, so the one 308 hop in production is |
| 46 | + the cheaper trade. Canonical URLs are a different case -- those must |
| 47 | + not point at a redirect, which is why they drop the suffix. |
| 48 | + #} |
| 49 | + <ul> |
| 50 | + <li><a href="langfuse.html"><code>langfuse</code></a> — the |
| 51 | + <code>Langfuse</code> client, tracing decorators and context helpers. |
| 52 | + Most code only needs this module.</li> |
| 53 | + <li><a href="langfuse/experiment.html"><code>langfuse.experiment</code></a> |
| 54 | + — running experiments over datasets and scoring the results.</li> |
| 55 | + <li><a href="langfuse/api.html"><code>langfuse.api</code></a> — the |
| 56 | + generated low-level API client and its request and response models.</li> |
| 57 | + </ul> |
| 58 | + <h2>Elsewhere</h2> |
| 59 | + <ul> |
| 60 | + <li><a href="https://langfuse.com/docs/observability/sdk/python/overview">Python SDK documentation</a></li> |
| 61 | + <li><a href="https://github.com/langfuse/langfuse-python">langfuse-python on GitHub</a></li> |
| 62 | + <li><a href="https://pypi.org/project/langfuse/">langfuse on PyPI</a></li> |
| 63 | + </ul> |
| 64 | + <p>Every module is listed in the sidebar, and the search box covers all of them.</p> |
| 65 | + </section> |
| 66 | + </main> |
| 67 | + {% if search %} |
| 68 | + {% include "search.html.jinja2" %} |
| 69 | + {% endif %} |
| 70 | +{% endblock %} |
0 commit comments