Add block parameter to prediction creation methods

Author: mattt

index.d.ts

@@ -210,9 +210,11 @@ declare module "replicate" {
           deployment_name: string,
           options: {
             input: object;
+            /** @deprecated */
             stream?: boolean;
             webhook?: string;
             webhook_events_filter?: WebhookEventType[];
+            block?: boolean;
           }
         ): Promise<Prediction>;
       };
@@ -301,6 +303,7 @@ declare module "replicate" {
           stream?: boolean;
           webhook?: string;
           webhook_events_filter?: WebhookEventType[];
+          block?: boolean;
         } & ({ version: string } | { model: string })
       ): Promise<Prediction>;
       get(prediction_id: string): Promise<Prediction>;

lib/deployments.js

@@ -7,13 +7,13 @@ const { transformFileInputs } = require("./util");
  * @param {string} deployment_name - Required. The name of the deployment
  * @param {object} options
  * @param {object} options.input - Required. An object with the model inputs
- * @param {boolean} [options.stream] - Whether to stream the prediction output. Defaults to false
  * @param {string} [options.webhook] - An HTTPS URL for receiving a webhook when the prediction has new output
  * @param {string[]} [options.webhook_events_filter] - You can change which events trigger webhook requests by specifying webhook events (`start`|`output`|`logs`|`completed`)
+ * @param {boolean} [options.block] - Whether to wait until the prediction is completed before returning. Defaults to false
  * @returns {Promise<object>} Resolves with the created prediction data
  */
 async function createPrediction(deployment_owner, deployment_name, options) {
-  const { stream, input, ...data } = options;
+  const { input, block, ...data } = options;
 
   if (data.webhook) {
     try {
@@ -24,10 +24,16 @@ async function createPrediction(deployment_owner, deployment_name, options) {
     }
   }
 
+  const headers = {};
+  if (block) {
+    headers["X-Sync"] = "true";
+  }
+
   const response = await this.request(
     `/deployments/${deployment_owner}/${deployment_name}/predictions`,
     {
       method: "POST",
+      headers,
       data: {
         ...data,
         input: await transformFileInputs(

lib/predictions.js

@@ -9,11 +9,11 @@ const { transformFileInputs } = require("./util");
  * @param {object} options.input - Required. An object with the model inputs
  * @param {string} [options.webhook] - An HTTPS URL for receiving a webhook when the prediction has new output
  * @param {string[]} [options.webhook_events_filter] - You can change which events trigger webhook requests by specifying webhook events (`start`|`output`|`logs`|`completed`)
- * @param {boolean} [options.stream] - Whether to stream the prediction output. Defaults to false. Streaming is now enabled by default for all predictions. For more information, see https://replicate.com/changelog/2024-07-15-streams-always-available-stream-parameter-deprecated
+ * @param {boolean} [options.block] - Whether to wait until the prediction is completed before returning. Defaults to false
  * @returns {Promise<object>} Resolves with the created prediction
  */
 async function createPrediction(options) {
-  const { model, version, input, ...data } = options;
+  const { model, version, input, block, ...data } = options;
 
   if (data.webhook) {
     try {
@@ -24,10 +24,16 @@ async function createPrediction(options) {
     }
   }
 
+  const headers = {};
+  if (block) {
+    headers["X-Sync"] = "true";
+  }
+
   let response;
   if (version) {
     response = await this.request("/predictions", {
       method: "POST",
+      headers,
       data: {
         ...data,
         input: await transformFileInputs(
@@ -41,6 +47,7 @@ async function createPrediction(options) {
   } else if (model) {
     response = await this.request(`/models/${model}/predictions`, {
       method: "POST",
+      headers,
       data: {
         ...data,
         input: await transformFileInputs(