feat(api): api update (#8)

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-94e926477d6338146c22b4645e1419c0b3494d6b891062d2da7ad1134ab0aeae.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-2b929bd185bb270d17b7f342cc157df373f6b8043d4d90c9ade596680ee5ea34.yml

src/hyperspell/resources/documents.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List
+from typing import Iterable
 
 import httpx
 
@@ -49,7 +49,7 @@ def with_streaming_response(self) -> DocumentsResourceWithStreamingResponse:
 
     def retrieve(
         self,
-        document_id: str,
+        document_id: int,
         *,
         # 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.
@@ -70,8 +70,6 @@ def retrieve(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not document_id:
-            raise ValueError(f"Expected a non-empty value for `document_id` but received {document_id!r}")
         return self._get(
             f"/documents/get/{document_id}",
             options=make_request_options(
@@ -83,7 +81,7 @@ def retrieve(
     def list(
         self,
         *,
-        collections: List[str],
+        collections: Iterable[int],
         filter: document_list_params.Filter | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         page: int | NotGiven = NOT_GIVEN,
@@ -156,7 +154,7 @@ def with_streaming_response(self) -> AsyncDocumentsResourceWithStreamingResponse
 
     async def retrieve(
         self,
-        document_id: str,
+        document_id: int,
         *,
         # 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.
@@ -177,8 +175,6 @@ async def retrieve(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not document_id:
-            raise ValueError(f"Expected a non-empty value for `document_id` but received {document_id!r}")
         return await self._get(
             f"/documents/get/{document_id}",
             options=make_request_options(
@@ -190,7 +186,7 @@ async def retrieve(
     async def list(
         self,
         *,
-        collections: List[str],
+        collections: Iterable[int],
         filter: document_list_params.Filter | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         page: int | NotGiven = NOT_GIVEN,

src/hyperspell/types/document.py

@@ -14,21 +14,23 @@ class Section(BaseModel):
 
     type: Literal["text", "markdown", "table", "image", "messages", "message"]
 
-    children_ids: Optional[List[str]] = None
+    children_ids: Optional[List[int]] = None
 
-    document_id: Optional[str] = None
+    document_id: Optional[int] = None
 
     metadata: Optional[object] = None
 
-    parent_id: Optional[str] = None
+    parent_id: Optional[int] = None
 
 
 class Document(BaseModel):
-    collection: str
+    collection_id: int
 
-    resource_id: str
+    resource_id: int
     """Along with service, uniquely identifies the source document"""
 
+    id: Optional[int] = None
+
     created_at: Optional[datetime] = None
 
     ingested_at: Optional[datetime] = None

src/hyperspell/types/document_list_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import List, Union, Iterable
 from datetime import datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
@@ -12,7 +12,7 @@
 
 
 class DocumentListParams(TypedDict, total=False):
-    collections: Required[List[str]]
+    collections: Required[Iterable[int]]
     """The collections to filter documents by."""
 
     filter: Filter
@@ -29,7 +29,7 @@ class Filter(TypedDict, total=False):
     chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
     """Only query chunks of these types."""
 
-    collections: List[str]
+    collections: Iterable[int]
     """Only query documents in these collections."""
 
     document_type: List[Literal["chat", "email", "generic", "transcript", "legal"]]

src/hyperspell/types/query_retrieve_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import List, Union, Iterable
 from datetime import datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
@@ -29,7 +29,7 @@ class Filter(TypedDict, total=False):
     chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
     """Only query chunks of these types."""
 
-    collections: List[str]
+    collections: Iterable[int]
     """Only query documents in these collections."""
 
     document_type: List[Literal["chat", "email", "generic", "transcript", "legal"]]

tests/api_resources/test_documents.py

@@ -21,14 +21,14 @@ class TestDocuments:
     @parametrize
     def test_method_retrieve(self, client: Hyperspell) -> None:
         document = client.documents.retrieve(
-            "document_id",
+            0,
         )
         assert_matches_type(Document, document, path=["response"])
 
     @parametrize
     def test_raw_response_retrieve(self, client: Hyperspell) -> None:
         response = client.documents.with_raw_response.retrieve(
-            "document_id",
+            0,
         )
 
         assert response.is_closed is True
@@ -39,7 +39,7 @@ def test_raw_response_retrieve(self, client: Hyperspell) -> None:
     @parametrize
     def test_streaming_response_retrieve(self, client: Hyperspell) -> None:
         with client.documents.with_streaming_response.retrieve(
-            "document_id",
+            0,
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -49,27 +49,20 @@ def test_streaming_response_retrieve(self, client: Hyperspell) -> None:
 
         assert cast(Any, response.is_closed) is True
 
-    @parametrize
-    def test_path_params_retrieve(self, client: Hyperspell) -> None:
-        with pytest.raises(ValueError, match=r"Expected a non-empty value for `document_id` but received ''"):
-            client.documents.with_raw_response.retrieve(
-                "",
-            )
-
     @parametrize
     def test_method_list(self, client: Hyperspell) -> None:
         document = client.documents.list(
-            collections=["string"],
+            collections=[0],
         )
         assert_matches_type(DocumentListResponse, document, path=["response"])
 
     @parametrize
     def test_method_list_with_all_params(self, client: Hyperspell) -> None:
         document = client.documents.list(
-            collections=["string"],
+            collections=[0],
             filter={
                 "chunk_type": ["text"],
-                "collections": ["string"],
+                "collections": [0],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "provider": ["slack"],
@@ -83,7 +76,7 @@ def test_method_list_with_all_params(self, client: Hyperspell) -> None:
     @parametrize
     def test_raw_response_list(self, client: Hyperspell) -> None:
         response = client.documents.with_raw_response.list(
-            collections=["string"],
+            collections=[0],
         )
 
         assert response.is_closed is True
@@ -94,7 +87,7 @@ def test_raw_response_list(self, client: Hyperspell) -> None:
     @parametrize
     def test_streaming_response_list(self, client: Hyperspell) -> None:
         with client.documents.with_streaming_response.list(
-            collections=["string"],
+            collections=[0],
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -111,14 +104,14 @@ class TestAsyncDocuments:
     @parametrize
     async def test_method_retrieve(self, async_client: AsyncHyperspell) -> None:
         document = await async_client.documents.retrieve(
-            "document_id",
+            0,
         )
         assert_matches_type(Document, document, path=["response"])
 
     @parametrize
     async def test_raw_response_retrieve(self, async_client: AsyncHyperspell) -> None:
         response = await async_client.documents.with_raw_response.retrieve(
-            "document_id",
+            0,
         )
 
         assert response.is_closed is True
@@ -129,7 +122,7 @@ async def test_raw_response_retrieve(self, async_client: AsyncHyperspell) -> Non
     @parametrize
     async def test_streaming_response_retrieve(self, async_client: AsyncHyperspell) -> None:
         async with async_client.documents.with_streaming_response.retrieve(
-            "document_id",
+            0,
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -139,27 +132,20 @@ async def test_streaming_response_retrieve(self, async_client: AsyncHyperspell)
 
         assert cast(Any, response.is_closed) is True
 
-    @parametrize
-    async def test_path_params_retrieve(self, async_client: AsyncHyperspell) -> None:
-        with pytest.raises(ValueError, match=r"Expected a non-empty value for `document_id` but received ''"):
-            await async_client.documents.with_raw_response.retrieve(
-                "",
-            )
-
     @parametrize
     async def test_method_list(self, async_client: AsyncHyperspell) -> None:
         document = await async_client.documents.list(
-            collections=["string"],
+            collections=[0],
         )
         assert_matches_type(DocumentListResponse, document, path=["response"])
 
     @parametrize
     async def test_method_list_with_all_params(self, async_client: AsyncHyperspell) -> None:
         document = await async_client.documents.list(
-            collections=["string"],
+            collections=[0],
             filter={
                 "chunk_type": ["text"],
-                "collections": ["string"],
+                "collections": [0],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "provider": ["slack"],
@@ -173,7 +159,7 @@ async def test_method_list_with_all_params(self, async_client: AsyncHyperspell)
     @parametrize
     async def test_raw_response_list(self, async_client: AsyncHyperspell) -> None:
         response = await async_client.documents.with_raw_response.list(
-            collections=["string"],
+            collections=[0],
         )
 
         assert response.is_closed is True
@@ -184,7 +170,7 @@ async def test_raw_response_list(self, async_client: AsyncHyperspell) -> None:
     @parametrize
     async def test_streaming_response_list(self, async_client: AsyncHyperspell) -> None:
         async with async_client.documents.with_streaming_response.list(
-            collections=["string"],
+            collections=[0],
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"

tests/api_resources/test_query.py

@@ -30,7 +30,7 @@ def test_method_retrieve_with_all_params(self, client: Hyperspell) -> None:
             query="query",
             filter={
                 "chunk_type": ["text"],
-                "collections": ["string"],
+                "collections": [0],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "provider": ["slack"],
@@ -82,7 +82,7 @@ async def test_method_retrieve_with_all_params(self, async_client: AsyncHyperspe
             query="query",
             filter={
                 "chunk_type": ["text"],
-                "collections": ["string"],
+                "collections": [0],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "provider": ["slack"],