feat(api): api update

Author: stainless-app[bot]

.github/workflows/create-releases.yml

@@ -0,0 +1,38 @@
+name: Create releases
+on:
+  schedule:
+    - cron: '0 5 * * *' # every day at 5am UTC
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: release
+    if: github.ref == 'refs/heads/main' && github.repository == 'hyperspell/python-sdk'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: stainless-api/trigger-release-please@v1
+        id: release
+        with:
+          repo: ${{ github.event.repository.full_name }}
+          stainless-api-key: ${{ secrets.STAINLESS_API_KEY }}
+
+      - name: Install Rye
+        if: ${{ steps.release.outputs.releases_created }}
+        run: |
+          curl -sSf https://rye.astral.sh/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: '0.44.0'
+          RYE_INSTALL_OPTION: '--yes'
+
+      - name: Publish to PyPI
+        if: ${{ steps.release.outputs.releases_created }}
+        run: |
+          bash ./bin/publish-pypi
+        env:
+          PYPI_TOKEN: ${{ secrets.HYPERSPELL_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/publish-pypi.yml

@@ -1,13 +1,9 @@
-# This workflow is triggered when a GitHub release is created.
-# It can also be run manually to re-publish to PyPI in case it failed for some reason.
-# You can run this workflow by navigating to https://www.github.com/hyperspell/python-sdk/actions/workflows/publish-pypi.yml
+# workflow for re-running publishing to PyPI in case it fails for some reason
+# you can run this workflow by navigating to https://www.github.com/hyperspell/python-sdk/actions/workflows/publish-pypi.yml
 name: Publish PyPI
 on:
   workflow_dispatch:
 
-  release:
-    types: [published]
-
 jobs:
   publish:
     name: publish

.github/workflows/release-doctor.yml

@@ -18,4 +18,5 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
+          STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }}
           PYPI_TOKEN: ${{ secrets.HYPERSPELL_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-036faa49b258b84e5e0b005039461bfc4942c718fb105444d863b9d7af2922f2.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-4e177b58fa8cf23ba450d5247fcad65a6bbe1921ae3d5d42180e496e40a9864f.yml

README.md

@@ -32,7 +32,6 @@ client = Hyperspell(
 )
 
 document_status = client.documents.add(
-    collection="collection",
     text="text",
 )
 print(document_status.id)
@@ -59,7 +58,6 @@ client = AsyncHyperspell(
 
 async def main() -> None:
     document_status = await client.documents.add(
-        collection="collection",
         text="text",
     )
     print(document_status.id)
@@ -163,12 +161,12 @@ from hyperspell import Hyperspell
 client = Hyperspell()
 
 response = client.query.search(
-    collections="string",
     query="query",
     filter={
         "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
         "source": ["generic"],
         "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),
+        "types": ["generic"],
     },
 )
 print(response.filter)
@@ -209,7 +207,6 @@ client = Hyperspell()
 
 try:
     client.documents.add(
-        collection="collection",
         text="text",
     )
 except hyperspell.APIConnectionError as e:
@@ -255,7 +252,6 @@ client = Hyperspell(
 
 # Or, configure per-request:
 client.with_options(max_retries=5).documents.add(
-    collection="collection",
     text="text",
 )
 ```
@@ -281,7 +277,6 @@ client = Hyperspell(
 
 # Override per-request:
 client.with_options(timeout=5.0).documents.add(
-    collection="collection",
     text="text",
 )
 ```
@@ -325,7 +320,6 @@ from hyperspell import Hyperspell
 
 client = Hyperspell()
 response = client.documents.with_raw_response.add(
-    collection="collection",
     text="text",
 )
 print(response.headers.get('X-My-Header'))
@@ -346,7 +340,6 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.documents.with_streaming_response.add(
-    collection="collection",
     text="text",
 ) as response:
     print(response.headers.get("X-My-Header"))

bin/check-release-environment

@@ -2,6 +2,10 @@
 
 errors=()
 
+if [ -z "${STAINLESS_API_KEY}" ]; then
+  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.")
+fi
+
 if [ -z "${PYPI_TOKEN}" ]; then
   errors+=("The HYPERSPELL_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
 fi

src/hyperspell/resources/documents.py

@@ -61,7 +61,7 @@ def with_streaming_response(self) -> DocumentsResourceWithStreamingResponse:
     def list(
         self,
         *,
-        collection: str,
+        collection: Optional[str] | NotGiven = NOT_GIVEN,
         cursor: Optional[str] | NotGiven = NOT_GIVEN,
         size: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -108,27 +108,10 @@ def list(
     def add(
         self,
         *,
-        collection: str,
         text: str,
+        collection: Optional[str] | NotGiven = NOT_GIVEN,
         date: Union[str, datetime] | NotGiven = NOT_GIVEN,
-        source: Literal[
-            "generic",
-            "markdown",
-            "chat",
-            "email",
-            "transcript",
-            "legal",
-            "website",
-            "image",
-            "pdf",
-            "audio",
-            "slack",
-            "s3",
-            "gmail",
-            "notion",
-            "google_docs",
-        ]
-        | NotGiven = NOT_GIVEN,
+        source: Literal["generic", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"] | 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.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -144,11 +127,12 @@ def add(
         once the processing is complete.
 
         Args:
-          collection: Name of the collection to add the document to. If the collection does not exist,
-              it will be created.
-
           text: Full text of the document.
 
+          collection: Name of the collection to add the document to. If the collection does not exist,
+              it will be created. If not given, the document will be added to the user's
+              default collection.
+
           date: Date of the document. Depending on the document, this could be the creation date
               or date the document was last updated (eg. for a chat transcript, this would be
               the date of the last message). This helps the ranking algorithm and allows you
@@ -171,8 +155,8 @@ def add(
             "/documents/add",
             body=maybe_transform(
                 {
-                    "collection": collection,
                     "text": text,
+                    "collection": collection,
                     "date": date,
                     "source": source,
                     "title": title,
@@ -188,8 +172,8 @@ def add(
     def add_url(
         self,
         *,
-        collection: str,
         url: str,
+        collection: 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.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -204,11 +188,12 @@ def add_url(
         once the processing is complete.
 
         Args:
-          collection: Name of the collection to add the document to. If the collection does not exist,
-              it will be created.
-
           url: Source URL of the document.
 
+          collection: Name of the collection to add the document to. If the collection does not exist,
+              it will be created. If not given, the document will be added to the user's
+              default collection.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -221,8 +206,8 @@ def add_url(
             "/documents/scrape",
             body=maybe_transform(
                 {
-                    "collection": collection,
                     "url": url,
+                    "collection": collection,
                 },
                 document_add_url_params.DocumentAddURLParams,
             ),
@@ -340,7 +325,7 @@ def with_streaming_response(self) -> AsyncDocumentsResourceWithStreamingResponse
     def list(
         self,
         *,
-        collection: str,
+        collection: Optional[str] | NotGiven = NOT_GIVEN,
         cursor: Optional[str] | NotGiven = NOT_GIVEN,
         size: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -387,27 +372,10 @@ def list(
     async def add(
         self,
         *,
-        collection: str,
         text: str,
+        collection: Optional[str] | NotGiven = NOT_GIVEN,
         date: Union[str, datetime] | NotGiven = NOT_GIVEN,
-        source: Literal[
-            "generic",
-            "markdown",
-            "chat",
-            "email",
-            "transcript",
-            "legal",
-            "website",
-            "image",
-            "pdf",
-            "audio",
-            "slack",
-            "s3",
-            "gmail",
-            "notion",
-            "google_docs",
-        ]
-        | NotGiven = NOT_GIVEN,
+        source: Literal["generic", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"] | 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.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -423,11 +391,12 @@ async def add(
         once the processing is complete.
 
         Args:
-          collection: Name of the collection to add the document to. If the collection does not exist,
-              it will be created.
-
           text: Full text of the document.
 
+          collection: Name of the collection to add the document to. If the collection does not exist,
+              it will be created. If not given, the document will be added to the user's
+              default collection.
+
           date: Date of the document. Depending on the document, this could be the creation date
               or date the document was last updated (eg. for a chat transcript, this would be
               the date of the last message). This helps the ranking algorithm and allows you
@@ -450,8 +419,8 @@ async def add(
             "/documents/add",
             body=await async_maybe_transform(
                 {
-                    "collection": collection,
                     "text": text,
+                    "collection": collection,
                     "date": date,
                     "source": source,
                     "title": title,
@@ -467,8 +436,8 @@ async def add(
     async def add_url(
         self,
         *,
-        collection: str,
         url: str,
+        collection: 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.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -483,11 +452,12 @@ async def add_url(
         once the processing is complete.
 
         Args:
-          collection: Name of the collection to add the document to. If the collection does not exist,
-              it will be created.
-
           url: Source URL of the document.
 
+          collection: Name of the collection to add the document to. If the collection does not exist,
+              it will be created. If not given, the document will be added to the user's
+              default collection.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -500,8 +470,8 @@ async def add_url(
             "/documents/scrape",
             body=await async_maybe_transform(
                 {
-                    "collection": collection,
                     "url": url,
+                    "collection": collection,
                 },
                 document_add_url_params.DocumentAddURLParams,
             ),