kodexa 7.4.416648957029__tar.gz → 7.4.416803490107__tar.gz

{kodexa-7.4.416648957029 → kodexa-7.4.416803490107}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kodexa
-Version: 7.4.416648957029
+Version: 7.4.416803490107
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com

{kodexa-7.4.416648957029 → kodexa-7.4.416803490107}/kodexa/model/objects.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from decimal import Decimal
 from enum import Enum
 from typing import Optional, List, Dict, Any, Set
 from typing import Union
@@ -4873,6 +4874,27 @@ class ModelUsage(BaseModel):
     interactions: Optional[List[ModelInteraction]] = None
 
 
+class AggregatedModelCost(BaseModel):
+    """
+    Represents an aggregated view of model costs grouped by modelId.
+    This class holds the sum of various token counts and other metrics.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+
+    model_id: Optional[str] = Field(None, alias="modelId")
+    total_input_tokens: Optional[int] = Field(None, alias="totalInputTokens")
+    total_output_tokens: Optional[int] = Field(None, alias="totalOutputTokens")
+    total_thinking_tokens: Optional[int] = Field(None, alias="totalThinkingTokens")
+    total_cached_tokens: Optional[int] = Field(None, alias="totalCachedTokens")
+    total_duration: Optional[int] = Field(None, alias="totalDuration")
+    total_cost: Optional[Decimal] = Field(None, alias="totalCost")
+
+
 class ExecutionEvent(BaseModel):
     """
 

{kodexa-7.4.416648957029 → kodexa-7.4.416803490107}/kodexa/platform/client.py

@@ -25,6 +25,7 @@ from pydantic_yaml import to_yaml_str
 from kodexa.model import Document
 from kodexa.model.model import Ref
 from kodexa.model.objects import (
+    AggregatedModelCost,
     PageUser,
     PageMembership,
     PageExecution,
@@ -5934,7 +5935,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             get_response.json()
         ).set_client(self.client)
 
-    def stream_filter(self, filter_string: str = "", sort=None, limit=None, page_size=5):
+    def stream_filter(self, filter_string: str = "", sort=None, limit=None, page_size=5, starting_offset: int = 0):
         """
         Stream the filter for the document family.
 
@@ -5943,11 +5944,12 @@ class DocumentStoreEndpoint(StoreEndpoint):
             sort (str, optional): Sorting order of the query. Defaults to None.
             limit (int, optional): The maximum number of items to return. Defaults to None.
             page_size (int, optional): The pagination size for the streaming
+            starting_offset (int, optional): The starting offset for the streaming
 
         Returns:
             generator: A generator of the document families.
         """
-        page = 1
+        page = starting_offset // page_size + 1
         count = 0
         if not sort:
             sort = "id"
@@ -5968,7 +5970,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             page += 1
 
     def filter(
-            self, filter_string: str = "", page: int = 1, page_size: int = 100, sort=None
+            self, filter_string: str = "", page: int = 1, page_size: int = 100, sort=None, starting_offset: int = 0
     ) -> PageDocumentFamilyEndpoint:
         """
         Filter the document family.
@@ -5978,10 +5980,11 @@ class DocumentStoreEndpoint(StoreEndpoint):
             page (int, optional): The page number to get. Defaults to 1.
             page_size (int, optional): The number of items per page. Defaults to 100.
             sort (str, optional): Sorting order of the query. Defaults to None.
-
+            starting_offset (int, optional): The starting offset for the filter (offset is 0-indexed, and over-rides the page parameter)
         Returns:
             PageDocumentFamilyEndpoint: The page of document families.
         """
+        page = starting_offset // page_size + 1
         params = {"page": page, "pageSize": page_size, "filter": filter_string}
 
         if sort is not None:
@@ -6759,6 +6762,38 @@ class ExtractionEngineEndpoint:
         return response.text
 
 
+class ModelCostsEndpoint:
+    """
+    Provides endpoint access to the model costs.
+
+    Attributes:
+        client (KodexaClient): The client to interact with the model costs.
+    """
+
+    def __init__(self, client: "KodexaClient"):
+        self.client = client
+
+    def get_model_costs(self, filters: Optional[List[str]] = None) -> List[AggregatedModelCost]:
+        """
+        Get aggregated model costs filtered by the provided query context.
+        This endpoint aggregates the model costs by modelId.
+
+        Args:
+            filters (Optional[List[str]]): The filters to apply to the model costs.
+
+        Returns:
+            List[AggregatedModelCost]: A list of aggregated model costs.
+        """
+        params = {}
+        if filters is not None:
+            params["filter"] = filters
+            
+        response = self.client.get("/api/modelCosts", params=params)
+        return [
+            AggregatedModelCost.model_validate(item)
+            for item in response.json()
+        ]
+        
 class KodexaClient:
     """
     A class to represent a Kodexa client.
@@ -6814,6 +6849,7 @@ class KodexaClient:
         self.workspaces = WorkspacesEndpoint(self)
         self.data_exceptions = DataExceptionsEndpoint(self)
         self.notes = NotesEndpoint(self)
+        self.model_costs = ModelCostsEndpoint(self)
 
     @staticmethod
     def login(url, token):

{kodexa-7.4.416648957029 → kodexa-7.4.416803490107}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kodexa"
-version = "7.4.416648957029"
+version = "7.4.416803490107"
 description = "Python SDK for the Kodexa Platform"
 authors = ["Austin Redenbaugh <austin@kodexa.com>", "Philip Dodds <philip@kodexa.com>", "Romar Cablao <rcablao@kodexa.com>", "Amadea Paula Dodds <amadeapaula@kodexa.com>"]
 readme = "README.md"