feat(closes OPEN-8532): expose 'tests/{id}/results' endpoint

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 24
-openapi_spec_hash: c97a5263afcc72ca5a47bc5a87683a78
-config_hash: f0743196c68fb84cbd06a95f134702b3
+configured_endpoints: 25
+openapi_spec_hash: 4eff18b3478c98a9b257ac27fdeb6b49
+config_hash: b415187e3925c414fb2597cdd0a11859

api.md

@@ -182,9 +182,10 @@ Methods:
 Types:
 
 ```python
-from openlayer.types import TestEvaluateResponse
+from openlayer.types import TestEvaluateResponse, TestListResultsResponse
 ```
 
 Methods:
 
 - <code title="post /tests/{testId}/evaluate">client.tests.<a href="./src/openlayer/resources/tests.py">evaluate</a>(test_id, \*\*<a href="src/openlayer/types/test_evaluate_params.py">params</a>) -> <a href="./src/openlayer/types/test_evaluate_response.py">TestEvaluateResponse</a></code>
+- <code title="get /tests/{testId}/results">client.tests.<a href="./src/openlayer/resources/tests.py">list_results</a>(test_id, \*\*<a href="src/openlayer/types/test_list_results_params.py">params</a>) -> <a href="./src/openlayer/types/test_list_results_response.py">TestListResultsResponse</a></code>

src/openlayer/resources/tests.py

@@ -2,10 +2,12 @@
 
 from __future__ import annotations
 
+from typing import Optional
+
 import httpx
 
-from ..types import test_evaluate_params
-from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..types import test_evaluate_params, test_list_results_params
+from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -17,6 +19,7 @@
 )
 from .._base_client import make_request_options
 from ..types.test_evaluate_response import TestEvaluateResponse
+from ..types.test_list_results_response import TestListResultsResponse
 
 __all__ = ["TestsResource", "AsyncTestsResource"]
 
@@ -101,6 +104,79 @@ def evaluate(
             cast_to=TestEvaluateResponse,
         )
 
+    def list_results(
+        self,
+        test_id: str,
+        *,
+        end_timestamp: float | Omit = omit,
+        include_insights: bool | Omit = omit,
+        inference_pipeline_id: Optional[str] | Omit = omit,
+        page: int | Omit = omit,
+        per_page: int | Omit = omit,
+        project_version_id: Optional[str] | Omit = omit,
+        start_timestamp: float | Omit = omit,
+        status: SequenceNotStr[str] | 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,
+    ) -> TestListResultsResponse:
+        """
+        List the test results for a test.
+
+        Args:
+          end_timestamp: Filter for results that use data starting before the end timestamp.
+
+          include_insights: Include the insights linked to each test result
+
+          inference_pipeline_id: Retrive test results for a specific inference pipeline.
+
+          page: The page to return in a paginated query.
+
+          per_page: Maximum number of items to return per page.
+
+          project_version_id: Retrive test results for a specific project version.
+
+          start_timestamp: Filter for results that use data ending after the start timestamp.
+
+          status: Filter by status(es).
+
+          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 test_id:
+            raise ValueError(f"Expected a non-empty value for `test_id` but received {test_id!r}")
+        return self._get(
+            f"/tests/{test_id}/results",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "end_timestamp": end_timestamp,
+                        "include_insights": include_insights,
+                        "inference_pipeline_id": inference_pipeline_id,
+                        "page": page,
+                        "per_page": per_page,
+                        "project_version_id": project_version_id,
+                        "start_timestamp": start_timestamp,
+                        "status": status,
+                    },
+                    test_list_results_params.TestListResultsParams,
+                ),
+            ),
+            cast_to=TestListResultsResponse,
+        )
+
 
 class AsyncTestsResource(AsyncAPIResource):
     @cached_property
@@ -180,6 +256,79 @@ async def evaluate(
             cast_to=TestEvaluateResponse,
         )
 
+    async def list_results(
+        self,
+        test_id: str,
+        *,
+        end_timestamp: float | Omit = omit,
+        include_insights: bool | Omit = omit,
+        inference_pipeline_id: Optional[str] | Omit = omit,
+        page: int | Omit = omit,
+        per_page: int | Omit = omit,
+        project_version_id: Optional[str] | Omit = omit,
+        start_timestamp: float | Omit = omit,
+        status: SequenceNotStr[str] | 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,
+    ) -> TestListResultsResponse:
+        """
+        List the test results for a test.
+
+        Args:
+          end_timestamp: Filter for results that use data starting before the end timestamp.
+
+          include_insights: Include the insights linked to each test result
+
+          inference_pipeline_id: Retrive test results for a specific inference pipeline.
+
+          page: The page to return in a paginated query.
+
+          per_page: Maximum number of items to return per page.
+
+          project_version_id: Retrive test results for a specific project version.
+
+          start_timestamp: Filter for results that use data ending after the start timestamp.
+
+          status: Filter by status(es).
+
+          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 test_id:
+            raise ValueError(f"Expected a non-empty value for `test_id` but received {test_id!r}")
+        return await self._get(
+            f"/tests/{test_id}/results",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "end_timestamp": end_timestamp,
+                        "include_insights": include_insights,
+                        "inference_pipeline_id": inference_pipeline_id,
+                        "page": page,
+                        "per_page": per_page,
+                        "project_version_id": project_version_id,
+                        "start_timestamp": start_timestamp,
+                        "status": status,
+                    },
+                    test_list_results_params.TestListResultsParams,
+                ),
+            ),
+            cast_to=TestListResultsResponse,
+        )
+
 
 class TestsResourceWithRawResponse:
     __test__ = False
