chore(closes OPEN-8647): add endpoint to retrieve aggregated user data for inference pipelines

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 26
-openapi_spec_hash: 6f6cb98b7755d18274dd51e857508336
-config_hash: cc9a32249c08143687799eb8de187d6a
+configured_endpoints: 27
+openapi_spec_hash: c70c3eccfe803e99c14e97e650b1e314
+config_hash: 1f7626e569e1a74574a58d7883170a0e

api.md

@@ -119,14 +119,19 @@ Methods:
 Types:
 
 ```python
-from openlayer.types import InferencePipelineRetrieveResponse, InferencePipelineUpdateResponse
+from openlayer.types import (
+    InferencePipelineRetrieveResponse,
+    InferencePipelineUpdateResponse,
+    InferencePipelineRetrieveUsersResponse,
+)
 ```
 
 Methods:
 
 - <code title="get /inference-pipelines/{inferencePipelineId}">client.inference_pipelines.<a href="./src/openlayer/resources/inference_pipelines/inference_pipelines.py">retrieve</a>(inference_pipeline_id, \*\*<a href="src/openlayer/types/inference_pipeline_retrieve_params.py">params</a>) -> <a href="./src/openlayer/types/inference_pipeline_retrieve_response.py">InferencePipelineRetrieveResponse</a></code>
 - <code title="put /inference-pipelines/{inferencePipelineId}">client.inference_pipelines.<a href="./src/openlayer/resources/inference_pipelines/inference_pipelines.py">update</a>(inference_pipeline_id, \*\*<a href="src/openlayer/types/inference_pipeline_update_params.py">params</a>) -> <a href="./src/openlayer/types/inference_pipeline_update_response.py">InferencePipelineUpdateResponse</a></code>
 - <code title="delete /inference-pipelines/{inferencePipelineId}">client.inference_pipelines.<a href="./src/openlayer/resources/inference_pipelines/inference_pipelines.py">delete</a>(inference_pipeline_id) -> None</code>
+- <code title="get /inference-pipelines/{inferencePipelineId}/users">client.inference_pipelines.<a href="./src/openlayer/resources/inference_pipelines/inference_pipelines.py">retrieve_users</a>(inference_pipeline_id, \*\*<a href="src/openlayer/types/inference_pipeline_retrieve_users_params.py">params</a>) -> <a href="./src/openlayer/types/inference_pipeline_retrieve_users_response.py">InferencePipelineRetrieveUsersResponse</a></code>
 
 ## Data
 

src/openlayer/resources/inference_pipelines/inference_pipelines.py

@@ -23,7 +23,11 @@
     RowsResourceWithStreamingResponse,
     AsyncRowsResourceWithStreamingResponse,
 )
-from ...types import inference_pipeline_update_params, inference_pipeline_retrieve_params
+from ...types import (
+    inference_pipeline_update_params,
+    inference_pipeline_retrieve_params,
+    inference_pipeline_retrieve_users_params,
+)
 from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
@@ -45,6 +49,7 @@
 from ..._base_client import make_request_options
 from ...types.inference_pipeline_update_response import InferencePipelineUpdateResponse
 from ...types.inference_pipeline_retrieve_response import InferencePipelineRetrieveResponse
+from ...types.inference_pipeline_retrieve_users_response import InferencePipelineRetrieveUsersResponse
 
 __all__ = ["InferencePipelinesResource", "AsyncInferencePipelinesResource"]
 
@@ -214,6 +219,61 @@ def delete(
             cast_to=NoneType,
         )
 
