feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 12
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-4bfa5ab6a0021f526d6f6f622f1872f2ec3467b6d1bd51acfc17bfc6f399f915.yml
 openapi_spec_hash: 5b51df5010bab70a1f3f884552ce25c3
-config_hash: 22d90fc758c675b134ffcbbadd4b9be1
+config_hash: c894437241b21cedd2d01854f1c7a8ef

README.md

@@ -32,10 +32,10 @@ client = Hyperspell(
     api_key=os.environ.get("HYPERSPELL_TOKEN"),  # This is the default and can be omitted
 )
 
-document_status = client.memories.add(
+memory_status = client.memories.add(
     text="text",
 )
-print(document_status.id)
+print(memory_status.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -58,10 +58,10 @@ client = AsyncHyperspell(
 
 
 async def main() -> None:
-    document_status = await client.memories.add(
+    memory_status = await client.memories.add(
         text="text",
     )
-    print(document_status.id)
+    print(memory_status.id)
 
 
 asyncio.run(main())
@@ -93,10 +93,10 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        document_status = await client.memories.add(
+        memory_status = await client.memories.add(
             text="text",
         )
-        print(document_status.id)
+        print(memory_status.id)
 
 
 asyncio.run(main())

api.md

@@ -39,17 +39,17 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Document, DocumentStatus, MemorySearchResponse, MemoryStatusResponse
+from hyperspell.types import Memory, MemoryStatus, MemorySearchResponse, 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/document.py">SyncCursorPage[Document]</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/document_status.py">DocumentStatus</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/document.py">Document</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.py">SyncCursorPage[Memory]</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="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/memory_search_response.py">MemorySearchResponse</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/document_status.py">DocumentStatus</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>
 
 # Vaults
 

src/hyperspell/resources/memories.py

@@ -21,8 +21,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.memory import Memory
+from ..types.memory_status import MemoryStatus
 from ..types.memory_search_response import MemorySearchResponse
 from ..types.memory_status_response import MemoryStatusResponse
 
@@ -112,7 +112,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncCursorPage[Document]:
+    ) -> SyncCursorPage[Memory]:
         """This endpoint allows you to paginate through all documents in the index.
 
         You can
@@ -133,7 +133,7 @@ def list(
         """
         return self._get_api_list(
             "/memories/list",
-            page=SyncCursorPage[Document],
+            page=SyncCursorPage[Memory],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -149,7 +149,7 @@ def list(
                     memory_list_params.MemoryListParams,
                 ),
             ),
-            model=Document,
+            model=Memory,
         )
 
     def add(
@@ -166,7 +166,7 @@ def add(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> DocumentStatus:
+    ) -> MemoryStatus:
         """Adds an arbitrary document to the index.
 
         This can be any text, email, call
@@ -211,7 +211,7 @@ def add(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=DocumentStatus,
+            cast_to=MemoryStatus,
         )
 
     def get(
@@ -272,7 +272,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Document:
+    ) -> Memory:
         """
         Retrieves a document by provider and resource_id.
 
@@ -294,7 +294,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=Memory,
         )
 
     def search(
@@ -439,7 +439,7 @@ def upload(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> DocumentStatus:
+    ) -> MemoryStatus:
         """This endpoint will upload a file to the index and return a document ID.
 
         The file
@@ -478,7 +478,7 @@ def upload(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=DocumentStatus,
+            cast_to=MemoryStatus,
         )
 
 
@@ -565,7 +565,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[Document, AsyncCursorPage[Document]]:
+    ) -> AsyncPaginator[Memory, AsyncCursorPage[Memory]]:
         """This endpoint allows you to paginate through all documents in the index.
 
         You can
@@ -586,7 +586,7 @@ def list(
         """
         return self._get_api_list(
             "/memories/list",
-            page=AsyncCursorPage[Document],
+            page=AsyncCursorPage[Memory],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -602,7 +602,7 @@ def list(
                     memory_list_params.MemoryListParams,
                 ),
             ),
-            model=Document,
+            model=Memory,
         )
 
     async def add(
@@ -619,7 +619,7 @@ async def add(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> DocumentStatus:
+    ) -> MemoryStatus:
         """Adds an arbitrary document to the index.
 
         This can be any text, email, call
@@ -664,7 +664,7 @@ async def add(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=DocumentStatus,
+            cast_to=MemoryStatus,
         )
 
     async def get(
@@ -725,7 +725,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Document:
+    ) -> Memory:
         """
         Retrieves a document by provider and resource_id.
 
@@ -747,7 +747,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=Memory,
         )
 
     async def search(
@@ -892,7 +892,7 @@ async def upload(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> DocumentStatus:
+    ) -> MemoryStatus:
         """This endpoint will upload a file to the index and return a document ID.
 
         The file
@@ -931,7 +931,7 @@ async def upload(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=DocumentStatus,
+            cast_to=MemoryStatus,
         )
 
 

src/hyperspell/types/__init__.py

@@ -3,8 +3,8 @@
 from __future__ import annotations
 
 from .token import Token as Token
-from .document import Document as Document
-from .document_status import DocumentStatus as DocumentStatus
+from .memory import Memory as Memory
+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

src/hyperspell/types/document.py src/hyperspell/types/memory.pysrc/hyperspell/types/document.py renamed to src/hyperspell/types/memory.py

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

src/hyperspell/types/memory_search_response.py

@@ -2,14 +2,14 @@
 
 from typing import Dict, List, Optional
 
+from .memory import Memory
 from .._models import BaseModel
-from .document import Document
 
 __all__ = ["MemorySearchResponse"]
 
 
 class MemorySearchResponse(BaseModel):
-    documents: List[Document]
+    documents: List[Memory]
 
     answer: Optional[str] = None
     """The answer to the query, if the request was set to answer."""

src/hyperspell/types/document_status.py src/hyperspell/types/memory_status.pysrc/hyperspell/types/document_status.py renamed to src/hyperspell/types/memory_status.py

@@ -4,10 +4,10 @@
 
 from .._models import BaseModel
 
-__all__ = ["DocumentStatus"]
+__all__ = ["MemoryStatus"]
 
 
-class DocumentStatus(BaseModel):
+class MemoryStatus(BaseModel):
     id: int
     """Deprecated: refer to documents by source and resource_id instead"""