feat(api): api update (#79)

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-f234f68066cbaa936bfa4ded50469ce229ade71284a5906bfb47209379889a19.yml
-openapi_spec_hash: 5a1addbaf095472b3f127bc60cfbca9b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-48a7553ceffe2d8152a49b2a73b7a697ba7970643d2df03123cf18debbfe94f1.yml
+openapi_spec_hash: 95cd836db7dd399849563a9c60807257
 config_hash: 63e7969fd7c560b6105e1de79148b568

api.md

@@ -3,15 +3,15 @@
 Types:
 
 ```python
-from hyperspell.types import Document, DocumentStatus, Scores, DocumentListResponse
+from hyperspell.types import DocumentStatus, DocumentListResponse, DocumentGetResponse
 ```
 
 Methods:
 
 - <code title="get /documents/list">client.documents.<a href="./src/hyperspell/resources/documents.py">list</a>(\*\*<a href="src/hyperspell/types/document_list_params.py">params</a>) -> <a href="./src/hyperspell/types/document_list_response.py">SyncCursorPage[DocumentListResponse]</a></code>
 - <code title="post /documents/add">client.documents.<a href="./src/hyperspell/resources/documents.py">add</a>(\*\*<a href="src/hyperspell/types/document_add_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
 - <code title="post /documents/scrape">client.documents.<a href="./src/hyperspell/resources/documents.py">add_url</a>(\*\*<a href="src/hyperspell/types/document_add_url_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
-- <code title="get /documents/get/{document_id}">client.documents.<a href="./src/hyperspell/resources/documents.py">get</a>(document_id) -> <a href="./src/hyperspell/types/document.py">Document</a></code>
+- <code title="get /documents/get/{document_id}">client.documents.<a href="./src/hyperspell/resources/documents.py">get</a>(document_id) -> <a href="./src/hyperspell/types/document_get_response.py">DocumentGetResponse</a></code>
 - <code title="post /documents/upload">client.documents.<a href="./src/hyperspell/resources/documents.py">upload</a>(\*\*<a href="src/hyperspell/types/document_upload_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
 
 # Collections

src/hyperspell/resources/documents.py

@@ -31,8 +31,8 @@
 )
 from ..pagination import SyncCursorPage, AsyncCursorPage
 from .._base_client import AsyncPaginator, make_request_options
-from ..types.document import Document
 from ..types.document_status import DocumentStatus
+from ..types.document_get_response import DocumentGetResponse
 from ..types.document_list_response import DocumentListResponse
 
 __all__ = ["DocumentsResource", "AsyncDocumentsResource"]
@@ -111,7 +111,9 @@ def add(
         text: str,
         collection: Optional[str] | NotGiven = NOT_GIVEN,
         date: Union[str, datetime] | NotGiven = NOT_GIVEN,
-        source: Literal["generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"]
+        source: Literal[
+            "generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot", "reddit", "google-calendar"
+        ]
         | NotGiven = NOT_GIVEN,
         title: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -228,7 +230,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Document:
+    ) -> DocumentGetResponse:
         """
         Retrieves a document by ID, including its collection name and sections.
 
@@ -246,7 +248,7 @@ def get(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Document,
+            cast_to=DocumentGetResponse,
         )
 
     def upload(
@@ -376,7 +378,9 @@ async def add(
         text: str,
         collection: Optional[str] | NotGiven = NOT_GIVEN,
         date: Union[str, datetime] | NotGiven = NOT_GIVEN,
-        source: Literal["generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"]
+        source: Literal[
+            "generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot", "reddit", "google-calendar"
+        ]
         | NotGiven = NOT_GIVEN,
         title: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -493,7 +497,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Document:
+    ) -> DocumentGetResponse:
         """
         Retrieves a document by ID, including its collection name and sections.
 
@@ -511,7 +515,7 @@ async def get(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Document,
+            cast_to=DocumentGetResponse,
         )
 
     async def upload(

src/hyperspell/resources/query.py

@@ -53,7 +53,6 @@ def search(
         query: str,
         collections: Union[str, List[str], None] | NotGiven = NOT_GIVEN,
         filter: query_search_params.Filter | NotGiven = NOT_GIVEN,
-        include_elements: bool | 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.
@@ -74,8 +73,6 @@ def search(
 
           filter: Filter the query results.
 
-          include_elements: Include the elements of a section in the results.
-
           max_results: Maximum number of results to return.
 
           query_type: Type of query to run.
@@ -95,7 +92,6 @@ def search(
                     "query": query,
                     "collections": collections,
                     "filter": filter,
-                    "include_elements": include_elements,
                     "max_results": max_results,
                     "query_type": query_type,
                 },
@@ -134,7 +130,6 @@ async def search(
         query: str,
         collections: Union[str, List[str], None] | NotGiven = NOT_GIVEN,
         filter: query_search_params.Filter | NotGiven = NOT_GIVEN,
-        include_elements: bool | 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.
@@ -155,8 +150,6 @@ async def search(
 
           filter: Filter the query results.
 
-          include_elements: Include the elements of a section in the results.
-
           max_results: Maximum number of results to return.
 
           query_type: Type of query to run.
@@ -176,7 +169,6 @@ async def search(
                     "query": query,
                     "collections": collections,
                     "filter": filter,
-                    "include_elements": include_elements,
                     "max_results": max_results,
                     "query_type": query_type,
                 },

src/hyperspell/types/__init__.py

@@ -3,13 +3,12 @@
 from __future__ import annotations
 
 from .token import Token as Token
-from .scores import Scores as Scores
-from .document import Document as Document
 from .collection import Collection as Collection
 from .document_status import DocumentStatus as DocumentStatus
 from .document_add_params import DocumentAddParams as DocumentAddParams
 from .query_search_params import QuerySearchParams as QuerySearchParams
 from .document_list_params import DocumentListParams as DocumentListParams
+from .document_get_response import DocumentGetResponse as DocumentGetResponse
 from .query_search_response import QuerySearchResponse as QuerySearchResponse
 from .auth_user_token_params import AuthUserTokenParams as AuthUserTokenParams
 from .collection_list_params import CollectionListParams as CollectionListParams

src/hyperspell/types/document.py

@@ -31,7 +31,9 @@ class DocumentAddParams(TypedDict, total=False):
     range.
     """
 
-    source: Literal["generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"]
+    source: Literal[
+        "generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot", "reddit", "google-calendar"
+    ]
     """Source of the document.
 
     This helps in parsing the document. Note that some sources require the document

src/hyperspell/types/document_add_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["DocumentGetResponse", "Event"]
+
+
+class Event(BaseModel):
+    message: str
+
+    type: Literal["error", "warning", "info"]
+
+    time: Optional[datetime] = None
+
+
+class DocumentGetResponse(BaseModel):
+    collection: str
+
+    resource_id: str
+
+    source: Literal[
+        "generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot", "reddit", "google-calendar"
+    ]
+
+    id: Optional[int] = None
+
+    data: Optional[List[object]] = None
+
+    events: Optional[List[Event]] = None
+
+    extra: Optional[object] = None
+
+    highlights: Optional[List[object]] = None
+
+    summary: Optional[str] = None
+
+    title: Optional[str] = None

src/hyperspell/types/document_get_response.py

@@ -1,10 +1,9 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Union, Optional
+from typing import Dict, List, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
-from .scores import Scores
 from .._models import BaseModel
 
 __all__ = ["DocumentListResponse", "Event", "Section"]
@@ -36,12 +35,10 @@ class Section(BaseModel):
 
     metadata: Optional[Dict[str, object]] = None
 
-    scores: Optional[Scores] = None
-
 
 class DocumentListResponse(BaseModel):
-    data: Union[List[object], object]
-    """Structured representation of the document"""
+    data: List[object]
+    """Summary of the document"""
 
     summary: str
     """Summary of the document"""
@@ -65,7 +62,11 @@ class DocumentListResponse(BaseModel):
 
     sections_count: Optional[int] = None
 
-    source: Optional[Literal["generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"]] = None
+    source: Optional[
+        Literal[
+            "generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot", "reddit", "google-calendar"
+        ]
+    ] = None
 
     status: Optional[Literal["pending", "processing", "completed", "failed"]] = None
 
@@ -96,5 +97,6 @@ class DocumentListResponse(BaseModel):
             "person",
             "company",
             "crm_contact",
+            "event",
         ]
     ] = None

src/hyperspell/types/document_list_response.py

@@ -24,9 +24,6 @@ class QuerySearchParams(TypedDict, total=False):
     filter: Filter
     """Filter the query results."""
 
-    include_elements: bool
-    """Include the elements of a section in the results."""
-
     max_results: int
     """Maximum number of results to return."""
 
@@ -38,7 +35,11 @@ class Filter(TypedDict, total=False):
     end_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents before this date."""
 
-    source: List[Literal["generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"]]
+    source: List[
+        Literal[
+            "generic", "mcp", "slack", "s3", "gmail", "notion", "google_docs", "hubspot", "reddit", "google-calendar"
+        ]
+    ]
     """Only query documents from these sources."""
 
     start_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
@@ -69,6 +70,7 @@ class Filter(TypedDict, total=False):
             "person",
             "company",
             "crm_contact",
+            "event",
         ]
     ]
     """Only query documents of these types."""