@@ -190,6 +339,9 @@ def __init__(self, tests: TestsResource) -> None:
         self.evaluate = to_raw_response_wrapper(
             tests.evaluate,
         )
+        self.list_results = to_raw_response_wrapper(
+            tests.list_results,
+        )
 
 
 class AsyncTestsResourceWithRawResponse:
@@ -199,6 +351,9 @@ def __init__(self, tests: AsyncTestsResource) -> None:
         self.evaluate = async_to_raw_response_wrapper(
             tests.evaluate,
         )
+        self.list_results = async_to_raw_response_wrapper(
+            tests.list_results,
+        )
 
 
 class TestsResourceWithStreamingResponse:
@@ -210,6 +365,9 @@ def __init__(self, tests: TestsResource) -> None:
         self.evaluate = to_streamed_response_wrapper(
             tests.evaluate,
         )
+        self.list_results = to_streamed_response_wrapper(
+            tests.list_results,
+        )
 
 
 class AsyncTestsResourceWithStreamingResponse:
@@ -219,3 +377,6 @@ def __init__(self, tests: AsyncTestsResource) -> None:
         self.evaluate = async_to_streamed_response_wrapper(
             tests.evaluate,
         )
+        self.list_results = async_to_streamed_response_wrapper(
+            tests.list_results,
+        )

src/openlayer/types/__init__.py

@@ -10,7 +10,9 @@
 from .project_create_response import ProjectCreateResponse as ProjectCreateResponse
 from .workspace_update_params import WorkspaceUpdateParams as WorkspaceUpdateParams
 from .commit_retrieve_response import CommitRetrieveResponse as CommitRetrieveResponse
+from .test_list_results_params import TestListResultsParams as TestListResultsParams
 from .workspace_update_response import WorkspaceUpdateResponse as WorkspaceUpdateResponse
+from .test_list_results_response import TestListResultsResponse as TestListResultsResponse
 from .workspace_retrieve_response import WorkspaceRetrieveResponse as WorkspaceRetrieveResponse
 from .inference_pipeline_update_params import InferencePipelineUpdateParams as InferencePipelineUpdateParams
 from .inference_pipeline_retrieve_params import InferencePipelineRetrieveParams as InferencePipelineRetrieveParams

src/openlayer/types/commits/test_result_list_response.py

@@ -2,13 +2,36 @@
 
 from typing import List, Union, Optional
 from datetime import datetime
-from typing_extensions import Literal
+from typing_extensions import Literal, TypeAlias
 
 from pydantic import Field as FieldInfo
 
 from ..._models import BaseModel
 
