langfuse-haystack 0.4.0__tar.gz → 0.5.0__tar.gz

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## [unreleased]
+## [integrations/langfuse-v0.4.0] - 2024-09-17
+
+### 🚀 Features
+
+- Langfuse - support generation span for more LLMs (#1087)
 
 ### 🚜 Refactor
 

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: langfuse-haystack
-Version: 0.4.0
+Version: 0.5.0
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/langfuse#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
 Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/langfuse

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/example/basic_rag.py

@@ -10,6 +10,7 @@ from haystack.components.embedders import SentenceTransformersDocumentEmbedder,
 from haystack.components.generators import OpenAIGenerator
 from haystack.components.retrievers import InMemoryEmbeddingRetriever
 from haystack.document_stores.in_memory import InMemoryDocumentStore
+
 from haystack_integrations.components.connectors.langfuse import LangfuseConnector
 
 

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/example/chat.py

@@ -49,6 +49,16 @@ if __name__ == "__main__":
         ChatMessage.from_user("Tell me about {{location}}"),
     ]
 
-    response = pipe.run(data={"prompt_builder": {"template_variables": {"location": "Berlin"}, "template": messages}})
+    response = pipe.run(
+        data={
+            "prompt_builder": {
+                "template_variables": {"location": "Berlin"},
+                "template": messages,
+            },
+            "tracer": {
+                "invocation_context": {"some_key": "some_value"},
+            },
+        }
+    )
     print(response["llm"]["replies"][0])
     print(response["tracer"]["trace_url"])

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/pyproject.toml

@@ -69,8 +69,8 @@ dependencies = ["black>=23.1.0", "mypy>=1.0.0", "ruff>=0.0.243"]
 
 [tool.hatch.envs.lint.scripts]
 typing = "mypy --install-types --non-interactive --explicit-package-bases {args:src/ tests}"
-style = ["ruff check {args:. --exclude tests/}", "black --check --diff {args:.}"]
-fmt = ["black {args:.}", "ruff --fix {args:. --exclude tests/}", "style"]
+style = ["ruff check {args:}", "black --check --diff {args:.}"]
+fmt = ["black {args:.}", "ruff check --fix {args:}", "style"]
 all = ["style", "typing"]
 
 [tool.hatch.metadata]
@@ -84,7 +84,10 @@ skip-string-normalization = true
 [tool.ruff]
 target-version = "py38"
 line-length = 120
-lint.select = [
+exclude = ["example", "tests"]
+
+[tool.ruff.lint]
+select = [
   "A",
   "ARG",
   "B",
@@ -110,8 +113,7 @@ lint.select = [
   "W",
   "YTT",
 ]
-
-lint.ignore = [
+ignore = [
   # Allow non-abstract empty methods in abstract base classes
   "B027",
   # Ignore checks for possible passwords
@@ -127,14 +129,13 @@ lint.ignore = [
   # Asserts
   "S101",
 ]
-lint.unfixable = [
+unfixable = [
   # Don't touch unused imports
   "F401",
 ]
-extend-exclude = ["tests", "example"]
 
 [tool.ruff.lint.isort]
-known-first-party = ["src"]
+known-first-party = ["haystack_integrations"]
 
 [tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "parents"

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/src/haystack_integrations/components/connectors/langfuse/langfuse_connector.py

@@ -1,8 +1,12 @@
-from haystack import component, tracing
+from typing import Any, Dict, Optional
+
+from haystack import component, logging, tracing
 
 from haystack_integrations.tracing.langfuse import LangfuseTracer
 from langfuse import Langfuse
 
+logger = logging.getLogger(__name__)
+
 
 @component
 class LangfuseConnector:
@@ -105,12 +109,20 @@ class LangfuseConnector:
         tracing.enable_tracing(self.tracer)
 
     @component.output_types(name=str, trace_url=str)
-    def run(self):
+    def run(self, invocation_context: Optional[Dict[str, Any]] = None):
         """
         Runs the LangfuseConnector component.
 
+        :param invocation_context: A dictionary with additional context for the invocation. This parameter
+            is useful when users want to mark this particular invocation with additional information, e.g.
+            a run id from their own execution framework, user id, etc. These key-value pairs are then visible
+            in the Langfuse traces.
         :returns: A dictionary with the following keys:
             - `name`: The name of the tracing component.
             - `trace_url`: The URL to the tracing data.
         """
+        logger.debug(
+            "Langfuse tracer invoked with the following context: '{invocation_context}'",
+            invocation_context=invocation_context,
+        )
         return {"name": self.name, "trace_url": self.tracer.get_trace_url()}

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/tests/test_langfuse_span.py

@@ -3,7 +3,9 @@ import os
 os.environ["HAYSTACK_CONTENT_TRACING_ENABLED"] = "true"
 
 from unittest.mock import Mock
+
 from haystack.dataclasses import ChatMessage
+
 from haystack_integrations.tracing.langfuse.tracer import LangfuseSpan
 
 

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/tests/test_tracer.py

@@ -1,5 +1,5 @@
 import os
-from unittest.mock import Mock, MagicMock, patch
+from unittest.mock import MagicMock, Mock, patch
 
 from haystack_integrations.tracing.langfuse.tracer import LangfuseTracer
 

{langfuse_haystack-0.4.0 → langfuse_haystack-0.5.0}/tests/test_tracing.py

@@ -1,14 +1,17 @@
 import os
-import pytest
+import random
+import time
 from urllib.parse import urlparse
+
+import pytest
 import requests
-from requests.auth import HTTPBasicAuth
 from haystack import Pipeline
 from haystack.components.builders import ChatPromptBuilder
-from haystack.dataclasses import ChatMessage
-from haystack_integrations.components.connectors.langfuse import LangfuseConnector
 from haystack.components.generators.chat import OpenAIChatGenerator
+from haystack.dataclasses import ChatMessage
+from requests.auth import HTTPBasicAuth
 
+from haystack_integrations.components.connectors.langfuse import LangfuseConnector
 from haystack_integrations.components.generators.anthropic import AnthropicChatGenerator
 from haystack_integrations.components.generators.cohere import CohereChatGenerator
 
@@ -40,10 +43,19 @@ def test_tracing_integration(llm_class, env_var, expected_trace):
         ChatMessage.from_user("Tell me about {{location}}"),
     ]
 
-    response = pipe.run(data={"prompt_builder": {"template_variables": {"location": "Berlin"}, "template": messages}})
+    response = pipe.run(
+        data={
+            "prompt_builder": {"template_variables": {"location": "Berlin"}, "template": messages},
+            "tracer": {"invocation_context": {"user_id": "user_42"}},
+        }
+    )
     assert "Berlin" in response["llm"]["replies"][0].content
     assert response["tracer"]["trace_url"]
 
+    # add a random delay between 1 and 3 seconds to make sure the trace is flushed
+    # and that the trace is available in Langfuse when we fetch it below
+    time.sleep(random.uniform(1, 3))
+
     url = "https://cloud.langfuse.com/api/public/traces/"
     trace_url = response["tracer"]["trace_url"]
     uuid = os.path.basename(urlparse(trace_url).path)
@@ -58,5 +70,7 @@ def test_tracing_integration(llm_class, env_var, expected_trace):
         assert expected_trace in str(response.content)
         # check if the trace contains the expected generation span
         assert "GENERATION" in str(response.content)
+        # check if the trace contains the expected user_id
+        assert "user_42" in str(response.content)
     except requests.exceptions.RequestException as e:
         pytest.fail(f"Failed to retrieve data from Langfuse API: {e}")