payi 0.1.0a50__tar.gz → 0.1.0a52__tar.gz

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

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

{payi-0.1.0a50 → payi-0.1.0a52}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.0-alpha.52 (2025-02-20)
+
+Full Changelog: [v0.1.0-alpha.51...v0.1.0-alpha.52](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.51...v0.1.0-alpha.52)
+
+### Features
+
+* feat: ingest support for resource scope ([e2b4ce8](https://github.com/Pay-i/pay-i-python/commit/e2b4ce847b3f54df1bc5be7a78cf81dccd80c88c))
+
+## 0.1.0-alpha.51 (2025-02-20)
+
+Full Changelog: [v0.1.0-alpha.50...v0.1.0-alpha.51](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.50...v0.1.0-alpha.51)
+
+### Features
+
+* **api:** manual updates ([#235](https://github.com/Pay-i/pay-i-python/issues/235)) ([92e6b3c](https://github.com/Pay-i/pay-i-python/commit/92e6b3c9328caae24efbb75214f5f5087bfd57ec))
+
 ## 0.1.0-alpha.50 (2025-02-14)
 
 Full Changelog: [v0.1.0-alpha.49...v0.1.0-alpha.50](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.49...v0.1.0-alpha.50)

{payi-0.1.0a50 → payi-0.1.0a52}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: payi
-Version: 0.1.0a50
+Version: 0.1.0a52
 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.0a50 → payi-0.1.0a52}/pyproject.toml

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

{payi-0.1.0a50 → payi-0.1.0a52}/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.50"  # x-release-please-version
+__version__ = "0.1.0-alpha.52"  # x-release-please-version

{payi-0.1.0a50 → payi-0.1.0a52}/src/payi/lib/helpers.py

@@ -1,4 +1,3 @@
-from enum import Enum
 from typing import Dict, List, Union
 
 PAYI_BASE_URL = "https://api.pay-i.com"
@@ -11,12 +10,13 @@ class PayiHeaderNames:
     user_id:str = "xProxy-User-ID"
     route_as_resource:str = "xProxy-RouteAs-Resource"
     provider_base_uri = "xProxy-Provider-BaseUri"
+    resource_scope:str = "xProxy-Resource-Scope"
 
-class PayiCategories(Enum):
-    anthropic = "system.anthropic"
-    openai = "system.openai"
-    azure_openai = "system.azureopenai"
-    aws_bedrock = "system.aws.bedrock"
+class PayiCategories:
+    anthropic:str  = "system.anthropic"
+    openai:str = "system.openai"
+    azure_openai:str = "system.azureopenai"
+    aws_bedrock:str = "system.aws.bedrock"
 
 def create_limit_header_from_ids(limit_ids: List[str]) -> Dict[str, str]:
     if not isinstance(limit_ids, list):  # type: ignore

{payi-0.1.0a50 → payi-0.1.0a52}/src/payi/lib/instrument.py

@@ -41,7 +41,7 @@ class PayiInstrumentor:
         self,
         payi: Optional[Payi],
         apayi: Optional[AsyncPayi],
-        instruments: Union[Set[PayiCategories], None] = None,
+        instruments: Union[Set[str], None] = None,
         log_prompt_and_response: bool = True,
         prompt_and_response_logger: Optional[
             Callable[[str, "dict[str, str]"], None]
@@ -56,7 +56,7 @@ class PayiInstrumentor:
         self._blocked_limits: set[str] = set()
         self._exceeded_limits: set[str] = set()
 
-        if instruments is None:
+        if instruments is None or "*" in instruments:
             self._instrument_all()
         else:
             self._instrument_specific(instruments)
@@ -66,7 +66,7 @@ class PayiInstrumentor:
         self._instrument_anthropic()
         self._instrument_aws_bedrock()
 
-    def _instrument_specific(self, instruments: Set[PayiCategories]) -> None:
+    def _instrument_specific(self, instruments: Set[str]) -> None:
         if PayiCategories.openai in instruments or PayiCategories.azure_openai in instruments:
             self._instrument_openai()
         if PayiCategories.anthropic in instruments:
@@ -375,14 +375,18 @@ class PayiInstrumentor:
         if len(ingest_extra_headers) > 0:
             ingest["provider_request_headers"] = [PayICommonModelsAPIRouterHeaderInfoParam(name=k, value=v) for k, v in ingest_extra_headers.items()]
 
-        provider_prompt = {}
+        provider_prompt: "dict[str, Any]" = {}
         for k, v in kwargs.items():
             if k == "messages":
                 provider_prompt[k] = [m.model_dump() if hasattr(m, "model_dump") else m for m in v]
             elif k in ["extra_headers", "extra_query"]:
                 pass
             else:
-                provider_prompt[k] = v
+                try:
+                    json.dumps(v)
+                    provider_prompt[k] = v
+                except (TypeError, ValueError):
+                    pass
 
         if self._log_prompt_and_response:
             ingest["provider_request_json"] = json.dumps(provider_prompt)
@@ -420,18 +424,28 @@ class PayiInstrumentor:
         ingest: IngestUnitsParams = {"category": category, "units": {}} # type: ignore
         ingest["resource"] = kwargs.get("model", "")
 
-        if category == "system.openai" and instance and hasattr(instance, "_client"):
+        if category == PayiCategories.openai and instance and hasattr(instance, "_client"):
             from .OpenAIInstrumentor import OpenAiInstrumentor # noqa: I001
 
             if OpenAiInstrumentor.is_azure(instance):
-                resource = extra_headers.pop(PayiHeaderNames.route_as_resource, None)
-                if not resource:
+                route_as_resource = extra_headers.pop(PayiHeaderNames.route_as_resource, None)
+                resource_scope = extra_headers.pop(PayiHeaderNames.resource_scope, None)
+
+                if not route_as_resource:
                     logging.error("Azure OpenAI route as resource not found, not ingesting")
                     return await wrapped(*args, **kwargs)
 
-                category = "system.azureopenai"
+                if resource_scope:
+                    if not(resource_scope in ["global", "datazone"] or resource_scope.startswith("region")):
+                        logging.error("Azure OpenAI invalid resource scope, not ingesting")
+                        return wrapped(*args, **kwargs)
+
+                    ingest["resource_scope"] = resource_scope
+
+                category = PayiCategories.azure_openai
+
                 ingest["category"] = category
-                ingest["resource"] = resource
+                ingest["resource"] = route_as_resource
 
         current_frame = inspect.currentframe()
         # f_back excludes the current frame, strip() cleans up whitespace and newlines
@@ -511,7 +525,7 @@ class PayiInstrumentor:
     ) -> Any:
         context = self.get_context()
 
-        is_bedrock:bool = category == "system.aws.bedrock"
+        is_bedrock:bool = category == PayiCategories.aws_bedrock
 
         if not context:
             if is_bedrock:
@@ -539,17 +553,28 @@ class PayiInstrumentor:
         else:
             ingest["resource"] = kwargs.get("model", "")
 
-        if category == "system.openai" and instance and hasattr(instance, "_client"):
-            from .OpenAIInstrumentor import OpenAiInstrumentor
+        if category == PayiCategories.openai and instance and hasattr(instance, "_client"):
+            from .OpenAIInstrumentor import OpenAiInstrumentor # noqa: I001
+
             if OpenAiInstrumentor.is_azure(instance):
-                resource = extra_headers.pop(PayiHeaderNames.route_as_resource, None)
-                if not resource:
+                route_as_resource:str = extra_headers.pop(PayiHeaderNames.route_as_resource, None)
+                resource_scope:str = extra_headers.pop(PayiHeaderNames.resource_scope, None)
+
+                if not route_as_resource:
                     logging.error("Azure OpenAI route as resource not found, not ingesting")
                     return wrapped(*args, **kwargs)
 
-                category = "system.azureopenai"
+                if resource_scope:
+                    if not(resource_scope in ["global", "datazone"] or resource_scope.startswith("region")):
+                        logging.error("Azure OpenAI invalid resource scope, not ingesting")
+                        return wrapped(*args, **kwargs)
+
+                    ingest["resource_scope"] = resource_scope
+
+                category = PayiCategories.azure_openai
+
                 ingest["category"] = category
-                ingest["resource"] = resource
+                ingest["resource"] = route_as_resource
 
         current_frame = inspect.currentframe()
         # f_back excludes the current frame, strip() cleans up whitespace and newlines
@@ -864,7 +889,7 @@ _instrumentor: Optional[PayiInstrumentor] = None
 
 def payi_instrument(
     payi: Optional[Union[Payi, AsyncPayi, 'list[Union[Payi, AsyncPayi]]']] = None,
-    instruments: Optional[Set[PayiCategories]] = None,
+    instruments: Optional[Set[str]] = None,
     log_prompt_and_response: bool = True,
     prompt_and_response_logger: Optional[Callable[[str, "dict[str, str]"], None]] = None,
 ) -> None:

{payi-0.1.0a50 → payi-0.1.0a52}/src/payi/resources/ingest.py

@@ -101,11 +101,12 @@ class IngestResource(SyncAPIResource):
         provider_response_json: Union[str, List[str], None] | NotGiven = NOT_GIVEN,
         provider_uri: Optional[str] | NotGiven = NOT_GIVEN,
         time_to_first_token_ms: Optional[int] | NotGiven = NOT_GIVEN,
-        limit_ids: Union[list[str], None] | NotGiven = NOT_GIVEN,
-        request_tags: Union[list[str], None] | NotGiven = NOT_GIVEN,
-        experience_id: Union[str, None] | NotGiven = NOT_GIVEN,
-        experience_name: Union[str, None] | NotGiven = NOT_GIVEN,
-        user_id: Union[str, None] | NotGiven = NOT_GIVEN,
+        limit_ids: Optional[list[str]] | NotGiven = NOT_GIVEN,
+        request_tags: Optional[list[str]] | NotGiven = NOT_GIVEN,
+        experience_id: Optional[str] | NotGiven = NOT_GIVEN,
+        experience_name: Optional[str] | NotGiven = NOT_GIVEN,
+        user_id: Optional[str] | NotGiven = NOT_GIVEN,
+        resource_scope: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -136,6 +137,8 @@ class IngestResource(SyncAPIResource):
           experience_id (str, optional): The experience instance id
 
           user_id (str, optional): The user id
+          
+          resource_scope(str, optional): The scope of the resource
 
           extra_headers (Dict[str, str], optional): Additional headers for the request. Defaults to None.
 
@@ -176,17 +179,17 @@ class IngestResource(SyncAPIResource):
             user_id = NOT_GIVEN
 
         extra_headers = {
-            **strip_not_given(
-                {
-                    "xProxy-Limit-IDs": valid_ids_str,
-                    "xProxy-Request-Tags": valid_tags_str,
-                    "xProxy-Experience-Id": experience_id,
-                    "xProxy-Experience-Name": experience_name,
-                    "xProxy-User-ID": user_id,
-                }
-            ),
+            **{key: value for key, value in strip_not_given({
+                "xProxy-Limit-IDs": valid_ids_str,
+                "xProxy-Request-Tags": valid_tags_str,
+                "xProxy-Experience-Name": experience_name,
+                "xProxy-Experience-Id": experience_id,
+                "xProxy-User-ID": user_id,
+                "xProxy-Resource-Scope": resource_scope,
+            }).items() if value is not None},  # Ensure no 'None' values are included
             **(extra_headers or {}),
         }
+
         return self._post(
             "/api/v1/ingest",
             body=maybe_transform(
@@ -286,11 +289,12 @@ class AsyncIngestResource(AsyncAPIResource):
         provider_response_json: Union[str, List[str], None] | NotGiven = NOT_GIVEN,
         provider_uri: Optional[str] | NotGiven = NOT_GIVEN,
         time_to_first_token_ms: Optional[int] | NotGiven = NOT_GIVEN,
-        limit_ids: Union[list[str], None] | NotGiven = NOT_GIVEN,
-        request_tags: Union[list[str], None] | NotGiven = NOT_GIVEN,
-        experience_name: Union[str, None] | NotGiven = NOT_GIVEN,
-        experience_id: Union[str, None] | NotGiven = NOT_GIVEN,
-        user_id: Union[str, None] | NotGiven = NOT_GIVEN,
+        limit_ids: Optional[list[str]] | NotGiven = NOT_GIVEN,
+        request_tags: Optional[list[str]] | NotGiven = NOT_GIVEN,
+        experience_name: Optional[str] | NotGiven = NOT_GIVEN,
+        experience_id: Optional[str] | NotGiven = NOT_GIVEN,
+        user_id: Optional[str] | NotGiven = NOT_GIVEN,
+        resource_scope: Union[str, None] | NotGiven = NOT_GIVEN,
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
@@ -320,6 +324,8 @@ class AsyncIngestResource(AsyncAPIResource):
           experience_id (str, optional): The experience instance id
 
           user_id (str, optional): The user id
+          
+          resource_scope (str, optional): The scope of the resource
 
           extra_headers (Dict[str, str], optional): Additional headers for the request. Defaults to None.
 
@@ -360,15 +366,14 @@ class AsyncIngestResource(AsyncAPIResource):
             user_id = NOT_GIVEN
 
         extra_headers = {
-            **strip_not_given(
-                {
-                    "xProxy-Limit-IDs": valid_ids_str,
-                    "xProxy-Request-Tags": valid_tags_str,
-                    "xProxy-Experience-Name": experience_name,
-                    "xProxy-Experience-Id": experience_id,
-                    "xProxy-User-ID": user_id,
-                }
-            ),
+            **{key: value for key, value in strip_not_given({
+                "xProxy-Limit-IDs": valid_ids_str,
+                "xProxy-Request-Tags": valid_tags_str,
+                "xProxy-Experience-Name": experience_name,
+                "xProxy-Experience-Id": experience_id,
+                "xProxy-User-ID": user_id,
+                "xProxy-Resource-Scope": resource_scope,
+            }).items() if value is not None},  # Ensure no 'None' values are included
             **(extra_headers or {}),
         }
         return await self._post(

{payi-0.1.0a50 → payi-0.1.0a52}/src/payi/types/ingest_event_param.py

@@ -25,8 +25,6 @@ class IngestEventParam(TypedDict, total=False):
 
     units: Required[Dict[str, Units]]
 
-    csat_rating: Optional[int]
-
     end_to_end_latency_ms: Optional[int]
 
     event_timestamp: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]

{payi-0.1.0a50 → payi-0.1.0a52}/src/payi/types/ingest_units_params.py

@@ -51,6 +51,8 @@ class IngestUnitsParams(TypedDict, total=False):
 
     experience_id: Annotated[Union[str, None], PropertyInfo(alias="xProxy-Experience-Id")]
 
+    resource_scope: Annotated[Union[str, None], PropertyInfo(alias="xProxy-Resource-Scope")]
+
     user_id: Annotated[Union[str, None], PropertyInfo(alias="xProxy-User-ID")]
 
 

{payi-0.1.0a50 → payi-0.1.0a52}/tests/api_resources/test_ingest.py

@@ -113,6 +113,7 @@ class TestIngest:
             request_tags=["requestTag1", "request_tag_2"],
             experience_name="experience_name",
             experience_id="experience_id",
+            resource_scope="datazone",
             user_id="UserName123",
         )
         assert_matches_type(IngestResponse, ingest, path=["response"])
@@ -244,6 +245,7 @@ class TestAsyncIngest:
             request_tags=["requestTag1", "request_tag_2"],
             experience_name="experience_name",
             experience_id="experience_id",
+            resource_scope="datazone",
             user_id="UserName123",
         )
         assert_matches_type(IngestResponse, ingest, path=["response"])

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

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