langtrace-python-sdk 2.1.14__tar.gz → 2.1.16__tar.gz

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: langtrace-python-sdk
-Version: 2.1.14
+Version: 2.1.16
 Summary: Python SDK for LangTrace
 Project-URL: Homepage, https://github.com/Scale3-Labs/langtrace-python-sdk
 Author-email: Scale3 Labs <engineering@scale3labs.com>
@@ -42,7 +42,7 @@ Description-Content-Type: text/markdown
 
 ## Open Source & Open Telemetry(OTEL) Observability for LLM applications
 
-![Static Badge](https://img.shields.io/badge/License-AGPL--3.0-blue) ![Static Badge](https://img.shields.io/badge/npm_@langtrase/typescript--sdk-1.2.9-green) ![Static Badge](https://img.shields.io/badge/pip_langtrace--python--sdk-1.2.8-green) ![Static Badge](https://img.shields.io/badge/Development_status-Active-green)
+![Static Badge](https://img.shields.io/badge/License-Apache--2.0-blue) ![Static Badge](https://img.shields.io/badge/npm_@langtrase/typescript--sdk-1.2.9-green) ![Static Badge](https://img.shields.io/badge/pip_langtrace--python--sdk-1.2.8-green) ![Static Badge](https://img.shields.io/badge/Development_status-Active-green)
 
 ---
 
@@ -179,14 +179,14 @@ langtrace.init(custom_remote_exporter=<your_exporter>, batch=<True or False>)
 
 ### Configure Langtrace
 
-| Parameter                  | Type                                | Default Value                 | Description                                                                    |
-| -------------------------- | ----------------------------------- | ----------------------------- | ------------------------------------------------------------------------------ |
-| `api_key`                  | `str`                               | `LANGTRACE_API_KEY` or `None` | The API key for authentication.                                                |
-| `batch`                    | `bool`                              | `True`                        | Whether to batch spans before sending them.                                    |
-| `write_spans_to_console`   | `bool`                              | `False`                       | Whether to write spans to the console.                                         |
-| `custom_remote_exporter`   | `Optional[Exporter]`                | `None`                        | Custom remote exporter. If `None`, a default `LangTraceExporter` will be used. |
-| `api_host`                 | `Optional[str]`                     | `https://langtrace.ai/`       | The API host for the remote exporter.                                          |
-| `disable_instrumentations` | `Optional[DisableInstrumentations]` | `None`                        | You can pass an object to disable instrumentation for specific vendors ex: `{'only': ['openai']}` or `{'all_except': ['openai']}`
+| Parameter                  | Type                                | Default Value                 | Description                                                                                                                       |
+| -------------------------- | ----------------------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `api_key`                  | `str`                               | `LANGTRACE_API_KEY` or `None` | The API key for authentication.                                                                                                   |
+| `batch`                    | `bool`                              | `True`                        | Whether to batch spans before sending them.                                                                                       |
+| `write_spans_to_console`   | `bool`                              | `False`                       | Whether to write spans to the console.                                                                                            |
+| `custom_remote_exporter`   | `Optional[Exporter]`                | `None`                        | Custom remote exporter. If `None`, a default `LangTraceExporter` will be used.                                                    |
+| `api_host`                 | `Optional[str]`                     | `https://langtrace.ai/`       | The API host for the remote exporter.                                                                                             |
+| `disable_instrumentations` | `Optional[DisableInstrumentations]` | `None`                        | You can pass an object to disable instrumentation for specific vendors ex: `{'only': ['openai']}` or `{'all_except': ['openai']}` |
 
 ### Additional Customization
 
@@ -205,7 +205,30 @@ def example():
     return response
 ```
 
-- `with_additional_attributes` - this function is designed to enhance the traces by adding custom attributes to the current context. These custom attributes provide extra details about the operations being performed, making it easier to analyze and understand their behavior.
+- `inject_additional_attributes` - this function is designed to enhance the traces by adding custom attributes to the current context. These custom attributes provide extra details about the operations being performed, making it easier to analyze and understand their behavior.
+
+```python
+from langtrace_python_sdk import inject_additional_attributes
+
+
+
+def do_llm_stuff(name=""):
+    response = client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Say this is a test three times"}],
+        stream=False,
+    )
+    return response
+
+
+def main():
+  response = inject_additional_attributes(lambda: do_llm_stuff(name="llm"), {'user.id': 'userId'})
+
+  # if the function do not take arguments then this syntax will work
+  response = inject_additional_attributes(do_llm_stuff, {'user.id': 'userId'})
+```
+
+- `with_additional_attributes` - is behaving the same as `inject_additional_attributes` but as a decorator, this will be deprecated soon.
 
 ```python
 from langtrace_python_sdk import with_langtrace_root_span, with_additional_attributes
@@ -277,7 +300,6 @@ We welcome contributions to this project. To get started, fork this repository a
 
 If you want to run any of the examples go to `run_example.py` file, you will find `ENABLED_EXAMPLES`. choose the example you want to run and just toggle the flag to `True` and run the file using `python src/run_example.py`
 
-
 ---
 
 ## Security
@@ -288,5 +310,5 @@ To report security vulnerabilites, email us at <security@scale3labs.com>. You ca
 
 ## License
 
-- Langtrace application(this repository) is [licensed](https://github.com/Scale3-Labs/langtrace/blob/development/LICENSE) under the AGPL 3.0 License. You can read about this license [here](https://www.gnu.org/licenses/agpl-3.0.en.html).
+- Langtrace application is [licensed](https://github.com/Scale3-Labs/langtrace/blob/development/LICENSE) under the AGPL 3.0 License. You can read about this license [here](https://www.gnu.org/licenses/agpl-3.0.en.html).
 - Langtrace SDKs are licensed under the Apache 2.0 License. You can read about this license [here](https://www.apache.org/licenses/LICENSE-2.0).

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/README.md

@@ -2,7 +2,7 @@
 
 ## Open Source & Open Telemetry(OTEL) Observability for LLM applications
 
-![Static Badge](https://img.shields.io/badge/License-AGPL--3.0-blue) ![Static Badge](https://img.shields.io/badge/npm_@langtrase/typescript--sdk-1.2.9-green) ![Static Badge](https://img.shields.io/badge/pip_langtrace--python--sdk-1.2.8-green) ![Static Badge](https://img.shields.io/badge/Development_status-Active-green)
+![Static Badge](https://img.shields.io/badge/License-Apache--2.0-blue) ![Static Badge](https://img.shields.io/badge/npm_@langtrase/typescript--sdk-1.2.9-green) ![Static Badge](https://img.shields.io/badge/pip_langtrace--python--sdk-1.2.8-green) ![Static Badge](https://img.shields.io/badge/Development_status-Active-green)
 
 ---
 
@@ -139,14 +139,14 @@ langtrace.init(custom_remote_exporter=<your_exporter>, batch=<True or False>)
 
 ### Configure Langtrace
 
-| Parameter                  | Type                                | Default Value                 | Description                                                                    |
-| -------------------------- | ----------------------------------- | ----------------------------- | ------------------------------------------------------------------------------ |
-| `api_key`                  | `str`                               | `LANGTRACE_API_KEY` or `None` | The API key for authentication.                                                |
-| `batch`                    | `bool`                              | `True`                        | Whether to batch spans before sending them.                                    |
-| `write_spans_to_console`   | `bool`                              | `False`                       | Whether to write spans to the console.                                         |
-| `custom_remote_exporter`   | `Optional[Exporter]`                | `None`                        | Custom remote exporter. If `None`, a default `LangTraceExporter` will be used. |
-| `api_host`                 | `Optional[str]`                     | `https://langtrace.ai/`       | The API host for the remote exporter.                                          |
-| `disable_instrumentations` | `Optional[DisableInstrumentations]` | `None`                        | You can pass an object to disable instrumentation for specific vendors ex: `{'only': ['openai']}` or `{'all_except': ['openai']}`
+| Parameter                  | Type                                | Default Value                 | Description                                                                                                                       |
+| -------------------------- | ----------------------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `api_key`                  | `str`                               | `LANGTRACE_API_KEY` or `None` | The API key for authentication.                                                                                                   |
+| `batch`                    | `bool`                              | `True`                        | Whether to batch spans before sending them.                                                                                       |
+| `write_spans_to_console`   | `bool`                              | `False`                       | Whether to write spans to the console.                                                                                            |
+| `custom_remote_exporter`   | `Optional[Exporter]`                | `None`                        | Custom remote exporter. If `None`, a default `LangTraceExporter` will be used.                                                    |
+| `api_host`                 | `Optional[str]`                     | `https://langtrace.ai/`       | The API host for the remote exporter.                                                                                             |
+| `disable_instrumentations` | `Optional[DisableInstrumentations]` | `None`                        | You can pass an object to disable instrumentation for specific vendors ex: `{'only': ['openai']}` or `{'all_except': ['openai']}` |
 
 ### Additional Customization
 
@@ -165,7 +165,30 @@ def example():
     return response
 ```
 
-- `with_additional_attributes` - this function is designed to enhance the traces by adding custom attributes to the current context. These custom attributes provide extra details about the operations being performed, making it easier to analyze and understand their behavior.
+- `inject_additional_attributes` - this function is designed to enhance the traces by adding custom attributes to the current context. These custom attributes provide extra details about the operations being performed, making it easier to analyze and understand their behavior.
+
+```python
+from langtrace_python_sdk import inject_additional_attributes
+
+
+
+def do_llm_stuff(name=""):
+    response = client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Say this is a test three times"}],
+        stream=False,
+    )
+    return response
+
+
+def main():
+  response = inject_additional_attributes(lambda: do_llm_stuff(name="llm"), {'user.id': 'userId'})
+
+  # if the function do not take arguments then this syntax will work
+  response = inject_additional_attributes(do_llm_stuff, {'user.id': 'userId'})
+```
+
+- `with_additional_attributes` - is behaving the same as `inject_additional_attributes` but as a decorator, this will be deprecated soon.
 
 ```python
 from langtrace_python_sdk import with_langtrace_root_span, with_additional_attributes
@@ -237,7 +260,6 @@ We welcome contributions to this project. To get started, fork this repository a
 
 If you want to run any of the examples go to `run_example.py` file, you will find `ENABLED_EXAMPLES`. choose the example you want to run and just toggle the flag to `True` and run the file using `python src/run_example.py`
 
-
 ---
 
 ## Security
@@ -248,5 +270,5 @@ To report security vulnerabilites, email us at <security@scale3labs.com>. You ca
 
 ## License
 
-- Langtrace application(this repository) is [licensed](https://github.com/Scale3-Labs/langtrace/blob/development/LICENSE) under the AGPL 3.0 License. You can read about this license [here](https://www.gnu.org/licenses/agpl-3.0.en.html).
+- Langtrace application is [licensed](https://github.com/Scale3-Labs/langtrace/blob/development/LICENSE) under the AGPL 3.0 License. You can read about this license [here](https://www.gnu.org/licenses/agpl-3.0.en.html).
 - Langtrace SDKs are licensed under the Apache 2.0 License. You can read about this license [here](https://www.apache.org/licenses/LICENSE-2.0).

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/src/examples/langchain_example/basic.py

@@ -18,7 +18,6 @@ _ = load_dotenv(find_dotenv())
 langtrace.init()
 
 
-# @with_additional_attributes({"user.id": "1234", "user.feedback.rating": 1})
 def api_call_1():
     llm = ChatOpenAI()
     prompt = ChatPromptTemplate.from_messages(
@@ -33,7 +32,6 @@ def api_call_1():
     print(res)
 
 
-# @with_additional_attributes({"user.id": "37373", "user.feedback.rating": 1})
 def api_call_2():
     llm = ChatOpenAI()
     prompt = ChatPromptTemplate.from_messages(

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/src/examples/openai_example/chat_completion.py

@@ -13,7 +13,6 @@ langtrace.init(write_spans_to_console=False)
 client = OpenAI()
 
 
-@with_additional_attributes({"user.id": "1234", "user.feedback.rating": 1})
 def api():
     response = client.chat.completions.create(
         model="gpt-4",

langtrace_python_sdk-2.1.16/src/examples/pinecone_example/__init__.py

@@ -0,0 +1,16 @@
+from langtrace_python_sdk import (
+    get_prompt_from_registry,
+    with_langtrace_root_span,
+    with_additional_attributes,
+    inject_additional_attributes,
+)
+
+
+class PineconeRunner:
+    @with_langtrace_root_span("Pinecone")
+    def run(self):
+        from .basic import basic as do_llm_stuff
+
+        response = inject_additional_attributes(do_llm_stuff, {"user.id": 1234})
+        print(response)
+        return response

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/src/examples/pinecone_example/basic.py

@@ -7,6 +7,7 @@ from openai import OpenAI
 from pinecone import Pinecone, ServerlessSpec
 
 from langtrace_python_sdk import (
+    get_prompt_from_registry,
     langtrace,
     with_langtrace_root_span,
     with_additional_attributes,
@@ -14,7 +15,6 @@ from langtrace_python_sdk import (
 from langtrace_python_sdk.utils.with_root_span import SendUserFeedback
 
 _ = load_dotenv(find_dotenv())
-
 langtrace.init()
 
 client = OpenAI()
@@ -32,10 +32,8 @@ def create_index():
     )
 
 
-@with_additional_attributes({"db.embedding_model": "text-embedding-ada-002"})
 @with_langtrace_root_span("Pinecone Basic")
-def basic(span_id=None, trace_id=None):
-
+def basic():
     result = client.embeddings.create(
         model="text-embedding-ada-002",
         input="Some random text string goes here",
@@ -53,10 +51,7 @@ def basic(span_id=None, trace_id=None):
     resp = index.query(
         vector=embedding, top_k=1, include_values=False, namespace="test-namespace"
     )
-    SendUserFeedback().evaluate(
-        {"spanId": span_id, "traceId": trace_id, "userScore": 1, "userId": "123"}
-    )
+    # SendUserFeedback().evaluate(
+    #     {"spanId": span_id, "traceId": trace_id, "userScore": 1, "userId": "123"}
+    # )
     return [res, resp]
-
-
-# create_index()

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/src/langtrace_python_sdk/__init__.py

@@ -21,12 +21,16 @@ from langtrace_python_sdk.utils.with_root_span import (
 )
 
 from langtrace_python_sdk.utils.prompt_registry import get_prompt_from_registry
-from langtrace_python_sdk.utils.with_root_span import SendUserFeedback
+from langtrace_python_sdk.utils.with_root_span import (
+    SendUserFeedback,
+    inject_additional_attributes,
+)
 
 __all__ = [
     "langtrace",
     "with_langtrace_root_span",
     "with_additional_attributes",
+    "inject_additional_attributes",
     "get_prompt_from_registry",
     "SendUserFeedback",
 ]

{langtrace_python_sdk-2.1.14 → langtrace_python_sdk-2.1.16}/src/langtrace_python_sdk/utils/with_root_span.py

@@ -16,6 +16,7 @@ limitations under the License.
 
 import asyncio
 import os
+from deprecated import deprecated
 from functools import wraps
 from typing import Optional
 
@@ -23,9 +24,6 @@ import requests
 from opentelemetry import baggage, context, trace
 from opentelemetry.trace import SpanKind
 
-from langtrace_python_sdk.constants.exporter.langtrace_exporter import (
-    LANGTRACE_REMOTE_URL,
-)
 from langtrace_python_sdk.constants.instrumentation.common import (
     LANGTRACE_ADDITIONAL_SPAN_ATTRIBUTES_KEY,
 )
@@ -87,7 +85,14 @@ def with_langtrace_root_span(
     return decorator
 
 
+@deprecated(reason="Use inject_additional_attributes instead")
 def with_additional_attributes(attributes={}):
+    print(
+        Fore.YELLOW
+        + "with_additional_attributes is deprecated, use inject_additional_attributes instead"
+        + Fore.RESET
+    )
+
     def decorator(func):
         @wraps(func)
         def sync_wrapper(*args, **kwargs):
@@ -113,6 +118,16 @@ def with_additional_attributes(attributes={}):
     return decorator
 
 
+def inject_additional_attributes(fn, attributes=None):
+    if attributes:
+        new_ctx = baggage.set_baggage(
+            LANGTRACE_ADDITIONAL_SPAN_ATTRIBUTES_KEY, attributes
+        )
+        context.attach(new_ctx)
+
+    return fn()
+
+
 class SendUserFeedback:
     _langtrace_host: str
     _langtrace_api_key: str

langtrace_python_sdk-2.1.16/src/langtrace_python_sdk/version.py

@@ -0,0 +1 @@
+__version__ = "2.1.16"

langtrace_python_sdk-2.1.14/src/examples/pinecone_example/__init__.py

@@ -1,9 +0,0 @@
-from langtrace_python_sdk import with_langtrace_root_span
-
-
-class PineconeRunner:
-    @with_langtrace_root_span("Pinecone")
-    def run(self):
-        from .basic import basic as basic_app
-
-        basic_app()

langtrace_python_sdk-2.1.14/src/langtrace_python_sdk/version.py

@@ -1 +0,0 @@
-__version__ = "2.1.14"