payi 0.1.0a133__tar.gz → 0.1.0a134__tar.gz

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

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

{payi-0.1.0a133 → payi-0.1.0a134}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.134 (2025-10-30)
+
+Full Changelog: [v0.1.0-alpha.133...v0.1.0-alpha.134](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.133...v0.1.0-alpha.134)
+
+### Features
+
+* model mapping configuration ([#388](https://github.com/Pay-i/pay-i-python/issues/388)) ([dd3c9da](https://github.com/Pay-i/pay-i-python/commit/dd3c9da33328b8005e416341f2017dbe17c2fc1e))
+
 ## 0.1.0-alpha.133 (2025-10-30)
 
 Full Changelog: [v0.1.0-alpha.132...v0.1.0-alpha.133](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.132...v0.1.0-alpha.133)

{payi-0.1.0a133 → payi-0.1.0a134}/PKG-INFO

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

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

{payi-0.1.0a133 → payi-0.1.0a134}/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.133"  # x-release-please-version
+__version__ = "0.1.0-alpha.134"  # x-release-please-version

{payi-0.1.0a133 → payi-0.1.0a134}/src/payi/lib/AnthropicInstrumentor.py

@@ -195,15 +195,26 @@ class _AnthropicProviderRequest(_ProviderRequest):
 
         return None
 
+    def _update_resource_name(self, model: str) -> str:
+        return ("anthropic." if self._is_vertex else "") + model
+
     @override
-    def process_request(self, instance: Any, extra_headers: 'dict[str, str]', args: Sequence[Any], kwargs: Any) -> bool:
-        self._ingest["resource"] = ("anthropic." if self._is_vertex else "") + kwargs.get("model", "")
+    def process_request(self, instance: Any, extra_headers: 'dict[str, str]',  args: Sequence[Any], kwargs: Any) -> bool:
+        self._ingest["resource"] = self._update_resource_name(kwargs.get("model", ""))
+
+        if self._price_as.resource_scope:
+            self._ingest["resource_scope"] = self._price_as.resource_scope
+        
+        # override defaults
+        if self._price_as.category:
+            self._ingest["category"] = self._price_as.category
+        if self._price_as.resource:
+            self._ingest["resource"] = self._update_resource_name(self._price_as.resource)
 
         self._instrumentor._logger.debug(f"Processing anthropic request: model {self._ingest['resource']}, category {self._category}")
 
         messages = kwargs.get("messages")
         if messages:
-
             anthropic_has_image_and_get_texts(self, messages)
 
         return True

{payi-0.1.0a133 → payi-0.1.0a134}/src/payi/lib/BedrockInstrumentor.py

@@ -1,6 +1,6 @@
 import os
 import json
-from typing import TYPE_CHECKING, Any, Optional, Sequence
+from typing import TYPE_CHECKING, Any, Dict, Optional, Sequence
 from functools import wraps
 from typing_extensions import override
 
@@ -12,6 +12,7 @@ from payi.types.pay_i_common_models_api_router_header_info_param import PayIComm
 
 from .instrument import (
     PayiInstrumentAwsBedrockConfig,
+    _Context,
     _ChunkResult,
     _IsStreaming,
     _StreamingType,
@@ -35,8 +36,31 @@ class BedrockInstrumentor:
 
     _guardrail_trace: bool = True
 
+    _model_mapping: Dict[str, _Context] = {}
+
+    @staticmethod
+    def get_mapping(model_id: Optional[str]) -> _Context:
+        if not model_id:
+            return  {}
+
+        return BedrockInstrumentor._model_mapping.get(model_id, {})
+
+    @staticmethod
+    def configure(aws_config: Optional[PayiInstrumentAwsBedrockConfig]) -> None:
+        if not aws_config:
+            return
+        
+        trace = aws_config.get("guardrail_trace", True)
+        if trace is None:
+            trace = True
+        BedrockInstrumentor._guardrail_trace = trace
+
+        model_mappings = aws_config.get("model_mappings", [])
+        if model_mappings:
+            BedrockInstrumentor._model_mapping = _PayiInstrumentor._model_mapping_to_context_dict(model_mappings)
+
     @staticmethod
-    def instrument(instrumentor: _PayiInstrumentor, aws_config: Optional[PayiInstrumentAwsBedrockConfig]) -> None:
+    def instrument(instrumentor: _PayiInstrumentor) -> None:
         BedrockInstrumentor._instrumentor = instrumentor
 
         BedrockInstrumentor._module_version = get_version_helper(BedrockInstrumentor._module_name)
@@ -58,9 +82,6 @@ class BedrockInstrumentor:
             instrumentor._logger.debug(f"Error instrumenting bedrock: {e}")
             return
 
-        if aws_config:
-            BedrockInstrumentor._guardrail_trace = aws_config.get("guardrail_trace", True)
-
 @_PayiInstrumentor.payi_wrapper
 def create_client_wrapper(instrumentor: _PayiInstrumentor, wrapped: Any, instance: Any, *args: Any, **kwargs: Any) -> Any: #  noqa: ARG001
     if kwargs.get("service_name") != "bedrock-runtime":
@@ -69,10 +90,10 @@ def create_client_wrapper(instrumentor: _PayiInstrumentor, wrapped: Any, instanc
 
     try:
         client: Any = wrapped(*args, **kwargs)
-        client.invoke_model = wrap_invoke(instrumentor, client.invoke_model)
-        client.invoke_model_with_response_stream = wrap_invoke_stream(instrumentor, client.invoke_model_with_response_stream)
-        client.converse = wrap_converse(instrumentor, client.converse)
-        client.converse_stream = wrap_converse_stream(instrumentor, client.converse_stream)
+        client.invoke_model = wrap_invoke(instrumentor, client.invoke_model, client)
+        client.invoke_model_with_response_stream = wrap_invoke_stream(instrumentor, client.invoke_model_with_response_stream, client)
+        client.converse = wrap_converse(instrumentor, client.converse, client)
+        client.converse_stream = wrap_converse_stream(instrumentor, client.converse_stream, client)
 
         instrumentor._logger.debug(f"Instrumented bedrock client")
 
@@ -221,7 +242,7 @@ class InvokeResponseWrapper(ObjectProxy): # type: ignore
 
         return data # type: ignore
 
-def wrap_invoke(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
+def wrap_invoke(instrumentor: _PayiInstrumentor, wrapped: Any, instance: Any) -> Any:
     @wraps(wrapped)
     def invoke_wrapper(*args: Any, **kwargs: 'dict[str, Any]') -> Any:
         modelId:str = kwargs.get("modelId", "") # type: ignore
@@ -230,14 +251,14 @@ def wrap_invoke(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
             _BedrockInvokeProviderRequest(instrumentor=instrumentor, model_id=modelId),
             _IsStreaming.false,
             wrapped,
-            None,
+            instance,
             args,
             kwargs,
         )   
     
     return invoke_wrapper
 
-def wrap_invoke_stream(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
+def wrap_invoke_stream(instrumentor: _PayiInstrumentor, wrapped: Any, instance: Any) -> Any:
     @wraps(wrapped)
     def invoke_wrapper(*args: Any, **kwargs: Any) -> Any:
         modelId: str = kwargs.get("modelId", "") # type: ignore
@@ -247,14 +268,14 @@ def wrap_invoke_stream(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
             _BedrockInvokeProviderRequest(instrumentor=instrumentor, model_id=modelId),
             _IsStreaming.true,
             wrapped,
-            None,
+            instance,
             args,
             kwargs,
         )
 
     return invoke_wrapper
 
-def wrap_converse(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
+def wrap_converse(instrumentor: _PayiInstrumentor, wrapped: Any, instance: Any) -> Any:
     @wraps(wrapped)
     def invoke_wrapper(*args: Any, **kwargs: 'dict[str, Any]') -> Any:
         modelId:str = kwargs.get("modelId", "") # type: ignore
@@ -264,14 +285,14 @@ def wrap_converse(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
             _BedrockConverseProviderRequest(instrumentor=instrumentor),
             _IsStreaming.false,
             wrapped,
-            None,
+            instance,
             args,
             kwargs,
         )
     
     return invoke_wrapper
 
-def wrap_converse_stream(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
+def wrap_converse_stream(instrumentor: _PayiInstrumentor, wrapped: Any, instance: Any) -> Any:
     @wraps(wrapped)
     def invoke_wrapper(*args: Any, **kwargs: Any) -> Any:
         modelId: str = kwargs.get("modelId", "") # type: ignore
@@ -281,7 +302,7 @@ def wrap_converse_stream(instrumentor: _PayiInstrumentor, wrapped: Any) -> Any:
             _BedrockConverseProviderRequest(instrumentor=instrumentor),
             _IsStreaming.true,
             wrapped,
-            None,
+            instance,
             args,
             kwargs,
         )
@@ -301,10 +322,25 @@ class _BedrockProviderRequest(_ProviderRequest):
             )
 
     @override
-    def process_request(self, instance: Any, extra_headers: 'dict[str, str]', args: Sequence[Any], kwargs: Any) -> bool:
-        # boto3 doesn't allow extra_headers
-        kwargs.pop("extra_headers", None)
-        self._ingest["resource"] = kwargs.get("modelId", "")
+    def process_request(self, instance: Any, extra_headers: 'dict[str, str]',  args: Sequence[Any], kwargs: Any) -> bool:
+        modelId =  kwargs.get("modelId", "")
+        self._ingest["resource"] = modelId
+
+        if not self._price_as.resource and not self._price_as.category and BedrockInstrumentor._model_mapping:
+            deployment = BedrockInstrumentor._model_mapping.get(modelId, {})
+            self._price_as.category = deployment.get("price_as_category", "")
+            self._price_as.resource = deployment.get("price_as_resource", "")
+            self._price_as.resource_scope = deployment.get("resource_scope", None)
+
+        if self._price_as.resource_scope:
+            self._ingest["resource_scope"] = self._price_as.resource_scope
+        
+        # override defaults
+        if self._price_as.category:
+            self._ingest["category"] = self._price_as.category
+        if self._price_as.resource:
+            self._ingest["resource"] = self._price_as.resource
+
         return True
 
     @override
@@ -384,11 +420,25 @@ class _BedrockProviderRequest(_ProviderRequest):
 class _BedrockInvokeProviderRequest(_BedrockProviderRequest):
     def __init__(self, instrumentor: _PayiInstrumentor, model_id: str):
         super().__init__(instrumentor=instrumentor)
-        self._is_anthropic: bool = 'anthropic' in model_id
-        self._is_nova: bool = 'nova' in model_id
-        self._is_meta: bool = 'meta' in model_id
-        self._is_amazon_titan_embed_text_v1: bool = 'amazon.titan-embed-text-v1' == model_id
-        self._is_cohere_embed_english_v3: bool = 'cohere.embed-english-v3' == model_id
+
+        price_as_resource = BedrockInstrumentor._model_mapping.get(model_id, {}).get("price_as_resource", None)
+        if price_as_resource:
+            model_id = price_as_resource
+
+        self._is_anthropic: bool = False
+        self._is_nova: bool = False
+        self._is_meta: bool = False
+        self._is_amazon_titan_embed_text_v1: bool = False
+        self._is_cohere_embed_english_v3: bool = False
+
+        self._assign_model_state(model_id=model_id)
+
+    def _assign_model_state(self, model_id: str) -> None:
+        self._is_anthropic = 'anthropic' in model_id
+        self._is_nova = 'nova' in model_id
+        self._is_meta = 'meta' in model_id
+        self._is_amazon_titan_embed_text_v1 = 'amazon.titan-embed-text-v1' == model_id
+        self._is_cohere_embed_english_v3 = 'cohere.embed-english-v3' == model_id
 
     @override
     def process_request(self, instance: Any, extra_headers: 'dict[str, str]', args: Sequence[Any], kwargs: Any) -> bool:
@@ -396,6 +446,10 @@ class _BedrockInvokeProviderRequest(_BedrockProviderRequest):
 
         super().process_request(instance, extra_headers, args, kwargs)
     
+        # super().process_request will assign price_as mapping from global state, so evaluate afterwards
+        if self._price_as.resource:
+            self._assign_model_state(model_id=self._price_as.resource)
+
         guardrail_id = kwargs.get("guardrailIdentifier", "")
         if guardrail_id:
             self.add_internal_request_property(PayiPropertyNames.aws_bedrock_guardrail_id, guardrail_id)
@@ -524,7 +578,7 @@ class _BedrockConverseProviderRequest(_BedrockProviderRequest):
     @override
     def process_request(self, instance: Any, extra_headers: 'dict[str, str]', args: Sequence[Any], kwargs: Any) -> bool:
         super().process_request(instance, extra_headers, args, kwargs)
-        
+
         guardrail_config = kwargs.get("guardrailConfig", {})
         if guardrail_config:
             guardrailIdentifier = guardrail_config.get("guardrailIdentifier", "")

{payi-0.1.0a133 → payi-0.1.0a134}/src/payi/lib/OpenAIInstrumentor.py

@@ -1,15 +1,23 @@
 import json
-from typing import Any, Union, Optional, Sequence
+from typing import Any, Dict, Union, Optional, Sequence
 from typing_extensions import override
 from importlib.metadata import version
 
 import tiktoken  # type: ignore
 from wrapt import wrap_function_wrapper  # type: ignore
 
-from payi.lib.helpers import PayiCategories, PayiHeaderNames
+from payi.lib.helpers import PayiCategories
 from payi.types.ingest_units_params import Units
 
-from .instrument import _ChunkResult, _IsStreaming, _StreamingType, _ProviderRequest, _PayiInstrumentor
+from .instrument import (
+    PayiInstrumentAzureOpenAiConfig,
+    _Context,
+    _ChunkResult,
+    _IsStreaming,
+    _StreamingType,
+    _ProviderRequest,
+    _PayiInstrumentor,
+)
 from .version_helper import get_version_helper
 
 
@@ -17,12 +25,20 @@ class OpenAiInstrumentor:
     _module_name: str = "openai"
     _module_version: str = ""
 
+    _azure_openai_deployments: Dict[str, _Context] = {}
+
     @staticmethod
     def is_azure(instance: Any) -> bool:
         from openai import AzureOpenAI, AsyncAzureOpenAI # type: ignore # noqa: I001
 
         return isinstance(instance._client, (AsyncAzureOpenAI, AzureOpenAI))
 
+    @staticmethod
+    def configure(azure_openai_config: Optional[PayiInstrumentAzureOpenAiConfig]) -> None:
+        if azure_openai_config:
+            model_mappings = azure_openai_config.get("model_mappings", [])
+            OpenAiInstrumentor._azure_openai_deployments = _PayiInstrumentor._model_mapping_to_context_dict(model_mappings)
+
     @staticmethod
     def instrument(instrumentor: _PayiInstrumentor) -> None:
         try:
@@ -52,7 +68,7 @@ class OpenAiInstrumentor:
                 aembeddings_wrapper(instrumentor),
             )
         except Exception as e:
-            instrumentor._logger.debug(f"Error instrumenting openai: {e}")
+            instrumentor._logger.debug(f"Error instrumenting openai completions: {e}")
 
         # responses separately as they are relatively new and the client may not be using the latest openai module
         try:            
@@ -69,7 +85,7 @@ class OpenAiInstrumentor:
             )
 
         except Exception as e:
-            instrumentor._logger.debug(f"Error instrumenting openai: {e}")
+            instrumentor._logger.debug(f"Error instrumenting openai responses: {e}")
 
 @_PayiInstrumentor.payi_wrapper
 def embeddings_wrapper(
@@ -201,44 +217,39 @@ class _OpenAiProviderRequest(_ProviderRequest):
         self._input_tokens_details_key = input_tokens_details_key
 
     @override
-    def process_request(self, instance: Any, extra_headers: 'dict[str, str]', args: Sequence[Any], kwargs: Any) -> bool: # type: ignore
-        self._ingest["resource"] = kwargs.get("model", "")
+    def process_request(self, instance: Any, extra_headers: 'dict[str, str]',  args: Sequence[Any], kwargs: Any) -> bool: # type: ignore
+        model = kwargs.get("model", "")
 
         if not (instance and hasattr(instance, "_client")) or OpenAiInstrumentor.is_azure(instance) is False:
+            self._ingest["resource"] = model
             return True
 
-        context = self._instrumentor.get_context_safe()
-        price_as_category = extra_headers.get(PayiHeaderNames.price_as_category) or context.get("price_as_category")
-        price_as_resource = extra_headers.get(PayiHeaderNames.price_as_resource) or context.get("price_as_resource")
-        resource_scope = extra_headers.get(PayiHeaderNames.resource_scope) or context.get("resource_scope")
-
-        if PayiHeaderNames.price_as_category in extra_headers:
-            del extra_headers[PayiHeaderNames.price_as_category]
-        if PayiHeaderNames.price_as_resource in extra_headers:
-            del extra_headers[PayiHeaderNames.price_as_resource]
-        if PayiHeaderNames.resource_scope in extra_headers:
-            del extra_headers[PayiHeaderNames.resource_scope]
-            
-        if not price_as_resource and not price_as_category:
+        if not self._price_as.resource and not self._price_as.category and OpenAiInstrumentor._azure_openai_deployments:
+            deployment = OpenAiInstrumentor._azure_openai_deployments.get(model, {})
+            self._price_as.category = deployment.get("price_as_category", None)
+            self._price_as.resource = deployment.get("price_as_resource", None)
+            self._price_as.resource_scope = deployment.get("resource_scope", None)
+
+        if not self._price_as.resource and not self._price_as.category:
             self._instrumentor._logger.error("Azure OpenAI requires price as resource and/or category to be specified, not ingesting")
             return False
 
-        if resource_scope:
-            if not(resource_scope in ["global", "datazone"] or resource_scope.startswith("region")):
+        if self._price_as.resource_scope:
+            if not (self._price_as.resource_scope in ["global", "datazone"] or self._price_as.resource_scope.startswith("region")):
                 self._instrumentor._logger.error("Azure OpenAI invalid resource scope, not ingesting")
                 return False
 
-            self._ingest["resource_scope"] = resource_scope
+            self._ingest["resource_scope"] = self._price_as.resource_scope
 
         self._category = PayiCategories.azure_openai
 
         self._ingest["category"] = self._category
 
-        if price_as_category:
+        if self._price_as.category:
             # price as category overrides default
-            self._ingest["category"] = price_as_category
-        if price_as_resource:
-            self._ingest["resource"] = price_as_resource
+            self._ingest["category"] = self._price_as.category
+        if self._price_as.resource:
+            self._ingest["resource"] = self._price_as.resource
 
         return True
 

{payi-0.1.0a133 → payi-0.1.0a134}/src/payi/lib/helpers.py

@@ -1,15 +1,18 @@
 import os
-from typing import Dict, List, Union
+import json
+from typing import Any, Dict, List, Union
 
 PAYI_BASE_URL = "https://api.pay-i.com"
 
 class PayiHeaderNames:
     limit_ids:str  = "xProxy-Limit-IDs"
     request_tags:str = "xProxy-Request-Tags"
+    request_properties:str = "xProxy-Request-Properties"
     use_case_id:str = "xProxy-UseCase-ID"
     use_case_name:str = "xProxy-UseCase-Name"
     use_case_version:str = "xProxy-UseCase-Version"
     use_case_step:str = "xProxy-UseCase-Step"
+    use_case_properties:str = "xProxy-UseCase-Properties"
     user_id:str = "xProxy-User-ID"
     account_name:str = "xProxy-Account-Name"
     price_as_category:str = "xProxy-PriceAs-Category"
@@ -37,6 +40,11 @@ class PayiPropertyNames:
     aws_bedrock_guardrail_version:str = "system.aws.bedrock.guardrail.version"
     aws_bedrock_guardrail_action:str = "system.aws.bedrock.guardrail.action"
 
+class PayiResourceScopes:
+    global_scope: str = "global"
+    datazone_scope: str = "datazone"
+    region_scope: str = "region"
+
 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")
@@ -53,6 +61,9 @@ def create_request_header_from_tags(*, request_tags: List[str]) -> Dict[str, str
 
     return { PayiHeaderNames.request_tags: ",".join(valid_tags) } if valid_tags else {}
 
+def _compact_json(data: Any) -> str:
+    return json.dumps(data, separators=(',', ':'))  
+
 def create_headers(
     *,
     limit_ids: Union[List[str], None] = None,
@@ -63,6 +74,8 @@ def create_headers(
     use_case_name: Union[str, None] = None,
     use_case_version: Union[int, None] = None,
     use_case_step: Union[str, None] = None,
+    use_case_properties: Union[Dict[str, str], None] = None,
+    request_properties: Union[Dict[str, str], None] = None,
     price_as_category: Union[str, None] = None,
     price_as_resource: Union[str, None] = None,
     resource_scope: Union[str, None] = None,
@@ -83,6 +96,10 @@ def create_headers(
         headers.update({ PayiHeaderNames.use_case_name: use_case_name})
     if use_case_version:
         headers.update({ PayiHeaderNames.use_case_version: str(use_case_version)})
+    if use_case_properties:
+        headers.update({ PayiHeaderNames.use_case_properties: _compact_json(use_case_properties) })
+    if request_properties:
+        headers.update({ PayiHeaderNames.request_properties: _compact_json(request_properties) })
     if use_case_step:
         headers.update({ PayiHeaderNames.use_case_step: use_case_step})
     if price_as_category: