feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 18
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-55497442c9c2cf4077d1e8661fdf82ebe905dbb140ec65421ffa78da6d06a015.yml
 openapi_spec_hash: aa9abda3ed926041c12f664e4225c5ed
-config_hash: 9e8bd25bb51a72f08b91887dff4f39e9
+config_hash: bd953556a1d60f48307815fdaf9ba88b

README.md

@@ -191,11 +191,11 @@ from hyperspell import Hyperspell
 
 client = Hyperspell()
 
-query = client.memories.search(
+query_result = client.memories.search(
     query="query",
     options={},
 )
-print(query.options)
+print(query_result.options)
 ```
 
 ## File uploads

api.md

@@ -1,3 +1,9 @@
+# Shared Types
+
+```python
+from hyperspell.types import QueryResult
+```
+
 # Integrations
 
 Types:
@@ -54,7 +60,7 @@ Methods:
 - <code title="delete /memories/delete/{source}/{resource_id}">client.memories.<a href="./src/hyperspell/resources/memories.py">delete</a>(resource_id, \*, source) -> <a href="./src/hyperspell/types/memory_delete_response.py">MemoryDeleteResponse</a></code>
 - <code title="post /memories/add">client.memories.<a href="./src/hyperspell/resources/memories.py">add</a>(\*\*<a href="src/hyperspell/types/memory_add_params.py">params</a>) -> <a href="./src/hyperspell/types/memory_status.py">MemoryStatus</a></code>
 - <code title="get /memories/get/{source}/{resource_id}">client.memories.<a href="./src/hyperspell/resources/memories.py">get</a>(resource_id, \*, source) -> <a href="./src/hyperspell/types/memory.py">Memory</a></code>
-- <code title="post /memories/query">client.memories.<a href="./src/hyperspell/resources/memories.py">search</a>(\*\*<a href="src/hyperspell/types/memory_search_params.py">params</a>) -> <a href="./src/hyperspell/types/query.py">Query</a></code>
+- <code title="post /memories/query">client.memories.<a href="./src/hyperspell/resources/memories.py">search</a>(\*\*<a href="src/hyperspell/types/memory_search_params.py">params</a>) -> <a href="./src/hyperspell/types/shared/query_result.py">QueryResult</a></code>
 - <code title="get /memories/status">client.memories.<a href="./src/hyperspell/resources/memories.py">status</a>() -> <a href="./src/hyperspell/types/memory_status_response.py">MemoryStatusResponse</a></code>
 - <code title="post /memories/upload">client.memories.<a href="./src/hyperspell/resources/memories.py">upload</a>(\*\*<a href="src/hyperspell/types/memory_upload_params.py">params</a>) -> <a href="./src/hyperspell/types/memory_status.py">MemoryStatus</a></code>
 
@@ -63,12 +69,12 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Query, EvaluateScoreHighlightResponse, EvaluateScoreQueryResponse
+from hyperspell.types import EvaluateScoreHighlightResponse, EvaluateScoreQueryResponse
 ```
 
 Methods:
 
-- <code title="get /evaluate/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="get /evaluate/query/{query_id}">client.evaluate.<a href="./src/hyperspell/resources/evaluate.py">get_query</a>(query_id) -> <a href="./src/hyperspell/types/shared/query_result.py">QueryResult</a></code>
 - <code title="post /evaluate/highlight/{highlight_id}">client.evaluate.<a href="./src/hyperspell/resources/evaluate.py">score_highlight</a>(highlight_id, \*\*<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 /evaluate/query/{query_id}">client.evaluate.<a href="./src/hyperspell/resources/evaluate.py">score_query</a>(query_id, \*\*<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>
 

src/hyperspell/resources/evaluate.py

@@ -17,8 +17,8 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ..types.query import Query
 from .._base_client import make_request_options
+from ..types.shared.query_result import QueryResult
 from ..types.evaluate_score_query_response import EvaluateScoreQueryResponse
 from ..types.evaluate_score_highlight_response import EvaluateScoreHighlightResponse
 
@@ -55,7 +55,7 @@ def get_query(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Query:
+    ) -> QueryResult:
         """
         Retrieve the result of a previous query.
 
@@ -75,7 +75,7 @@ def get_query(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Query,
+            cast_to=QueryResult,
         )
 
     def score_highlight(
@@ -192,7 +192,7 @@ async def get_query(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Query:
+    ) -> QueryResult:
         """
         Retrieve the result of a previous query.
 
@@ -212,7 +212,7 @@ async def get_query(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Query,
+            cast_to=QueryResult,
         )
 
     async def score_highlight(

src/hyperspell/resources/memories.py

@@ -20,10 +20,10 @@
     async_to_streamed_response_wrapper,
 )
 from ..pagination import SyncCursorPage, AsyncCursorPage
-from ..types.query import Query
 from .._base_client import AsyncPaginator, make_request_options
 from ..types.memory import Memory
 from ..types.memory_status import MemoryStatus
+from ..types.shared.query_result import QueryResult
 from ..types.memory_delete_response import MemoryDeleteResponse
 from ..types.memory_status_response import MemoryStatusResponse
 
@@ -459,7 +459,7 @@ def search(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Query:
+    ) -> QueryResult:
         """
         Retrieves documents matching the query.
 
@@ -497,7 +497,7 @@ def search(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Query,
+            cast_to=QueryResult,
         )
 
     def status(
@@ -1005,7 +1005,7 @@ async def search(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Query:
+    ) -> QueryResult:
         """
         Retrieves documents matching the query.
 
@@ -1043,7 +1043,7 @@ async def search(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Query,
+            cast_to=QueryResult,
         )
 
     async def status(

src/hyperspell/types/__init__.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from .query import Query as Query
 from .token import Token as Token
 from .memory import Memory as Memory
+from .shared import QueryResult as QueryResult
 from .memory_status import MemoryStatus as MemoryStatus
 from .auth_me_response import AuthMeResponse as AuthMeResponse
 from .memory_add_params import MemoryAddParams as MemoryAddParams

src/hyperspell/types/shared/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .query_result import QueryResult as QueryResult

src/hyperspell/types/query.py renamed to src/hyperspell/types/shared/query_result.py

@@ -2,13 +2,13 @@
 
 from typing import Dict, List, Optional
 
-from .memory import Memory
-from .._models import BaseModel
+from ..memory import Memory
+from ..._models import BaseModel
 
-__all__ = ["Query"]
+__all__ = ["QueryResult"]
 
 
-class Query(BaseModel):
+class QueryResult(BaseModel):
     documents: List[Memory]
 
     answer: Optional[str] = None

tests/api_resources/test_evaluate.py

@@ -10,10 +10,10 @@
 from hyperspell import Hyperspell, AsyncHyperspell
 from tests.utils import assert_matches_type
 from hyperspell.types import (
-    Query,
     EvaluateScoreQueryResponse,
     EvaluateScoreHighlightResponse,
 )
+from hyperspell.types.shared import QueryResult
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -26,7 +26,7 @@ def test_method_get_query(self, client: Hyperspell) -> None:
         evaluate = client.evaluate.get_query(
             "query_id",
         )
-        assert_matches_type(Query, evaluate, path=["response"])
+        assert_matches_type(QueryResult, evaluate, path=["response"])
 
     @parametrize
     def test_raw_response_get_query(self, client: Hyperspell) -> None:
@@ -37,7 +37,7 @@ def test_raw_response_get_query(self, client: Hyperspell) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         evaluate = response.parse()
-        assert_matches_type(Query, evaluate, path=["response"])
+        assert_matches_type(QueryResult, evaluate, path=["response"])
 
     @parametrize
     def test_streaming_response_get_query(self, client: Hyperspell) -> None:
@@ -48,7 +48,7 @@ def test_streaming_response_get_query(self, client: Hyperspell) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             evaluate = response.parse()
-            assert_matches_type(Query, evaluate, path=["response"])
+            assert_matches_type(QueryResult, evaluate, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -163,7 +163,7 @@ async def test_method_get_query(self, async_client: AsyncHyperspell) -> None:
         evaluate = await async_client.evaluate.get_query(
             "query_id",
         )
-        assert_matches_type(Query, evaluate, path=["response"])
+        assert_matches_type(QueryResult, evaluate, path=["response"])
 
     @parametrize
     async def test_raw_response_get_query(self, async_client: AsyncHyperspell) -> None:
@@ -174,7 +174,7 @@ async def test_raw_response_get_query(self, async_client: AsyncHyperspell) -> No
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         evaluate = await response.parse()
-        assert_matches_type(Query, evaluate, path=["response"])
+        assert_matches_type(QueryResult, evaluate, path=["response"])
 
     @parametrize
     async def test_streaming_response_get_query(self, async_client: AsyncHyperspell) -> None:
@@ -185,7 +185,7 @@ async def test_streaming_response_get_query(self, async_client: AsyncHyperspell)
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             evaluate = await response.parse()
-            assert_matches_type(Query, evaluate, path=["response"])
+            assert_matches_type(QueryResult, evaluate, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 

tests/api_resources/test_memories.py

@@ -10,14 +10,14 @@
 from hyperspell import Hyperspell, AsyncHyperspell
 from tests.utils import assert_matches_type
 from hyperspell.types import (
-    Query,
     Memory,
     MemoryStatus,
     MemoryDeleteResponse,
     MemoryStatusResponse,
 )
 from hyperspell._utils import parse_datetime
 from hyperspell.pagination import SyncCursorPage, AsyncCursorPage
+from hyperspell.types.shared import QueryResult
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -191,7 +191,7 @@ def test_method_search(self, client: Hyperspell) -> None:
         memory = client.memories.search(
             query="query",
         )
-        assert_matches_type(Query, memory, path=["response"])
+        assert_matches_type(QueryResult, memory, path=["response"])
 
     @parametrize
     def test_method_search_with_all_params(self, client: Hyperspell) -> None:
@@ -265,7 +265,7 @@ def test_method_search_with_all_params(self, client: Hyperspell) -> None:
             },
             sources=["collections"],
         )
-        assert_matches_type(Query, memory, path=["response"])
+        assert_matches_type(QueryResult, memory, path=["response"])
 
     @parametrize
     def test_raw_response_search(self, client: Hyperspell) -> None:
@@ -276,7 +276,7 @@ def test_raw_response_search(self, client: Hyperspell) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         memory = response.parse()
-        assert_matches_type(Query, memory, path=["response"])
+        assert_matches_type(QueryResult, memory, path=["response"])
 
     @parametrize
     def test_streaming_response_search(self, client: Hyperspell) -> None:
@@ -287,7 +287,7 @@ def test_streaming_response_search(self, client: Hyperspell) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             memory = response.parse()
-            assert_matches_type(Query, memory, path=["response"])
+            assert_matches_type(QueryResult, memory, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -527,7 +527,7 @@ async def test_method_search(self, async_client: AsyncHyperspell) -> None:
         memory = await async_client.memories.search(
             query="query",
         )
-        assert_matches_type(Query, memory, path=["response"])
+        assert_matches_type(QueryResult, memory, path=["response"])
 
     @parametrize
     async def test_method_search_with_all_params(self, async_client: AsyncHyperspell) -> None:
@@ -601,7 +601,7 @@ async def test_method_search_with_all_params(self, async_client: AsyncHyperspell
             },
             sources=["collections"],
         )
-        assert_matches_type(Query, memory, path=["response"])
+        assert_matches_type(QueryResult, memory, path=["response"])
 
     @parametrize
     async def test_raw_response_search(self, async_client: AsyncHyperspell) -> None:
@@ -612,7 +612,7 @@ async def test_raw_response_search(self, async_client: AsyncHyperspell) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         memory = await response.parse()
-        assert_matches_type(Query, memory, path=["response"])
+        assert_matches_type(QueryResult, memory, path=["response"])
 
     @parametrize
     async def test_streaming_response_search(self, async_client: AsyncHyperspell) -> None:
@@ -623,7 +623,7 @@ async def test_streaming_response_search(self, async_client: AsyncHyperspell) ->
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             memory = await response.parse()
-            assert_matches_type(Query, memory, path=["response"])
+            assert_matches_type(QueryResult, memory, path=["response"])
 
         assert cast(Any, response.is_closed) is True