lmnr 0.3.0b1__py3-none-any.whl → 0.3.1__py3-none-any.whl

lmnr/__init__.py

@@ -1,4 +1,5 @@
 from .sdk.client import Laminar
 from .sdk.decorators import observe, lmnr_context, wrap_llm_call
 from .sdk.interface import trace, TraceContext, SpanContext
+from .sdk.tracing_types import EvaluateEvent
 from .sdk.types import ChatMessage, PipelineRunError, PipelineRunResponse, NodeInput

lmnr/sdk/client.py

@@ -38,6 +38,11 @@ class Laminar:
             self.project_api_key = dotenv.get_key(
                 dotenv_path=dotenv_path, key_to_get="LMNR_PROJECT_API_KEY"
             )
+        if not self.project_api_key:
+            raise ValueError(
+                "Please initialize the Laminar object with your project API key or set "
+                "the LMNR_PROJECT_API_KEY environment variable in your environment or .env file"
+            )
 
     def run(
         self,

{lmnr-0.3.0b1.dist-info → lmnr-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lmnr
-Version: 0.3.0b1
+Version: 0.3.1
 Summary: Python SDK for Laminar AI
 License: Apache-2.0
 Author: lmnr.ai
@@ -12,7 +12,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: backoff (>=2.2.1,<3.0.0)
-Requires-Dist: black (>=24.4.2,<25.0.0)
 Requires-Dist: openai (>=1.41.1,<2.0.0)
 Requires-Dist: pydantic (>=2.7.4,<3.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
@@ -31,6 +30,24 @@ source .myenv/bin/activate  # or use your favorite env management tool
 pip install lmnr
 ```
 
+Create .env file at the root and add `LMNR_PROJECT_API_KEY` value to it.
+
+Read more [here](https://docs.lmnr.ai/api-reference/introduction#authentication) on how to get `LMNR_PROJECT_API_KEY`.
+
+## Sending events
+
+You can send events in two ways:
+- `.event(name, value)` – for a pre-defined event with one of possible values.
+- `.evaluate_event(name, data)` – for an event that our agent checks for and assigns a value from possible values.
+
+There are 3 types of events:
+- SCORE - this is an integer score where you specify inclusive minimum and maximum.
+- CLASS - this is a classifier with one of the possible values.
+- TAG - this event has no value and can be assigned to a span.
+
+Important notes:
+- If event name does not match anything pre-defined in the UI, the event won't be saved.
+- If event value (when sent with `.event()`) is not in the domain, the event won't be saved.
 
 ## Decorator instrumentation example
 
@@ -65,10 +82,11 @@ def poem_writer(topic="turbulence"):
     poem = response.choices[0].message.content
 
     if topic in poem:
-        lmnr_context.event("topic_alignment")  # send an event with a pre-defined name
+        # send an event with a pre-defined name
+        lmnr_context.event("topic_alignment", "good")
     
     # to trigger an automatic check for a possible event do:
-    lmnr_context.check_span_event("excessive_wordiness")
+    lmnr_context.evaluate_event("excessive_wordiness", poem)
 
     return poem
 
@@ -94,7 +112,7 @@ Both `TraceContext` and `SpanContext` expose the following interfaces:
 - `end(**kwargs)` – update the current span, and terminate it
 
 In addition, `SpanContext` allows you to:
-- `event(name: str, value: str | int = None)` - emit a custom event at any point
+- `event(name: str, value: str | int)` - emit a custom event at any point
 - `evaluate_event(name: str, data: str)` - register a possible event for automatic checking by Laminar.
 
 Example:
@@ -103,11 +121,11 @@ Example:
 import os
 from openai import OpenAI
 
-from lmnr import trace, TraceContext, SpanContext
+from lmnr import trace, TraceContext, SpanContext, EvaluateEvent
 client = OpenAI(api_key=os.environ["OPENAI_API_KEY"])
 
 def poem_writer(t: TraceContext, topic = "turbulence"):
-    span: SpanContext = t.span(name="poem_writer", input=None)
+    span: SpanContext = t.span(name="poem_writer", input=topic)
 
     prompt = f"write a poem about {topic}"
     messages = [
@@ -126,15 +144,19 @@ def poem_writer(t: TraceContext, topic = "turbulence"):
     )
     poem = response.choices[0].message.content
     if topic in poem:
-        llm_span.event("topic_alignment")  # send an event with a pre-defined name
+        llm_span.event("topic_alignment", "good")  # send an event with a pre-defined name
 
-    # note that you can register possible events here as well, not only `llm_span.check_span_event()`
-    llm_span.end(output=poem, check_event_names=["excessive_wordiness"])
+    # note that you can register possible events here as well,
+    # not only `llm_span.evaluate_event()`
+    llm_span.end(
+        output=poem,
+        evaluate_events=[EvaluateEvent(name="excessive_wordines", data=poem)]
+    )
     span.end(output=poem)
     return poem
 
 
-t: TraceContext = trace(user_id="user", session_id="session", release="release")
+t: TraceContext = trace(user_id="user123", session_id="session123", release="release")
 main(t, topic="laminar flow")
 t.end(success=True)
 ```
@@ -180,7 +202,4 @@ PipelineRunResponse(
 )
 ```
 
-## PROJECT_API_KEY
-
-Read more [here](https://docs.lmnr.ai/api-reference/introduction#authentication) on how to get `PROJECT_API_KEY`.
 

{lmnr-0.3.0b1.dist-info → lmnr-0.3.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
-lmnr/__init__.py,sha256=U3sQyxCHM9ojzfo05XYxM0T_Bh1StZFSp5K82NjATxc,242
+lmnr/__init__.py,sha256=zNJSRkUBTC0iKNvW7vitPS_W7uLnMc4ymAXJrnSM1gk,287
 lmnr/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lmnr/sdk/client.py,sha256=6mp4sQF1IEESPYe6ABFgchMBQBKr2AT7eqP-mIC5cEA,5482
+lmnr/sdk/client.py,sha256=e6cIvJq38a6XAU8FGWYtNXVAPlEoZEyKS7hC3M_6EkU,5749
 lmnr/sdk/collector.py,sha256=6LRmPhOcmGplUDWm_sJh0dVrLTHknd_kmq7POGuAvoQ,5338
 lmnr/sdk/constants.py,sha256=USCfwuUqRx6_0xC8WUxqGj766dInqQkWJcf8U5vPK7s,34
 lmnr/sdk/context.py,sha256=jfu2HGyZEJYSDf-LQAmmK8MKFnNhYfR66k_baQWx99s,15271
@@ -14,8 +14,8 @@ lmnr/sdk/providers/utils.py,sha256=ROt82VrvezExYOxionAynD3dp6oX5JoPW6F1ayTm7q8,9
 lmnr/sdk/tracing_types.py,sha256=RvVb8yCLjCu9DT59OX_tvUxaOTCtE6fcsDH4nMddzHA,6399
 lmnr/sdk/types.py,sha256=hVxOsa3oCQQ-8aS_WkOtErg4nHJRkBVySfYlTgDlDyk,2084
 lmnr/sdk/utils.py,sha256=1yhXtdGmVXfnc8SOQiTH_zAZGbZrzO8oaFd7q5nE7eY,3349
-lmnr-0.3.0b1.dist-info/LICENSE,sha256=67b_wJHVV1CBaWkrKFWU1wyqTPSdzH77Ls-59631COg,10411
-lmnr-0.3.0b1.dist-info/METADATA,sha256=U5UBpCkOSbDzsoQw4b4GkJxGKgMlxv8qoVRLzAVupiw,6700
-lmnr-0.3.0b1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-lmnr-0.3.0b1.dist-info/entry_points.txt,sha256=Qg7ZRax4k-rcQsZ26XRYQ8YFSBiyY2PNxYfq4a6PYXI,41
-lmnr-0.3.0b1.dist-info/RECORD,,
+lmnr-0.3.1.dist-info/LICENSE,sha256=67b_wJHVV1CBaWkrKFWU1wyqTPSdzH77Ls-59631COg,10411
+lmnr-0.3.1.dist-info/METADATA,sha256=tPHT-aNx5QDEHS6kJs7Z1gk_21_Z6y7hPfpA1klh4Cc,7505
+lmnr-0.3.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+lmnr-0.3.1.dist-info/entry_points.txt,sha256=Qg7ZRax4k-rcQsZ26XRYQ8YFSBiyY2PNxYfq4a6PYXI,41
+lmnr-0.3.1.dist-info/RECORD,,