feat(api): api update (#7)

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

src/hyperspell/resources/documents.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import List
+
 import httpx
 
 from ..types import document_list_params
@@ -81,6 +83,7 @@ def retrieve(
     def list(
         self,
         *,
+        collections: List[str],
         filter: document_list_params.Filter | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         page: int | NotGiven = NOT_GIVEN,
@@ -97,6 +100,8 @@ def list(
         filter the documents by title, date, metadata, etc.
 
         Args:
+          collections: The collections to filter documents by.
+
           filter: Filter the query results.
 
           limit: Number of documents to return per page.
@@ -115,6 +120,7 @@ def list(
             "/documents/list",
             body=maybe_transform(
                 {
+                    "collections": collections,
                     "filter": filter,
                     "limit": limit,
                     "page": page,
@@ -184,6 +190,7 @@ async def retrieve(
     async def list(
         self,
         *,
+        collections: List[str],
         filter: document_list_params.Filter | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         page: int | NotGiven = NOT_GIVEN,
@@ -200,6 +207,8 @@ async def list(
         filter the documents by title, date, metadata, etc.
 
         Args:
+          collections: The collections to filter documents by.
+
           filter: Filter the query results.
 
           limit: Number of documents to return per page.
@@ -218,6 +227,7 @@ async def list(
             "/documents/list",
             body=await async_maybe_transform(
                 {
+                    "collections": collections,
                     "filter": filter,
                     "limit": limit,
                     "page": page,

src/hyperspell/types/document.py

@@ -1,45 +1,44 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
+from typing import List, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
 from .._models import BaseModel
 
-__all__ = ["Document", "Chunk"]
+__all__ = ["Document", "Section"]
 
 
-class Chunk(BaseModel):
-    score: float
-
-    text: str
+class Section(BaseModel):
+    content: str
 
     type: Literal["text", "markdown", "table", "image", "messages", "message"]
 
-    metadata: Optional[Dict[str, str]] = None
+    children_ids: Optional[List[str]] = None
 
+    document_id: Optional[str] = None
 
-class Document(BaseModel):
-    id: str
+    metadata: Optional[object] = None
 
-    chunk_count: int
+    parent_id: Optional[str] = None
 
-    ingested_at: datetime
 
-    chunk_ids: Optional[List[str]] = None
+class Document(BaseModel):
+    collection: str
 
-    chunks: Optional[List[Chunk]] = None
+    resource_id: str
+    """Along with service, uniquely identifies the source document"""
 
-    date: Optional[datetime] = None
+    created_at: Optional[datetime] = None
 
-    metadata: Optional[Dict[str, str]] = None
+    ingested_at: Optional[datetime] = None
 
-    org_id: Optional[str] = None
+    metadata: Optional[object] = None
 
-    title: Optional[str] = None
+    sections: Optional[List[Section]] = None
 
-    url: Optional[str] = None
+    service: Optional[Literal["slack", "s3", "gmail", "notion", "google_docs", "api"]] = None
 
-    user_id: Optional[str] = None
+    title: Optional[str] = None
 
-    visibility: Optional[Literal["user", "org", "app", "system"]] = None
+    type: Optional[Literal["chat", "email", "generic", "transcript", "legal"]] = None

src/hyperspell/types/document_list_params.py

@@ -2,16 +2,19 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import List, Union
 from datetime import datetime
-from typing_extensions import Literal, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
 __all__ = ["DocumentListParams", "Filter"]
 
 
 class DocumentListParams(TypedDict, total=False):
+    collections: Required[List[str]]
+    """The collections to filter documents by."""
+
     filter: Filter
     """Filter the query results."""
 
@@ -26,23 +29,17 @@ class Filter(TypedDict, total=False):
     chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
     """Only query chunks of these types."""
 
+    collections: List[str]
+    """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."""
 
-    namespace: Optional[str]
-    """Only query documents in this namespace."""
-
-    org_id: Optional[str]
-    """Only query documents this organization has access to."""
-
     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."""
-
-    user_id: Optional[str]
-    """Only query documents that this user has access to."""

src/hyperspell/types/query_retrieve_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import List, Union
 from datetime import datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
@@ -29,23 +29,17 @@ class Filter(TypedDict, total=False):
     chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
     """Only query chunks of these types."""
 
+    collections: List[str]
+    """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."""
 
-    namespace: Optional[str]
-    """Only query documents in this namespace."""
-
-    org_id: Optional[str]
-    """Only query documents this organization has access to."""
-
     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."""
-
-    user_id: Optional[str]
-    """Only query documents that this user has access to."""

tests/api_resources/test_documents.py

@@ -58,21 +58,22 @@ def test_path_params_retrieve(self, client: Hyperspell) -> None:
 
     @parametrize
     def test_method_list(self, client: Hyperspell) -> None:
-        document = client.documents.list()
+        document = client.documents.list(
+            collections=["string"],
+        )
         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"],
             filter={
                 "chunk_type": ["text"],
+                "collections": ["string"],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-                "namespace": "namespace",
-                "org_id": "org_id",
                 "provider": ["slack"],
                 "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-                "user_id": "user_id",
             },
             limit=0,
             page=2,
@@ -81,7 +82,9 @@ 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()
+        response = client.documents.with_raw_response.list(
+            collections=["string"],
+        )
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -90,7 +93,9 @@ 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() as response:
+        with client.documents.with_streaming_response.list(
+            collections=["string"],
+        ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
@@ -143,21 +148,22 @@ async def test_path_params_retrieve(self, async_client: AsyncHyperspell) -> None
 
     @parametrize
     async def test_method_list(self, async_client: AsyncHyperspell) -> None:
-        document = await async_client.documents.list()
+        document = await async_client.documents.list(
+            collections=["string"],
+        )
         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"],
             filter={
                 "chunk_type": ["text"],
+                "collections": ["string"],
                 "document_type": ["chat"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-                "namespace": "namespace",
-                "org_id": "org_id",
                 "provider": ["slack"],
                 "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),
-                "user_id": "user_id",
             },
             limit=0,
             page=2,
@@ -166,7 +172,9 @@ 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()
+        response = await async_client.documents.with_raw_response.list(
+            collections=["string"],
+        )
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -175,7 +183,9 @@ 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() as response:
+        async with async_client.documents.with_streaming_response.list(
+            collections=["string"],
+        ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 

tests/api_resources/test_query.py

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