From f788dc4f7b5b480c5d9172b83277b4fc2b24a8b3 Mon Sep 17 00:00:00 2001 From: Boris Feld Date: Mon, 14 Oct 2024 18:54:58 +0200 Subject: [PATCH] Fix reference doc for integrations (#388) * Make sure that langchain integration docstrings are updated * Fix Llamda-index integration doc not beeing generated --- .../python-sdk-docs/requirements.txt | 3 +++ .../opik/integrations/langchain/opik_tracer.py | 16 +++++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/apps/opik-documentation/python-sdk-docs/requirements.txt b/apps/opik-documentation/python-sdk-docs/requirements.txt index cfe4c10d43..1db329ea7e 100644 --- a/apps/opik-documentation/python-sdk-docs/requirements.txt +++ b/apps/opik-documentation/python-sdk-docs/requirements.txt @@ -2,3 +2,6 @@ sphinx-autobuild sphinx furo sphinx-click + +# Dependency to document LlamaIndex integration +llama_index \ No newline at end of file diff --git a/sdks/python/src/opik/integrations/langchain/opik_tracer.py b/sdks/python/src/opik/integrations/langchain/opik_tracer.py index 8fc222c2e2..0ddc8764c2 100644 --- a/sdks/python/src/opik/integrations/langchain/opik_tracer.py +++ b/sdks/python/src/opik/integrations/langchain/opik_tracer.py @@ -26,7 +26,13 @@ def _get_span_type(run: "Run") -> Literal["llm", "tool", "general"]: class OpikTracer(BaseTracer): - """Opik Tracer.""" + """Langchain Opik Tracer. + + Args: + tags: List of tags to be applied to each trace logged by the tracer. + metadata: Additional metadata for each trace logged by the tracer. + project_name: The name of the project to log data. + """ def __init__( self, @@ -35,14 +41,6 @@ def __init__( project_name: Optional[str] = None, **kwargs: Any, ) -> None: - """ - Initialize the Opik Tracer. - - Args: - tags: List of tags to be applied to each trace logged by the tracer. - metadata: Additional metadata for each trace logged by the tracer. - project_name: The name of the project to log data. - """ super().__init__(**kwargs) self._trace_default_metadata = metadata if metadata is not None else {} self._trace_default_tags = tags