payi 0.1.0a45__tar.gz → 0.1.0a47__tar.gz

payi-0.1.0a47/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.47"
+}

{payi-0.1.0a45 → payi-0.1.0a47}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.1.0-alpha.47 (2025-02-08)
+
+Full Changelog: [v0.1.0-alpha.46...v0.1.0-alpha.47](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.46...v0.1.0-alpha.47)
+
+### Features
+
+* chore: single header names declaration ([e4f634c](https://github.com/Pay-i/pay-i-python/commit/e4f634ce5c903133278aeb29cb1a98262bcd3e0f))
+* fix linter ([912b631](https://github.com/Pay-i/pay-i-python/commit/912b6314aaa4075a79aeb378aeb9e93fff47019e))
+
+## 0.1.0-alpha.46 (2025-02-06)
+
+Full Changelog: [v0.1.0-alpha.45...v0.1.0-alpha.46](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.45...v0.1.0-alpha.46)
+
+### Features
+
+* feat: OpenAI embeddings instrumentation ([8649277](https://github.com/Pay-i/pay-i-python/commit/864927729c11c54b4505123ee9c8c3ac6fec2304))
+
 ## 0.1.0-alpha.45 (2025-02-06)
 
 Full Changelog: [v0.1.0-alpha.44...v0.1.0-alpha.45](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.44...v0.1.0-alpha.45)

{payi-0.1.0a45 → payi-0.1.0a47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: payi
-Version: 0.1.0a45
+Version: 0.1.0a47
 Summary: The official Python library for the payi API
 Project-URL: Homepage, https://github.com/Pay-i/pay-i-python
 Project-URL: Repository, https://github.com/Pay-i/pay-i-python

{payi-0.1.0a45 → payi-0.1.0a47}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "payi"
-version = "0.1.0-alpha.45"
+version = "0.1.0-alpha.47"
 description = "The official Python library for the payi API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{payi-0.1.0a45 → payi-0.1.0a47}/src/payi/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "payi"
-__version__ = "0.1.0-alpha.45"  # x-release-please-version
+__version__ = "0.1.0-alpha.47"  # x-release-please-version

{payi-0.1.0a45 → payi-0.1.0a47}/src/payi/lib/OpenAIInstrumentor.py

@@ -23,7 +23,7 @@ class OpenAiInstrumentor:
     def instrument(instrumentor: PayiInstrumentor) -> None:
         try:
             from openai import OpenAI  # type: ignore #  noqa: F401  I001
-
+            
             wrap_function_wrapper(
                 "openai.resources.chat.completions",
                 "Completions.create",
@@ -36,11 +36,63 @@ class OpenAiInstrumentor:
                 achat_wrapper(instrumentor),
             )
 
+            wrap_function_wrapper(
+                "openai.resources.embeddings",
+                "Embeddings.create",
+                embeddings_wrapper(instrumentor),
+            )
+
+            wrap_function_wrapper(
+                "openai.resources.embeddings",
+                 "AsyncEmbeddings.create",
+                aembeddings_wrapper(instrumentor),
+            )
+
         except Exception as e:
             logging.debug(f"Error instrumenting openai: {e}")
             return
 
 
+@PayiInstrumentor.payi_wrapper
+def embeddings_wrapper(
+    instrumentor: PayiInstrumentor,
+    wrapped: Any,
+    instance: Any,
+    *args: Any,
+    **kwargs: Any,
+) -> Any:
+    return instrumentor.chat_wrapper(
+        "system.openai",
+        None, # process_chat_chunk,
+        None, # process_chat_request,
+        process_ebmeddings_synchronous_response,
+        IsStreaming.false,
+        wrapped,
+        instance,
+        args,
+        kwargs,
+    )
+
+@PayiInstrumentor.payi_wrapper
+async def aembeddings_wrapper(
+    instrumentor: PayiInstrumentor,
+    wrapped: Any,
+    instance: Any,
+    *args: Any,
+    **kwargs: Any,
+) -> Any:
+    return await instrumentor.achat_wrapper(
+        "system.openai",
+        None, # process_chat_chunk,
+        None, # process_chat_request,
+        process_ebmeddings_synchronous_response,
+        IsStreaming.false,
+        wrapped,
+        instance,
+        args,
+        kwargs,
+    )
+
 @PayiInstrumentor.payi_wrapper
 def chat_wrapper(
     instrumentor: PayiInstrumentor,
@@ -52,7 +104,7 @@ def chat_wrapper(
     return instrumentor.chat_wrapper(
         "system.openai",
         process_chat_chunk,
-        process_request,
+        process_chat_request,
         process_chat_synchronous_response,
         IsStreaming.kwargs,
         wrapped,
@@ -72,7 +124,7 @@ async def achat_wrapper(
     return await instrumentor.achat_wrapper(
         "system.openai",
         process_chat_chunk,
-        process_request,
+        process_chat_request,
         process_chat_synchronous_response,
         IsStreaming.kwargs,
         wrapped,
@@ -81,11 +133,13 @@ async def achat_wrapper(
         kwargs,
     )
 
+def process_ebmeddings_synchronous_response(response: str, ingest: IngestUnitsParams, log_prompt_and_response: bool, **kwargs: Any) -> Any: #  noqa: ARG001
+    return process_chat_synchronous_response(response, ingest, log_prompt_and_response, **kwargs)
 
 def process_chat_synchronous_response(response: str, ingest: IngestUnitsParams, log_prompt_and_response: bool, **kwargs: Any) -> Any: #  noqa: ARG001
     response_dict = model_to_dict(response)
 
-    add_usage_units(response_dict["usage"], ingest["units"])
+    add_usage_units(response_dict.get("usage", {}), ingest["units"])
 
     if log_prompt_and_response:
         ingest["provider_response_json"] = [json.dumps(response_dict)]
@@ -136,7 +190,7 @@ def has_image_and_get_texts(encoding: tiktoken.Encoding, content: Union[str, 'li
         token_count = sum(len(encoding.encode(item.get("text", ""))) for item in content if item.get("type") == "text")
         return has_image, token_count
 
-def process_request(ingest: IngestUnitsParams, *args: Any, **kwargs: Any) -> None: # noqa: ARG001
+def process_chat_request(ingest: IngestUnitsParams, *args: Any, **kwargs: Any) -> None: # noqa: ARG001
     messages = kwargs.get("messages")
     if not messages or len(messages) == 0:
         return

{payi-0.1.0a45 → payi-0.1.0a47}/src/payi/lib/helpers.py

@@ -1,14 +1,22 @@
-# Step 1: Define the new methods outside of the Payi class definition
 from typing import Dict, List, Union
 
 
+class PayiHeaderNames:
+    limit_ids:str  = "xProxy-Limit-IDs"
+    request_tags:str = "xProxy-Request-Tags"
+    experience_id:str = "xProxy-Experience-ID"
+    experience_name:str = "xProxy-Experience-Name"
+    user_id:str = "xProxy-User-ID"
+    route_as_resource:str = "xProxy-RouteAs-Resource"
+    provider_base_uri = "xProxy-Provider-BaseUri"
+
 def create_limit_header_from_ids(limit_ids: List[str]) -> Dict[str, str]:
     if not isinstance(limit_ids, list):  # type: ignore
         raise TypeError("limit_ids must be a list")
 
     valid_ids = [id.strip() for id in limit_ids if isinstance(id, str) and id.strip()]  # type: ignore
 
-    return {"xProxy-Limit-IDs": ",".join(valid_ids)} if valid_ids else {}
+    return { PayiHeaderNames.limit_ids: ",".join(valid_ids) } if valid_ids else {}
 
 
 def create_request_header_from_tags(request_tags: List[str]) -> Dict[str, str]:
@@ -17,7 +25,7 @@ def create_request_header_from_tags(request_tags: List[str]) -> Dict[str, str]:
 
     valid_tags = [tag.strip() for tag in request_tags if isinstance(tag, str) and tag.strip()]  # type: ignore
 
-    return {"xProxy-Request-Tags": ",".join(valid_tags)} if valid_tags else {}
+    return { PayiHeaderNames.request_tags: ",".join(valid_tags) } if valid_tags else {}
 
 
 def create_headers(
@@ -34,10 +42,10 @@ def create_headers(
     if request_tags:
         headers.update(create_request_header_from_tags(request_tags))
     if user_id:
-        headers.update({"xProxy-User-ID": user_id})
+        headers.update({ PayiHeaderNames.user_id: user_id})
     if experience_id:
-        headers.update({"xProxy-Experience-Id": experience_id})
+        headers.update({ PayiHeaderNames.experience_id: experience_id})
     if experience_name:
-        headers.update({"xProxy-Experience-Name": experience_name})
+        headers.update({ PayiHeaderNames.experience_name: experience_name})
 
     return headers

{payi-0.1.0a45 → payi-0.1.0a47}/src/payi/lib/instrument.py

@@ -5,13 +5,14 @@ import inspect
 import logging
 import traceback
 from enum import Enum
-from typing import Any, Set, Union, Callable, Optional
+from typing import Any, Set, Union, Callable, Optional, TypedDict
 
 import nest_asyncio  # type: ignore
 from wrapt import ObjectProxy  # type: ignore
 
 from payi import Payi, AsyncPayi
 from payi.types import IngestUnitsParams
+from payi.lib.helpers import PayiHeaderNames
 from payi.types.ingest_response import IngestResponse
 from payi.types.ingest_units_params import Units
 from payi.types.pay_i_common_models_api_router_header_info_param import PayICommonModelsAPIRouterHeaderInfoParam
@@ -20,6 +21,14 @@ from .Stopwatch import Stopwatch
 from .Instruments import Instruments
 
 
+class Context(TypedDict, total=False):
+    proxy: bool
+    experience_name: Optional[str]
+    experience_id: Optional[str]
+    limit_ids: Optional['list[str]']
+    request_tags: Optional['list[str]']
+    user_id: Optional[str]
+
 class IsStreaming(Enum):
     false = 0
     true = 1 
@@ -40,7 +49,7 @@ class PayiInstrumentor:
     ):
         self._payi: Optional[Payi] = payi
         self._apayi: Optional[AsyncPayi] = apayi
-        self._context_stack: list[dict[str, Any]] = []  # Stack of context dictionaries
+        self._context_stack: list[Context] = []  # Stack of context dictionaries
         self._log_prompt_and_response: bool = log_prompt_and_response
         self._prompt_and_response_logger: Optional[Callable[[str, dict[str, str]], None]] = prompt_and_response_logger
 
@@ -212,22 +221,23 @@ class PayiInstrumentor:
 
     def _setup_call_func(
         self
-        ) -> 'tuple[dict[str, Any], Optional[str], Optional[str]]':
+        ) -> 'tuple[Context, Optional[str], Optional[str]]':
+        context: Context = {}
+
         if len(self._context_stack) > 0:
             # copy current context into the upcoming context
             context = self._context_stack[-1].copy()
-            context.pop("proxy", None)
-            previous_experience_name = context["experience_name"]
-            previous_experience_id = context["experience_id"]
+            context.pop("proxy")
+            previous_experience_name = context.get("experience_name", None)
+            previous_experience_id = context.get("experience_id", None)
         else:
-            context = {}
             previous_experience_name = None
             previous_experience_id = None
         return (context, previous_experience_name, previous_experience_id)
 
     def _init_context(
         self,
-        context: "dict[str, Any]",
+        context: Context,
         previous_experience_name: Optional[str],
         previous_experience_id: Optional[str],
         proxy: bool,
@@ -329,12 +339,12 @@ class PayiInstrumentor:
         if self._context_stack:
             self._context_stack.pop()
 
-    def set_context(self, context: "dict[str, Any]") -> None:
+    def set_context(self, context: Context) -> None:
         # Update the current top of the stack with the provided context
         if self._context_stack:
             self._context_stack[-1].update(context)
 
-    def get_context(self) -> Optional["dict[str, Any]"]:
+    def get_context(self) -> Optional[Context]:
         # Return the current top of the stack
         return self._context_stack[-1] if self._context_stack else None
 
@@ -345,11 +355,11 @@ class PayiInstrumentor:
         ingest_extra_headers: "dict[str, str]", # do not coflict potential kwargs["extra_headers"]
         **kwargs: Any,
     ) -> None:
-        limit_ids = ingest_extra_headers.pop("xProxy-Limit-IDs", None)
-        request_tags = ingest_extra_headers.pop("xProxy-Request-Tags", None)
-        experience_name = ingest_extra_headers.pop("xProxy-Experience-Name", None)
-        experience_id = ingest_extra_headers.pop("xProxy-Experience-ID", None)
-        user_id = ingest_extra_headers.pop("xProxy-User-ID", None)
+        limit_ids = ingest_extra_headers.pop(PayiHeaderNames.limit_ids, None)
+        request_tags = ingest_extra_headers.pop(PayiHeaderNames.request_tags, None)
+        experience_name = ingest_extra_headers.pop(PayiHeaderNames.experience_name, None)
+        experience_id = ingest_extra_headers.pop(PayiHeaderNames.experience_id, None)
+        user_id = ingest_extra_headers.pop(PayiHeaderNames.user_id, None)
 
         if limit_ids:
             ingest["limit_ids"] = limit_ids.split(",")
@@ -414,7 +424,7 @@ class PayiInstrumentor:
             from .OpenAIInstrumentor import OpenAiInstrumentor # noqa: I001
 
             if OpenAiInstrumentor.is_azure(instance):
-                resource = extra_headers.pop("xProxy-RouteAs-Resource", None)
+                resource = extra_headers.pop(PayiHeaderNames.route_as_resource, None)
                 if not resource:
                     logging.error("Azure OpenAI route as resource not found, not ingesting")
                     return await wrapped(*args, **kwargs)
@@ -532,7 +542,7 @@ class PayiInstrumentor:
         if category == "system.openai" and instance and hasattr(instance, "_client"):
             from .OpenAIInstrumentor import OpenAiInstrumentor
             if OpenAiInstrumentor.is_azure(instance):
-                resource = extra_headers.pop("xProxy-RouteAs-Resource", None)
+                resource = extra_headers.pop(PayiHeaderNames.route_as_resource, None)
                 if not resource:
                     logging.error("Azure OpenAI route as resource not found, not ingesting")
                     return wrapped(*args, **kwargs)
@@ -614,7 +624,7 @@ class PayiInstrumentor:
 
     @staticmethod
     def _update_headers(
-        context: "dict[str, Any]",
+        context: Context,
         extra_headers: "dict[str, str]",
     ) -> None:
         limit_ids: Optional[list[str]] = context.get("limit_ids")
@@ -625,38 +635,48 @@ class PayiInstrumentor:
 
         # Merge limits from the decorator and extra headers
         if limit_ids is not None:
-            existing_limit_ids = extra_headers.get("xProxy-Limit-IDs", None)
+            existing_limit_ids = extra_headers.get(PayiHeaderNames.limit_ids, None)
             
             if not existing_limit_ids:
-                extra_headers["xProxy-Limit-IDs"] = ",".join(limit_ids)
+                extra_headers[PayiHeaderNames.limit_ids] = ",".join(limit_ids)
             else:
                 existing_ids = existing_limit_ids.split(',')
                 combined_ids = list(set(existing_ids + limit_ids))
-                extra_headers["xProxy-Limit-IDs"] = ",".join(combined_ids)
+                extra_headers[PayiHeaderNames.limit_ids] = ",".join(combined_ids)
 
         # Merge request from the decorator and extra headers
         if request_tags is not None:
-            existing_request_tags = extra_headers.get("xProxy-Request-Tags", None)
+            existing_request_tags = extra_headers.get(PayiHeaderNames.request_tags, None)
 
             if not existing_request_tags:
-                extra_headers["xProxy-Request-Tags"] = ",".join(request_tags)
+                extra_headers[PayiHeaderNames.request_tags] = ",".join(request_tags)
             else:
                 existing_tags = existing_request_tags.split(',')
                 combined_tags = list(set(existing_tags + request_tags))
-                extra_headers["xProxy-Request-Tags"] = ",".join(combined_tags)
+                extra_headers[PayiHeaderNames.request_tags] = ",".join(combined_tags)
 
         # inner extra_headers user_id takes precedence over outer decorator user_id
-        if user_id is not None and extra_headers.get("xProxy-User-ID", None) is None:
-            extra_headers["xProxy-User-ID"] = user_id   
+        if user_id is not None and extra_headers.get(PayiHeaderNames.user_id, None) is None:
+            extra_headers[PayiHeaderNames.user_id] = user_id   
 
         # inner extra_headers experience_name and experience_id take precedence over outer decorator experience_name and experience_id
         # if either inner value is specified, ignore outer decorator values
-        if extra_headers.get("xProxy-Experience-Name", None) is None and extra_headers.get("xProxy-Experience-ID", None) is None:
-            if experience_name is not None:
-                extra_headers["xProxy-Experience-Name"] = experience_name
+        if PayiHeaderNames.experience_name not in extra_headers and PayiHeaderNames.experience_id not in extra_headers:
 
+            # use both decorator values
+            if experience_name is not None:
+                extra_headers[PayiHeaderNames.experience_name] = experience_name
             if experience_id is not None:
-                extra_headers["xProxy-Experience-ID"] = experience_id
+                extra_headers[PayiHeaderNames.experience_id] = experience_id
+        
+        elif PayiHeaderNames.experience_id in extra_headers and PayiHeaderNames.experience_name not in extra_headers:
+            # use the decorator experience name and the inner experience id
+            if experience_name is not None:
+                extra_headers[PayiHeaderNames.experience_name] = experience_name
+        
+        else:
+            # use the inner experience name and id as-is
+            ...
 
     @staticmethod
     def update_for_vision(input: int, units: 'dict[str, Units]') -> int:

payi-0.1.0a45/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.1.0-alpha.45"
-}