feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 21
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-4f19d2194ceebd4e2f52fefc09e7936f3ce417a943a0709623c5de1edc9bfc78.yml
-openapi_spec_hash: 536a71de5eb401a09790bec0d26a32a0
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-a08047fff67bf0bb9fd8223baba5091eea8477e1933954222e0a690ddce41d5c.yml
+openapi_spec_hash: 7d2a75a868b25e22515a73835d7e13da
 config_hash: ca45358b5407440488ec988e3ee21412

api.md

@@ -65,15 +65,21 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Memory, MemoryStatus, MemoryDeleteResponse, MemoryStatusResponse
+from hyperspell.types import (
+    MemoryStatus,
+    MemoryListResponse,
+    MemoryDeleteResponse,
+    MemoryGetResponse,
+    MemoryStatusResponse,
+)
 ```
 
 Methods:
 
-- <code title="get /memories/list">client.memories.<a href="./src/hyperspell/resources/memories.py">list</a>(\*\*<a href="src/hyperspell/types/memory_list_params.py">params</a>) -> <a href="./src/hyperspell/types/memory.py">SyncCursorPage[Memory]</a></code>
+- <code title="get /memories/list">client.memories.<a href="./src/hyperspell/resources/memories.py">list</a>(\*\*<a href="src/hyperspell/types/memory_list_params.py">params</a>) -> <a href="./src/hyperspell/types/memory_list_response.py">SyncCursorPage[MemoryListResponse]</a></code>
 - <code title="delete /memories/delete/{source}/{resource_id}">client.memories.<a href="./src/hyperspell/resources/memories.py">delete</a>(resource_id, \*, source) -> <a href="./src/hyperspell/types/memory_delete_response.py">MemoryDeleteResponse</a></code>
 - <code title="post /memories/add">client.memories.<a href="./src/hyperspell/resources/memories.py">add</a>(\*\*<a href="src/hyperspell/types/memory_add_params.py">params</a>) -> <a href="./src/hyperspell/types/memory_status.py">MemoryStatus</a></code>
-- <code title="get /memories/get/{source}/{resource_id}">client.memories.<a href="./src/hyperspell/resources/memories.py">get</a>(resource_id, \*, source) -> <a href="./src/hyperspell/types/memory.py">Memory</a></code>
+- <code title="get /memories/get/{source}/{resource_id}">client.memories.<a href="./src/hyperspell/resources/memories.py">get</a>(resource_id, \*, source) -> <a href="./src/hyperspell/types/memory_get_response.py">MemoryGetResponse</a></code>
 - <code title="post /memories/query">client.memories.<a href="./src/hyperspell/resources/memories.py">search</a>(\*\*<a href="src/hyperspell/types/memory_search_params.py">params</a>) -> <a href="./src/hyperspell/types/shared/query_result.py">QueryResult</a></code>
 - <code title="get /memories/status">client.memories.<a href="./src/hyperspell/resources/memories.py">status</a>() -> <a href="./src/hyperspell/types/memory_status_response.py">MemoryStatusResponse</a></code>
 - <code title="post /memories/upload">client.memories.<a href="./src/hyperspell/resources/memories.py">upload</a>(\*\*<a href="src/hyperspell/types/memory_upload_params.py">params</a>) -> <a href="./src/hyperspell/types/memory_status.py">MemoryStatus</a></code>

src/hyperspell/resources/memories.py

@@ -21,9 +21,10 @@
 )
 from ..pagination import SyncCursorPage, AsyncCursorPage
 from .._base_client import AsyncPaginator, make_request_options
-from ..types.memory import Memory
 from ..types.memory_status import MemoryStatus
+from ..types.memory_get_response import MemoryGetResponse
 from ..types.shared.query_result import QueryResult
+from ..types.memory_list_response import MemoryListResponse
 from ..types.memory_delete_response import MemoryDeleteResponse
 from ..types.memory_status_response import MemoryStatusResponse
 
@@ -113,7 +114,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SyncCursorPage[Memory]:
+    ) -> SyncCursorPage[MemoryListResponse]:
         """This endpoint allows you to paginate through all documents in the index.
 
         You can
@@ -134,7 +135,7 @@ def list(
         """
         return self._get_api_list(
             "/memories/list",
-            page=SyncCursorPage[Memory],
+            page=SyncCursorPage[MemoryListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -150,7 +151,7 @@ def list(
                     memory_list_params.MemoryListParams,
                 ),
             ),
-            model=Memory,
+            model=MemoryListResponse,
         )
 
     def delete(
@@ -370,7 +371,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Memory:
+    ) -> MemoryGetResponse:
         """
         Retrieves a document by provider and resource_id.
 
@@ -392,7 +393,7 @@ def get(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Memory,
+            cast_to=MemoryGetResponse,
         )
 
     def search(
@@ -659,7 +660,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AsyncPaginator[Memory, AsyncCursorPage[Memory]]:
+    ) -> AsyncPaginator[MemoryListResponse, AsyncCursorPage[MemoryListResponse]]:
         """This endpoint allows you to paginate through all documents in the index.
 
         You can
@@ -680,7 +681,7 @@ def list(
         """
         return self._get_api_list(
             "/memories/list",
-            page=AsyncCursorPage[Memory],
+            page=AsyncCursorPage[MemoryListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -696,7 +697,7 @@ def list(
                     memory_list_params.MemoryListParams,
                 ),
             ),
-            model=Memory,
+            model=MemoryListResponse,
         )
 
     async def delete(
@@ -916,7 +917,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Memory:
+    ) -> MemoryGetResponse:
         """
         Retrieves a document by provider and resource_id.
 
@@ -938,7 +939,7 @@ async def get(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Memory,
+            cast_to=MemoryGetResponse,
         )
 
     async def search(

src/hyperspell/types/__init__.py

@@ -3,14 +3,15 @@
 from __future__ import annotations
 
 from .token import Token as Token
-from .memory import Memory as Memory
 from .shared import QueryResult as QueryResult
 from .memory_status import MemoryStatus as MemoryStatus
 from .auth_me_response import AuthMeResponse as AuthMeResponse
 from .memory_add_params import MemoryAddParams as MemoryAddParams
 from .vault_list_params import VaultListParams as VaultListParams
 from .memory_list_params import MemoryListParams as MemoryListParams
+from .memory_get_response import MemoryGetResponse as MemoryGetResponse
 from .vault_list_response import VaultListResponse as VaultListResponse
+from .memory_list_response import MemoryListResponse as MemoryListResponse
 from .memory_search_params import MemorySearchParams as MemorySearchParams
 from .memory_upload_params import MemoryUploadParams as MemoryUploadParams
 from .auth_user_token_params import AuthUserTokenParams as AuthUserTokenParams

src/hyperspell/types/memory.py renamed to src/hyperspell/types/memory_get_response.py

@@ -8,7 +8,7 @@
 
 from .._models import BaseModel
 
-__all__ = ["Memory", "Metadata", "MetadataEvent"]
+__all__ = ["MemoryGetResponse", "Metadata", "MetadataEvent"]
 
 
 class MetadataEvent(BaseModel):
@@ -45,7 +45,7 @@ def __getattr__(self, attr: str) -> object: ...
         __pydantic_extra__: Dict[str, object]
 
 
-class Memory(BaseModel):
+class MemoryGetResponse(BaseModel):
     resource_id: str
 
     source: Literal[

src/hyperspell/types/memory_list_response.py

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import TYPE_CHECKING, Dict, List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["MemoryListResponse", "Metadata", "MetadataEvent"]
+
+
+class MetadataEvent(BaseModel):
+    message: str
+
+    type: Literal["error", "warning", "info", "success"]
+
+    time: Optional[datetime] = None
+
+
+class Metadata(BaseModel):
+    created_at: Optional[datetime] = None
+
+    events: Optional[List[MetadataEvent]] = None
+
+    indexed_at: Optional[datetime] = None
+
+    last_modified: Optional[datetime] = None
+
+    status: Optional[Literal["pending", "processing", "completed", "failed"]] = None
+
+    url: Optional[str] = None
+
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
+
+
+class MemoryListResponse(BaseModel):
+    resource_id: str
+
+    source: Literal[
+        "collections",
+        "vault",
+        "web_crawler",
+        "notion",
+        "slack",
+        "google_calendar",
+        "reddit",
+        "box",
+        "google_drive",
+        "airtable",
+        "algolia",
+        "amplitude",
+        "asana",
+        "ashby",
+        "bamboohr",
+        "basecamp",
+        "bubbles",
+        "calendly",
+        "confluence",
+        "clickup",
+        "datadog",
+        "deel",
+        "discord",
+        "dropbox",
+        "exa",
+        "facebook",
+        "front",
+        "github",
+        "gitlab",
+        "google_docs",
+        "google_mail",
+        "google_sheet",
+        "hubspot",
+        "jira",
+        "linear",
+        "microsoft_teams",
+        "mixpanel",
+        "monday",
+        "outlook",
+        "perplexity",
+        "rippling",
+        "salesforce",
+        "segment",
+        "todoist",
+        "twitter",
+        "zoom",
+    ]
+
+    metadata: Optional[Metadata] = None
+
+    score: Optional[float] = None
+    """The relevance of the resource to the query"""
+
+    title: Optional[str] = None

src/hyperspell/types/shared/query_result.py

@@ -1,15 +1,112 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
+from typing import TYPE_CHECKING, Dict, List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
 
-from ..memory import Memory
 from ..._models import BaseModel
 
-__all__ = ["QueryResult"]
+__all__ = ["QueryResult", "Document", "DocumentMetadata", "DocumentMetadataEvent"]
+
+
+class DocumentMetadataEvent(BaseModel):
+    message: str
+
+    type: Literal["error", "warning", "info", "success"]
+
+    time: Optional[datetime] = None
+
+
+class DocumentMetadata(BaseModel):
+    created_at: Optional[datetime] = None
+
+    events: Optional[List[DocumentMetadataEvent]] = None
+
+    indexed_at: Optional[datetime] = None
+
+    last_modified: Optional[datetime] = None
+
+    status: Optional[Literal["pending", "processing", "completed", "failed"]] = None
+
+    url: Optional[str] = None
+
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
+
+
+class Document(BaseModel):
+    resource_id: str
+
+    source: Literal[
+        "collections",
+        "vault",
+        "web_crawler",
+        "notion",
+        "slack",
+        "google_calendar",
+        "reddit",
+        "box",
+        "google_drive",
+        "airtable",
+        "algolia",
+        "amplitude",
+        "asana",
+        "ashby",
+        "bamboohr",
+        "basecamp",
+        "bubbles",
+        "calendly",
+        "confluence",
+        "clickup",
+        "datadog",
+        "deel",
+        "discord",
+        "dropbox",
+        "exa",
+        "facebook",
+        "front",
+        "github",
+        "gitlab",
+        "google_docs",
+        "google_mail",
+        "google_sheet",
+        "hubspot",
+        "jira",
+        "linear",
+        "microsoft_teams",
+        "mixpanel",
+        "monday",
+        "outlook",
+        "perplexity",
+        "rippling",
+        "salesforce",
+        "segment",
+        "todoist",
+        "twitter",
+        "zoom",
+    ]
+
+    metadata: Optional[DocumentMetadata] = None
+
+    score: Optional[float] = None
+    """The relevance of the resource to the query"""
+
+    title: Optional[str] = None
 
 
 class QueryResult(BaseModel):
-    documents: List[Memory]
+    documents: List[Document]
 
     answer: Optional[str] = None
     """The answer to the query, if the request was set to answer."""