feat(api): api update (#16)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 3
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-d13c18fcc9505d21806455beba52ba04b8da7b3b5cf5894f2d91ded6d08c2ff2.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-eaf9002b6b4dd01a0039562918f5b97dc62c8fdcc1cec310491a4e64a799620a.yml

src/hyperspell/resources/query.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import List
 from typing_extensions import Literal
 
 import httpx
@@ -49,7 +50,7 @@ def retrieve(
         self,
         *,
         query: str,
-        filter: query_retrieve_params.Filter | NotGiven = NOT_GIVEN,
+        collections: List[str] | NotGiven = NOT_GIVEN,
         max_results: int | NotGiven = NOT_GIVEN,
         query_type: Literal["auto", "semantic", "keyword"] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -65,7 +66,7 @@ def retrieve(
         Args:
           query: Query to run.
 
-          filter: Filter the query results.
+          collections: Only query documents in these collections.
 
           max_results: Maximum number of results to return.
 
@@ -84,7 +85,7 @@ def retrieve(
             body=maybe_transform(
                 {
                     "query": query,
-                    "filter": filter,
+                    "collections": collections,
                     "max_results": max_results,
                     "query_type": query_type,
                 },
@@ -121,7 +122,7 @@ async def retrieve(
         self,
         *,
         query: str,
-        filter: query_retrieve_params.Filter | NotGiven = NOT_GIVEN,
+        collections: List[str] | NotGiven = NOT_GIVEN,
         max_results: int | NotGiven = NOT_GIVEN,
         query_type: Literal["auto", "semantic", "keyword"] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -137,7 +138,7 @@ async def retrieve(
         Args:
           query: Query to run.
 
-          filter: Filter the query results.
+          collections: Only query documents in these collections.
 
           max_results: Maximum number of results to return.
 
@@ -156,7 +157,7 @@ async def retrieve(
             body=await async_maybe_transform(
                 {
                     "query": query,
-                    "filter": filter,
+                    "collections": collections,
                     "max_results": max_results,
                     "query_type": query_type,
                 },

src/hyperspell/types/document.py

@@ -14,19 +14,22 @@ class Section(BaseModel):
 
     document_id: int
 
-    type: Literal["text", "markdown", "table", "image", "messages", "message"]
+    id: Optional[int] = None
+
+    embedding_e5_large: Optional[List[float]] = None
 
-    children_ids: Optional[List[int]] = None
+    fts: Optional[List[float]] = None
 
     metadata: Optional[object] = None
 
-    parent_id: Optional[int] = None
+    type: Optional[Literal["text", "markdown", "table", "image", "messages", "message"]] = None
+    """Type of the section"""
 
 
 class Document(BaseModel):
     collection_id: int
 
-    resource_id: int
+    resource_id: str
     """Along with service, uniquely identifies the source document"""
 
     id: Optional[int] = None
@@ -41,6 +44,8 @@ class Document(BaseModel):
 
     service: Optional[Literal["slack", "s3", "gmail", "notion", "google_docs", "api"]] = None
 
+    status: Optional[Literal["pending", "processing", "completed", "failed"]] = None
+
     title: Optional[str] = None
 
     type: Optional[Literal["chat", "email", "generic", "transcript", "legal"]] = None

src/hyperspell/types/document_list_params.py

@@ -29,9 +29,6 @@ class Filter(TypedDict, total=False):
     chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
     """Only query chunks of these types."""
 
-    collections: Iterable[int]
-    """Only query documents in these collections."""
-
     document_type: List[Literal["chat", "email", "generic", "transcript", "legal"]]
     """Only query documents of these types."""
 

src/hyperspell/types/query_retrieve_params.py

@@ -2,44 +2,21 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Iterable
-from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
 
-from .._utils import PropertyInfo
-
-__all__ = ["QueryRetrieveParams", "Filter"]
+__all__ = ["QueryRetrieveParams"]
 
 
 class QueryRetrieveParams(TypedDict, total=False):
     query: Required[str]
     """Query to run."""
 
-    filter: Filter
-    """Filter the query results."""
+    collections: List[str]
+    """Only query documents in these collections."""
 
     max_results: int
     """Maximum number of results to return."""
 
     query_type: Literal["auto", "semantic", "keyword"]
     """Type of query to run."""
-
-
-class Filter(TypedDict, total=False):
-    chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
-    """Only query chunks of these types."""
-
-    collections: Iterable[int]
-    """Only query documents in these collections."""
-
-    document_type: List[Literal["chat", "email", "generic", "transcript", "legal"]]
-    """Only query documents of these types."""
-
-    end_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
-    """Only query documents before this date."""
-
-    provider: List[Literal["slack", "s3", "gmail", "notion", "google_docs", "api"]]
-    """Only query documents from these providers."""
-
-    start_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
-    """Only query documents on or after this date."""

tests/api_resources/test_documents.py

@@ -62,7 +62,6 @@ def test_method_list_with_all_params(self, client: Hyperspell) -> None:
             collections=[0],
             filter={
                 "chunk_type": ["text"],
-                "collections": [0],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "provider": ["slack"],
@@ -145,7 +144,6 @@ async def test_method_list_with_all_params(self, async_client: AsyncHyperspell)
             collections=[0],
             filter={
                 "chunk_type": ["text"],
-                "collections": [0],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "provider": ["slack"],

tests/api_resources/test_query.py

@@ -9,7 +9,6 @@
 
 from hyperspell import Hyperspell, AsyncHyperspell
 from tests.utils import assert_matches_type
-from hyperspell._utils import parse_datetime
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -28,14 +27,7 @@ def test_method_retrieve(self, client: Hyperspell) -> None:
     def test_method_retrieve_with_all_params(self, client: Hyperspell) -> None:
         query = client.query.retrieve(
             query="query",
-            filter={
-                "chunk_type": ["text"],
-                "collections": [0],
-                "document_type": ["chat"],
-                "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-                "provider": ["slack"],
-                "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-            },
+            collections=["string"],
             max_results=0,
             query_type="auto",
         )
@@ -80,14 +72,7 @@ async def test_method_retrieve(self, async_client: AsyncHyperspell) -> None:
     async def test_method_retrieve_with_all_params(self, async_client: AsyncHyperspell) -> None:
         query = await async_client.query.retrieve(
             query="query",
-            filter={
-                "chunk_type": ["text"],
-                "collections": [0],
-                "document_type": ["chat"],
-                "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-                "provider": ["slack"],
-                "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-            },
+            collections=["string"],
             max_results=0,
             query_type="auto",
         )