feat(api): api update (#86)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-22761e18c9e84e2bc357771cca49e85f66b8d6b76c7f6e682effe2501ea3cf2e.yml
-openapi_spec_hash: b467d9287bf9504412b7252da9e46fb7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-18698512a973e239c981a42d11523d0fb47dfb597894d1dce89da76013cab7fa.yml
+openapi_spec_hash: 1e66229ea35397cba6c3908d812a5631
 config_hash: 63e7969fd7c560b6105e1de79148b568

src/hyperspell/resources/query.py

@@ -51,6 +51,7 @@ def search(
         self,
         *,
         query: str,
+        answer: bool | NotGiven = NOT_GIVEN,
         filter: query_search_params.Filter | NotGiven = NOT_GIVEN,
         max_results: int | NotGiven = NOT_GIVEN,
         sources: List[
@@ -81,6 +82,8 @@ def search(
         Args:
           query: Query to run.
 
+          answer: If true, the query will be answered along with matching source documents.
+
           filter: Filter the query results.
 
           max_results: Maximum number of results to return.
@@ -100,6 +103,7 @@ def search(
             body=maybe_transform(
                 {
                     "query": query,
+                    "answer": answer,
                     "filter": filter,
                     "max_results": max_results,
                     "sources": sources,
@@ -137,6 +141,7 @@ async def search(
         self,
         *,
         query: str,
+        answer: bool | NotGiven = NOT_GIVEN,
         filter: query_search_params.Filter | NotGiven = NOT_GIVEN,
         max_results: int | NotGiven = NOT_GIVEN,
         sources: List[
@@ -167,6 +172,8 @@ async def search(
         Args:
           query: Query to run.
 
+          answer: If true, the query will be answered along with matching source documents.
+
           filter: Filter the query results.
 
           max_results: Maximum number of results to return.
@@ -186,6 +193,7 @@ async def search(
             body=await async_maybe_transform(
                 {
                     "query": query,
+                    "answer": answer,
                     "filter": filter,
                     "max_results": max_results,
                     "sources": sources,

src/hyperspell/types/query_search_params.py

@@ -15,6 +15,9 @@ class QuerySearchParams(TypedDict, total=False):
     query: Required[str]
     """Query to run."""
 
+    answer: bool
+    """If true, the query will be answered along with matching source documents."""
+
     filter: Filter
     """Filter the query results."""
 

src/hyperspell/types/query_search_response.py

@@ -42,6 +42,9 @@ class Error(BaseModel):
 class QuerySearchResponse(BaseModel):
     documents: List[Document]
 
+    answer: Optional[str] = None
+    """The answer to the query, if the request was set to answer."""
+
     errors: Optional[List[Error]] = None
     """Errors that occurred during the query.
 

tests/api_resources/test_query.py

@@ -29,6 +29,7 @@ def test_method_search(self, client: Hyperspell) -> None:
     def test_method_search_with_all_params(self, client: Hyperspell) -> None:
         query = client.query.search(
             query="query",
+            answer=True,
             filter={
                 "after": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "before": parse_datetime("2019-12-27T18:11:19.117Z"),
@@ -78,6 +79,7 @@ async def test_method_search(self, async_client: AsyncHyperspell) -> None:
     async def test_method_search_with_all_params(self, async_client: AsyncHyperspell) -> None:
         query = await async_client.query.search(
             query="query",
+            answer=True,
             filter={
                 "after": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "before": parse_datetime("2019-12-27T18:11:19.117Z"),