+    def retrieve_users(
+        self,
+        inference_pipeline_id: str,
+        *,
+        page: int | Omit = omit,
+        per_page: int | Omit = omit,
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> InferencePipelineRetrieveUsersResponse:
+        """
+        Get aggregated user data for an inference pipeline with pagination and metadata.
+
+        Returns a list of users who have interacted with the inference pipeline,
+        including their activity statistics such as session counts, record counts, token
+        usage, and costs.
+
+        Args:
+          page: The page to return in a paginated query.
+
+          per_page: Maximum number of items to return per page.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not inference_pipeline_id:
+            raise ValueError(
+                f"Expected a non-empty value for `inference_pipeline_id` but received {inference_pipeline_id!r}"
+            )
+        return self._get(
+            f"/inference-pipelines/{inference_pipeline_id}/users",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "page": page,
+                        "per_page": per_page,
+                    },
+                    inference_pipeline_retrieve_users_params.InferencePipelineRetrieveUsersParams,
+                ),
+            ),
+            cast_to=InferencePipelineRetrieveUsersResponse,
+        )
+
 
 class AsyncInferencePipelinesResource(AsyncAPIResource):
     @cached_property
@@ -380,6 +440,61 @@ async def delete(
             cast_to=NoneType,
         )
 
+    async def retrieve_users(
+        self,
+        inference_pipeline_id: str,
+        *,
+        page: int | Omit = omit,
+        per_page: int | Omit = omit,
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> InferencePipelineRetrieveUsersResponse:
+        """
+        Get aggregated user data for an inference pipeline with pagination and metadata.
+
+        Returns a list of users who have interacted with the inference pipeline,
+        including their activity statistics such as session counts, record counts, token
+        usage, and costs.
+
+        Args:
+          page: The page to return in a paginated query.
+
+          per_page: Maximum number of items to return per page.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not inference_pipeline_id:
+            raise ValueError(
+                f"Expected a non-empty value for `inference_pipeline_id` but received {inference_pipeline_id!r}"
+            )
+        return await self._get(
+            f"/inference-pipelines/{inference_pipeline_id}/users",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "page": page,
+                        "per_page": per_page,
+                    },
+                    inference_pipeline_retrieve_users_params.InferencePipelineRetrieveUsersParams,
+                ),
+            ),
+            cast_to=InferencePipelineRetrieveUsersResponse,
+        )
+
 
 class InferencePipelinesResourceWithRawResponse:
     def __init__(self, inference_pipelines: InferencePipelinesResource) -> None:
@@ -394,6 +509,9 @@ def __init__(self, inference_pipelines: InferencePipelinesResource) -> None:
         self.delete = to_raw_response_wrapper(
             inference_pipelines.delete,
         )
+        self.retrieve_users = to_raw_response_wrapper(
+            inference_pipelines.retrieve_users,
+        )
 
     @cached_property
     def data(self) -> DataResourceWithRawResponse:
@@ -421,6 +539,9 @@ def __init__(self, inference_pipelines: AsyncInferencePipelinesResource) -> None
         self.delete = async_to_raw_response_wrapper(
             inference_pipelines.delete,
         )
+        self.retrieve_users = async_to_raw_response_wrapper(
+            inference_pipelines.retrieve_users,
+        )
 
     @cached_property
     def data(self) -> AsyncDataResourceWithRawResponse:
@@ -448,6 +569,9 @@ def __init__(self, inference_pipelines: InferencePipelinesResource) -> None:
         self.delete = to_streamed_response_wrapper(
             inference_pipelines.delete,
         )
+        self.retrieve_users = to_streamed_response_wrapper(
+            inference_pipelines.retrieve_users,
+        )
 
     @cached_property
     def data(self) -> DataResourceWithStreamingResponse:
@@ -475,6 +599,9 @@ def __init__(self, inference_pipelines: AsyncInferencePipelinesResource) -> None
         self.delete = async_to_streamed_response_wrapper(
             inference_pipelines.delete,
         )
+        self.retrieve_users = async_to_streamed_response_wrapper(
+            inference_pipelines.retrieve_users,
+        )
 
     @cached_property
     def data(self) -> AsyncDataResourceWithStreamingResponse:

src/openlayer/types/__init__.py

@@ -18,3 +18,9 @@
 from .inference_pipeline_retrieve_params import InferencePipelineRetrieveParams as InferencePipelineRetrieveParams
 from .inference_pipeline_update_response import InferencePipelineUpdateResponse as InferencePipelineUpdateResponse
 from .inference_pipeline_retrieve_response import InferencePipelineRetrieveResponse as InferencePipelineRetrieveResponse
+from .inference_pipeline_retrieve_users_params import (
+    InferencePipelineRetrieveUsersParams as InferencePipelineRetrieveUsersParams,
+)
+from .inference_pipeline_retrieve_users_response import (
+    InferencePipelineRetrieveUsersResponse as InferencePipelineRetrieveUsersResponse,
+)