-__all__ = ["TestResultListResponse", "Item", "ItemGoal", "ItemGoalThreshold", "ItemGoalThresholdInsightParameter"]
+__all__ = [
+    "TestResultListResponse",
+    "Item",
+    "ItemExpectedValue",
+    "ItemGoal",
+    "ItemGoalThreshold",
+    "ItemGoalThresholdInsightParameter",
+    "ItemRowsBody",
+    "ItemRowsBodyColumnFilter",
+    "ItemRowsBodyColumnFilterSetColumnFilter",
+    "ItemRowsBodyColumnFilterNumericColumnFilter",
+    "ItemRowsBodyColumnFilterStringColumnFilter",
+]
+
+
+class ItemExpectedValue(BaseModel):
+    lower_threshold: Optional[float] = FieldInfo(alias="lowerThreshold", default=None)
+    """the lower threshold for the expected value"""
+
+    measurement: Optional[str] = None
+    """One of the `measurement` values in the test's thresholds"""
+
+    upper_threshold: Optional[float] = FieldInfo(alias="upperThreshold", default=None)
+    """The upper threshold for the expected value"""
 
 
 class ItemGoalThresholdInsightParameter(BaseModel):
@@ -194,6 +217,58 @@ class ItemGoal(BaseModel):
     """Whether the test uses a validation dataset."""
 
 
+class ItemRowsBodyColumnFilterSetColumnFilter(BaseModel):
+    measurement: str
+    """The name of the column."""
+
+    operator: Literal["contains_none", "contains_any", "contains_all", "one_of", "none_of"]
+
+    value: List[Union[str, float]]
+
+
+class ItemRowsBodyColumnFilterNumericColumnFilter(BaseModel):
+    measurement: str
+    """The name of the column."""
+
+    operator: Literal[">", ">=", "is", "<", "<=", "!="]
+
+    value: Optional[float] = None
+
+
+class ItemRowsBodyColumnFilterStringColumnFilter(BaseModel):
+    measurement: str
+    """The name of the column."""
+
+    operator: Literal["is", "!="]
+
+    value: Union[str, bool]
+
+
+ItemRowsBodyColumnFilter: TypeAlias = Union[
+    ItemRowsBodyColumnFilterSetColumnFilter,
+    ItemRowsBodyColumnFilterNumericColumnFilter,
+    ItemRowsBodyColumnFilterStringColumnFilter,
+]
+
+
+class ItemRowsBody(BaseModel):
+    """The body of the rows request."""
+
+    column_filters: Optional[List[ItemRowsBodyColumnFilter]] = FieldInfo(alias="columnFilters", default=None)
+
+    exclude_row_id_list: Optional[List[int]] = FieldInfo(alias="excludeRowIdList", default=None)
+
+    not_search_query_and: Optional[List[str]] = FieldInfo(alias="notSearchQueryAnd", default=None)
+
+    not_search_query_or: Optional[List[str]] = FieldInfo(alias="notSearchQueryOr", default=None)
+
+    row_id_list: Optional[List[int]] = FieldInfo(alias="rowIdList", default=None)
+
+    search_query_and: Optional[List[str]] = FieldInfo(alias="searchQueryAnd", default=None)
+
+    search_query_or: Optional[List[str]] = FieldInfo(alias="searchQueryOr", default=None)
+
+
 class Item(BaseModel):
     id: str
     """Project version (commit) id."""
@@ -222,11 +297,19 @@ class Item(BaseModel):
     status_message: Optional[str] = FieldInfo(alias="statusMessage", default=None)
     """The status message."""
 
+    expected_values: Optional[List[ItemExpectedValue]] = FieldInfo(alias="expectedValues", default=None)
+
     goal: Optional[ItemGoal] = None
 
     goal_id: Optional[str] = FieldInfo(alias="goalId", default=None)
     """The test id."""
 
+    rows: Optional[str] = None
+    """The URL to the rows of the test result."""
+
+    rows_body: Optional[ItemRowsBody] = FieldInfo(alias="rowsBody", default=None)
+    """The body of the rows request."""
+
 
 class TestResultListResponse(BaseModel):
     __test__ = False