feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 17
+configured_endpoints: 18
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-d2e76b9698a2b33ab32291eac7ffa9671fe0a65646e6ba53170beee2dd643123.yml
 openapi_spec_hash: e4c39d8acf6435ae67ae263becf8dc47
-config_hash: 88c2e8730c1f7a63483c6bfbc6e49e1c
+config_hash: 0a4df55eb1dea18b7b6832b1f5a957e9

api.md

@@ -63,12 +63,13 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Query, EvaluateScoreQueryResponse
+from hyperspell.types import Query, EvaluateScoreHighlightResponse, EvaluateScoreQueryResponse
 ```
 
 Methods:
 
 - <code title="get /memories/query/{query_id}">client.evaluate.<a href="./src/hyperspell/resources/evaluate.py">get_query</a>(query_id) -> <a href="./src/hyperspell/types/query.py">Query</a></code>
+- <code title="post /memories/highlights/feedback">client.evaluate.<a href="./src/hyperspell/resources/evaluate.py">score_highlight</a>(\*\*<a href="src/hyperspell/types/evaluate_score_highlight_params.py">params</a>) -> <a href="./src/hyperspell/types/evaluate_score_highlight_response.py">EvaluateScoreHighlightResponse</a></code>
 - <code title="post /memories/query/feedback">client.evaluate.<a href="./src/hyperspell/resources/evaluate.py">score_query</a>(\*\*<a href="src/hyperspell/types/evaluate_score_query_params.py">params</a>) -> <a href="./src/hyperspell/types/evaluate_score_query_response.py">EvaluateScoreQueryResponse</a></code>
 
 # Vaults

src/hyperspell/resources/evaluate.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
+from typing import Optional
+
 import httpx
 
-from ..types import evaluate_score_query_params
+from ..types import evaluate_score_query_params, evaluate_score_highlight_params
 from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
@@ -18,6 +20,7 @@
 from ..types.query import Query
 from .._base_client import make_request_options
 from ..types.evaluate_score_query_response import EvaluateScoreQueryResponse
+from ..types.evaluate_score_highlight_response import EvaluateScoreHighlightResponse
 
 __all__ = ["EvaluateResource", "AsyncEvaluateResource"]
 
@@ -75,6 +78,53 @@ def get_query(
             cast_to=Query,
         )
 
+    def score_highlight(
+        self,
+        *,
+        highlight_id: str,
+        comment: Optional[str] | Omit = omit,
+        score: float | 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,
+    ) -> EvaluateScoreHighlightResponse:
+        """
+        Provide feedback on a query result.
+
+        Args:
+          highlight_id: The ID of the chunk to provide feedback on.
+
+          comment: Comment on the chunk
+
+          score: Rating of the chunk from -1 (bad) to +1 (good).
+
+          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
+        """
+        return self._post(
+            "/memories/highlights/feedback",
+            body=maybe_transform(
+                {
+                    "highlight_id": highlight_id,
+                    "comment": comment,
+                    "score": score,
+                },
+                evaluate_score_highlight_params.EvaluateScoreHighlightParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvaluateScoreHighlightResponse,
+        )
+
     def score_query(
         self,
         *,
@@ -172,6 +222,53 @@ async def get_query(
             cast_to=Query,
         )
 
+    async def score_highlight(
+        self,
+        *,
+        highlight_id: str,
+        comment: Optional[str] | Omit = omit,
+        score: float | 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,
+    ) -> EvaluateScoreHighlightResponse:
+        """
+        Provide feedback on a query result.
+
+        Args:
+          highlight_id: The ID of the chunk to provide feedback on.
+
+          comment: Comment on the chunk
+
+          score: Rating of the chunk from -1 (bad) to +1 (good).
+
+          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
+        """
+        return await self._post(
+            "/memories/highlights/feedback",
+            body=await async_maybe_transform(
+                {
+                    "highlight_id": highlight_id,
+                    "comment": comment,
+                    "score": score,
+                },
+                evaluate_score_highlight_params.EvaluateScoreHighlightParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvaluateScoreHighlightResponse,
+        )
+
     async def score_query(
         self,
         *,
@@ -223,6 +320,9 @@ def __init__(self, evaluate: EvaluateResource) -> None:
         self.get_query = to_raw_response_wrapper(
             evaluate.get_query,
         )
+        self.score_highlight = to_raw_response_wrapper(
+            evaluate.score_highlight,
+        )
         self.score_query = to_raw_response_wrapper(
             evaluate.score_query,
         )
@@ -235,6 +335,9 @@ def __init__(self, evaluate: AsyncEvaluateResource) -> None:
         self.get_query = async_to_raw_response_wrapper(
             evaluate.get_query,
         )
+        self.score_highlight = async_to_raw_response_wrapper(
+            evaluate.score_highlight,
+        )
         self.score_query = async_to_raw_response_wrapper(
             evaluate.score_query,
         )
@@ -247,6 +350,9 @@ def __init__(self, evaluate: EvaluateResource) -> None:
         self.get_query = to_streamed_response_wrapper(
             evaluate.get_query,
         )
+        self.score_highlight = to_streamed_response_wrapper(
+            evaluate.score_highlight,
+        )
         self.score_query = to_streamed_response_wrapper(
             evaluate.score_query,
         )
@@ -259,6 +365,9 @@ def __init__(self, evaluate: AsyncEvaluateResource) -> None:
         self.get_query = async_to_streamed_response_wrapper(
             evaluate.get_query,
         )
+        self.score_highlight = async_to_streamed_response_wrapper(
+            evaluate.score_highlight,
+        )
         self.score_query = async_to_streamed_response_wrapper(
             evaluate.score_query,
         )

src/hyperspell/types/__init__.py

@@ -20,3 +20,5 @@
 from .evaluate_score_query_params import EvaluateScoreQueryParams as EvaluateScoreQueryParams
 from .integration_revoke_response import IntegrationRevokeResponse as IntegrationRevokeResponse
 from .evaluate_score_query_response import EvaluateScoreQueryResponse as EvaluateScoreQueryResponse
+from .evaluate_score_highlight_params import EvaluateScoreHighlightParams as EvaluateScoreHighlightParams
+from .evaluate_score_highlight_response import EvaluateScoreHighlightResponse as EvaluateScoreHighlightResponse

src/hyperspell/types/evaluate_score_highlight_params.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["EvaluateScoreHighlightParams"]
+
+
+class EvaluateScoreHighlightParams(TypedDict, total=False):
+    highlight_id: Required[str]
+    """The ID of the chunk to provide feedback on."""
+
+    comment: Optional[str]
+    """Comment on the chunk"""
+
+    score: float
+    """Rating of the chunk from -1 (bad) to +1 (good)."""

src/hyperspell/types/evaluate_score_highlight_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["EvaluateScoreHighlightResponse"]
+
+
+class EvaluateScoreHighlightResponse(BaseModel):
+    message: str
+    """A message describing the result."""
+
+    success: bool
+    """Whether the feedback was successfully saved."""

tests/api_resources/test_evaluate.py

@@ -9,7 +9,11 @@
 
 from hyperspell import Hyperspell, AsyncHyperspell
 from tests.utils import assert_matches_type
-from hyperspell.types import Query, EvaluateScoreQueryResponse
+from hyperspell.types import (
+    Query,
+    EvaluateScoreQueryResponse,
+    EvaluateScoreHighlightResponse,
+)
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -55,6 +59,46 @@ def test_path_params_get_query(self, client: Hyperspell) -> None:
                 "",
             )
 
+    @parametrize
+    def test_method_score_highlight(self, client: Hyperspell) -> None:
+        evaluate = client.evaluate.score_highlight(
+            highlight_id="highlight_id",
+        )
+        assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+    @parametrize
+    def test_method_score_highlight_with_all_params(self, client: Hyperspell) -> None:
+        evaluate = client.evaluate.score_highlight(
+            highlight_id="highlight_id",
+            comment="comment",
+            score=-1,
+        )
+        assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+    @parametrize
+    def test_raw_response_score_highlight(self, client: Hyperspell) -> None:
+        response = client.evaluate.with_raw_response.score_highlight(
+            highlight_id="highlight_id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        evaluate = response.parse()
+        assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+    @parametrize
+    def test_streaming_response_score_highlight(self, client: Hyperspell) -> None:
+        with client.evaluate.with_streaming_response.score_highlight(
+            highlight_id="highlight_id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            evaluate = response.parse()
+            assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @parametrize
     def test_method_score_query(self, client: Hyperspell) -> None:
         evaluate = client.evaluate.score_query(
@@ -138,6 +182,46 @@ async def test_path_params_get_query(self, async_client: AsyncHyperspell) -> Non
                 "",
             )
 
+    @parametrize
+    async def test_method_score_highlight(self, async_client: AsyncHyperspell) -> None:
+        evaluate = await async_client.evaluate.score_highlight(
+            highlight_id="highlight_id",
+        )
+        assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+    @parametrize
+    async def test_method_score_highlight_with_all_params(self, async_client: AsyncHyperspell) -> None:
+        evaluate = await async_client.evaluate.score_highlight(
+            highlight_id="highlight_id",
+            comment="comment",
+            score=-1,
+        )
+        assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+    @parametrize
+    async def test_raw_response_score_highlight(self, async_client: AsyncHyperspell) -> None:
+        response = await async_client.evaluate.with_raw_response.score_highlight(
+            highlight_id="highlight_id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        evaluate = await response.parse()
+        assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_score_highlight(self, async_client: AsyncHyperspell) -> None:
+        async with async_client.evaluate.with_streaming_response.score_highlight(
+            highlight_id="highlight_id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            evaluate = await response.parse()
+            assert_matches_type(EvaluateScoreHighlightResponse, evaluate, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @parametrize
     async def test_method_score_query(self, async_client: AsyncHyperspell) -> None:
         evaluate = await async_client.evaluate.score_query(