src/openlayer/types/inference_pipeline_retrieve_users_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["InferencePipelineRetrieveUsersParams"]
+
+
+class InferencePipelineRetrieveUsersParams(TypedDict, total=False):
+    page: int
+    """The page to return in a paginated query."""
+
+    per_page: Annotated[int, PropertyInfo(alias="perPage")]
+    """Maximum number of items to return per page."""

src/openlayer/types/inference_pipeline_retrieve_users_response.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["InferencePipelineRetrieveUsersResponse", "Item"]
+
+
+class Item(BaseModel):
+    id: str
+    """The unique user identifier"""
+
+    cost: float
+    """Total cost for this user"""
+
+    date_of_first_record: datetime = FieldInfo(alias="dateOfFirstRecord")
+    """Timestamp of the user's first event/trace"""
+
+    date_of_last_record: datetime = FieldInfo(alias="dateOfLastRecord")
+    """Timestamp of the user's last event/trace"""
+
+    records: int
+    """Total number of traces/rows for this user"""
+
+    sessions: int
+    """Count of unique sessions for this user"""
+
+    tokens: float
+    """Total token count for this user"""
+
+
+class InferencePipelineRetrieveUsersResponse(BaseModel):
+    items: List[Item]
+    """Array of user aggregation data"""

tests/api_resources/test_inference_pipelines.py

@@ -12,6 +12,7 @@
 from openlayer.types import (
     InferencePipelineUpdateResponse,
     InferencePipelineRetrieveResponse,
+    InferencePipelineRetrieveUsersResponse,
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -152,6 +153,53 @@ def test_path_params_delete(self, client: Openlayer) -> None:
                 "",
             )
 
+    @parametrize
+    def test_method_retrieve_users(self, client: Openlayer) -> None:
+        inference_pipeline = client.inference_pipelines.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+        )
+        assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+    @parametrize
+    def test_method_retrieve_users_with_all_params(self, client: Openlayer) -> None:
+        inference_pipeline = client.inference_pipelines.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            page=1,
+            per_page=1,
+        )
+        assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+    @parametrize
+    def test_raw_response_retrieve_users(self, client: Openlayer) -> None:
+        response = client.inference_pipelines.with_raw_response.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        inference_pipeline = response.parse()
+        assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+    @parametrize
+    def test_streaming_response_retrieve_users(self, client: Openlayer) -> None:
+        with client.inference_pipelines.with_streaming_response.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            inference_pipeline = response.parse()
+            assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    def test_path_params_retrieve_users(self, client: Openlayer) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `inference_pipeline_id` but received ''"):
+            client.inference_pipelines.with_raw_response.retrieve_users(
+                inference_pipeline_id="",
+            )
+
 
 class TestAsyncInferencePipelines:
     parametrize = pytest.mark.parametrize(
@@ -289,3 +337,50 @@ async def test_path_params_delete(self, async_client: AsyncOpenlayer) -> None:
             await async_client.inference_pipelines.with_raw_response.delete(
                 "",
             )
+
+    @parametrize
+    async def test_method_retrieve_users(self, async_client: AsyncOpenlayer) -> None:
+        inference_pipeline = await async_client.inference_pipelines.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+        )
+        assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+    @parametrize
+    async def test_method_retrieve_users_with_all_params(self, async_client: AsyncOpenlayer) -> None:
+        inference_pipeline = await async_client.inference_pipelines.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            page=1,
+            per_page=1,
+        )
+        assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+    @parametrize
+    async def test_raw_response_retrieve_users(self, async_client: AsyncOpenlayer) -> None:
+        response = await async_client.inference_pipelines.with_raw_response.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        inference_pipeline = await response.parse()
+        assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_retrieve_users(self, async_client: AsyncOpenlayer) -> None:
+        async with async_client.inference_pipelines.with_streaming_response.retrieve_users(
+            inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            inference_pipeline = await response.parse()
+            assert_matches_type(InferencePipelineRetrieveUsersResponse, inference_pipeline, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    async def test_path_params_retrieve_users(self, async_client: AsyncOpenlayer) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `inference_pipeline_id` but received ''"):
+            await async_client.inference_pipelines.with_raw_response.retrieve_users(
+                inference_pipeline_id="",
+            )