Merge pull request #5590 from thatsKevinJain/kevin/form-data

Allow FormData to be passed as input to AI bindings

Author: danlapid

src/cloudflare/internal/ai-api.ts

@@ -42,7 +42,7 @@ export type AiOptions = {
 };
 
 export type AiInputReadableStream = {
-  body: ReadableStream;
+  body: ReadableStream | FormData;
   contentType: string;
 };
 
@@ -87,14 +87,12 @@ export class AiInternalError extends Error {
   }
 }
 
-// TODO: merge this function with the one with images-api.ts
 function isReadableStream(obj: unknown): obj is ReadableStream {
-  return !!(
-    obj &&
-    typeof obj === 'object' &&
-    'getReader' in obj &&
-    typeof obj.getReader === 'function'
-  );
+  return obj instanceof ReadableStream;
+}
+
+function isFormData(obj: unknown): obj is FormData {
+  return obj instanceof FormData;
 }
 
 /**
@@ -111,9 +109,9 @@ function findReadableStreamKeys(
       value &&
       typeof value === 'object' &&
       'body' in value &&
-      isReadableStream(value.body);
+      (isReadableStream(value.body) || isFormData(value.body));
 
-    if (hasReadableStreamBody || isReadableStream(value)) {
+    if (hasReadableStreamBody || isReadableStream(value) || isFormData(value)) {
       readableStreamKeys.push(key);
     }
   }

src/cloudflare/internal/test/ai/ai-api-test.js

@@ -214,6 +214,25 @@ export const tests = {
       );
     }
 
+    {
+      // Test form data input
+      const form = new FormData();
+      form.append('prompt', 'cat');
+      const resp = await env.ai.run('formDataInputs', {
+        audio: {
+          body: form,
+          contentType: 'multipart/form-data',
+        },
+      });
+
+      assert.deepStrictEqual(resp, {
+        inputs: {},
+        options: { userInputs: '{}', version: '3' },
+        requestUrl:
+          'https://workers-binding.ai/run?version=3&userInputs=%7B%7D',
+      });
+    }
+
     {
       // Test gateway option
       const resp = await env.ai.run(

src/cloudflare/internal/test/ai/ai-mock.js

@@ -97,6 +97,19 @@ export default {
       );
     }
 
+    if (modelName === 'formDataInputs') {
+      return Response.json(
+        {
+          inputs: {},
+          options: { ...data.options },
+          requestUrl: request.url,
+        },
+        {
+          headers: respHeaders,
+        }
+      );
+    }
+
     if (modelName === 'inputErrorModel') {
       return Response.json(
         {

types/defines/ai.d.ts

@@ -5415,7 +5415,7 @@ export type AiOptions = {
    * Maximum 5 tags are allowed each request.
    * Duplicate tags will removed.
    */
-  tags: string[];
+  tags?: string[];
   gateway?: GatewayOptions;
   returnRawResponse?: boolean;
   prefix?: string;

types/generated-snapshot/experimental/index.d.ts

@@ -9932,7 +9932,7 @@ type AiOptions = {
    * Maximum 5 tags are allowed each request.
    * Duplicate tags will removed.
    */
-  tags: string[];
+  tags?: string[];
   gateway?: GatewayOptions;
   returnRawResponse?: boolean;
   prefix?: string;

types/generated-snapshot/experimental/index.ts

@@ -9946,7 +9946,7 @@ export type AiOptions = {
    * Maximum 5 tags are allowed each request.
    * Duplicate tags will removed.
    */
-  tags: string[];
+  tags?: string[];
   gateway?: GatewayOptions;
   returnRawResponse?: boolean;
   prefix?: string;

types/generated-snapshot/latest/index.d.ts

@@ -9328,7 +9328,7 @@ type AiOptions = {
    * Maximum 5 tags are allowed each request.
    * Duplicate tags will removed.
    */
-  tags: string[];
+  tags?: string[];
   gateway?: GatewayOptions;
   returnRawResponse?: boolean;
   prefix?: string;

types/generated-snapshot/latest/index.ts

@@ -9340,7 +9340,7 @@ export type AiOptions = {
    * Maximum 5 tags are allowed each request.
    * Duplicate tags will removed.
    */
-  tags: string[];
+  tags?: string[];
   gateway?: GatewayOptions;
   returnRawResponse?: boolean;
   prefix?: string;