feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 35
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/replicate%2Freplicate-client-efbc8cc2d74644b213e161d3e11e0589d1cef181fb318ea02c8eb6b00f245713.yml
-openapi_spec_hash: 13da0c06c900b61cd98ab678e024987a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/replicate%2Freplicate-client-88cf5fe1f5accb56ae9fbb31c0df00d1552762d4c558d16d8547894ae95e8ccb.yml
+openapi_spec_hash: 43283d20f335a04241cce165452ff50e
 config_hash: 84794ed69d841684ff08a8aa889ef103

api.md

@@ -116,7 +116,7 @@ Methods:
 
 - <code title="post /predictions">client.predictions.<a href="./src/replicate/resources/predictions.py">create</a>(\*\*<a href="src/replicate/types/prediction_create_params.py">params</a>) -> <a href="./src/replicate/types/prediction.py">Prediction</a></code>
 - <code title="get /predictions">client.predictions.<a href="./src/replicate/resources/predictions.py">list</a>(\*\*<a href="src/replicate/types/prediction_list_params.py">params</a>) -> <a href="./src/replicate/types/prediction.py">SyncCursorURLPageWithCreatedFilters[Prediction]</a></code>
-- <code title="post /predictions/{prediction_id}/cancel">client.predictions.<a href="./src/replicate/resources/predictions.py">cancel</a>(\*, prediction_id) -> None</code>
+- <code title="post /predictions/{prediction_id}/cancel">client.predictions.<a href="./src/replicate/resources/predictions.py">cancel</a>(\*, prediction_id) -> <a href="./src/replicate/types/prediction.py">Prediction</a></code>
 - <code title="get /predictions/{prediction_id}">client.predictions.<a href="./src/replicate/resources/predictions.py">get</a>(\*, prediction_id) -> <a href="./src/replicate/types/prediction.py">Prediction</a></code>
 
 # Trainings

src/replicate/resources/predictions.py

@@ -9,7 +9,7 @@
 import httpx
 
 from ..types import prediction_list_params, prediction_create_params
-from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from .._utils import maybe_transform, strip_not_given, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -317,9 +317,32 @@ def cancel(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> Prediction:
         """
-        Cancel a prediction
+        Cancel a prediction that is currently running.
+
+        Example cURL request that creates a prediction and then cancels it:
+
+        ```console
+        # First, create a prediction
+        PREDICTION_ID=$(curl -s -X POST \\
+          -H "Authorization: Bearer $REPLICATE_API_TOKEN" \\
+          -H "Content-Type: application/json" \\
+          -d '{
+            "input": {
+              "prompt": "a video that may take a while to generate"
+            }
+          }' \\
+          https://api.replicate.com/v1/models/minimax/video-01/predictions | jq -r '.id')
+
+        # Echo the prediction ID
+        echo "Created prediction with ID: $PREDICTION_ID"
+
+        # Cancel the prediction
+        curl -s -X POST \\
+          -H "Authorization: Bearer $REPLICATE_API_TOKEN" \\
+          https://api.replicate.com/v1/predictions/$PREDICTION_ID/cancel
+        ```
 
         Args:
           extra_headers: Send extra headers
@@ -332,13 +355,12 @@ def cancel(
         """
         if not prediction_id:
             raise ValueError(f"Expected a non-empty value for `prediction_id` but received {prediction_id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/predictions/{prediction_id}/cancel",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Prediction,
         )
 
     def get(
@@ -735,9 +757,32 @@ async def cancel(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> Prediction:
         """
-        Cancel a prediction
+        Cancel a prediction that is currently running.
+
+        Example cURL request that creates a prediction and then cancels it:
+
+        ```console
+        # First, create a prediction
+        PREDICTION_ID=$(curl -s -X POST \\
+          -H "Authorization: Bearer $REPLICATE_API_TOKEN" \\
+          -H "Content-Type: application/json" \\
+          -d '{
+            "input": {
+              "prompt": "a video that may take a while to generate"
+            }
+          }' \\
+          https://api.replicate.com/v1/models/minimax/video-01/predictions | jq -r '.id')
+
+        # Echo the prediction ID
+        echo "Created prediction with ID: $PREDICTION_ID"
+
+        # Cancel the prediction
+        curl -s -X POST \\
+          -H "Authorization: Bearer $REPLICATE_API_TOKEN" \\
+          https://api.replicate.com/v1/predictions/$PREDICTION_ID/cancel
+        ```
 
         Args:
           extra_headers: Send extra headers
@@ -750,13 +795,12 @@ async def cancel(
         """
         if not prediction_id:
             raise ValueError(f"Expected a non-empty value for `prediction_id` but received {prediction_id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/predictions/{prediction_id}/cancel",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Prediction,
         )
 
     async def get(

tests/api_resources/test_predictions.py

@@ -112,7 +112,7 @@ def test_method_cancel(self, client: Replicate) -> None:
         prediction = client.predictions.cancel(
             prediction_id="prediction_id",
         )
-        assert prediction is None
+        assert_matches_type(Prediction, prediction, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -124,7 +124,7 @@ def test_raw_response_cancel(self, client: Replicate) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         prediction = response.parse()
-        assert prediction is None
+        assert_matches_type(Prediction, prediction, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -136,7 +136,7 @@ def test_streaming_response_cancel(self, client: Replicate) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             prediction = response.parse()
-            assert prediction is None
+            assert_matches_type(Prediction, prediction, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -287,7 +287,7 @@ async def test_method_cancel(self, async_client: AsyncReplicate) -> None:
         prediction = await async_client.predictions.cancel(
             prediction_id="prediction_id",
         )
-        assert prediction is None
+        assert_matches_type(Prediction, prediction, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -299,7 +299,7 @@ async def test_raw_response_cancel(self, async_client: AsyncReplicate) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         prediction = await response.parse()
-        assert prediction is None
+        assert_matches_type(Prediction, prediction, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -311,7 +311,7 @@ async def test_streaming_response_cancel(self, async_client: AsyncReplicate) ->
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             prediction = await response.parse()
-            assert prediction is None
+            assert_matches_type(Prediction, prediction, path=["response"])
 
         assert cast(Any, response.is_closed) is True