@pipedream/openai 0.10.0 → 1.0.0

package/actions/analyze-image-content/analyze-image-content.mjs

@@ -1,14 +1,14 @@
 import openai from "../../openai.app.mjs";
 import common from "../common/common-assistants.mjs";
 import FormData from "form-data";
-import fs from "fs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 
 export default {
   ...common,
   key: "openai-analyze-image-content",
   name: "Analyze Image Content",
   description: "Send a message or question about an image and receive a response. [See the documentation](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)",
-  version: "0.1.6",
+  version: "1.0.0",
   type: "action",
   props: {
     openai,
@@ -17,12 +17,6 @@ export default {
       label: "Message",
       description: "The message or question to send",
     },
-    imageUrl: {
-      type: "string",
-      label: "Image URL",
-      description: "The URL of the image to analyze. Must be a supported image types: jpeg, jpg, png, gif, webp",
-      optional: true,
-    },
     imageFileId: {
       propDefinition: [
         openai,
@@ -35,8 +29,8 @@ export default {
     },
     filePath: {
       type: "string",
-      label: "File Path",
-      description: "The path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      label: "File Path or URL",
+      description: "The image to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`). Supported image types: jpeg, jpg, png, gif, webp",
       optional: true,
     },
   },
@@ -83,11 +77,15 @@ export default {
     }
     if (this.filePath) {
       const fileData = new FormData();
-      const content = fs.createReadStream(this.filePath.includes("tmp/")
-        ? this.filePath
-        : `/tmp/${this.filePath}`);
+      const {
+        stream, metadata,
+      } = await getFileStreamAndMetadata(this.filePath);
       fileData.append("purpose", "vision");
-      fileData.append("file", content);
+      fileData.append("file", stream, {
+        contentType: metadata.contentType,
+        knownLength: metadata.size,
+        filename: metadata.name,
+      });
 
       const { id } = await this.openai.uploadFile({
         $,

package/actions/chat/chat.mjs

@@ -1,12 +1,11 @@
 import openai from "../../openai.app.mjs";
 import common from "../common/common.mjs";
 import constants from "../../common/constants.mjs";
-import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   ...common,
   name: "Chat",
-  version: "0.2.8",
+  version: "0.3.0",
   key: "openai-chat",
   description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",
@@ -44,13 +43,13 @@ export default {
     images: {
       label: "Images",
       type: "string[]",
-      description: "Provide one or more images to [OpenAI's vision model](https://platform.openai.com/docs/guides/vision). Accepts URLs or base64 encoded strings. Compatible with the `gpt4-vision-preview` model",
+      description: "Provide one or more images to [OpenAI's vision model](https://platform.openai.com/docs/guides/vision). Each entry should be either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`), or raw base64-encoded image data. Compatible with the `gpt4-vision-preview` model",
       optional: true,
     },
     audio: {
       type: "string",
       label: "Audio",
-      description: "Provide the file path to an audio file in the `/tmp` directory. For use with the `gpt-4o-audio-preview` model. Currently supports `wav` and `mp3` files.",
+      description: "The audio file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.mp3`). For use with the `gpt-4o-audio-preview` model. Currently supports `wav` and `mp3` files.",
       optional: true,
     },
     responseFormat: {
@@ -145,11 +144,7 @@ export default {
     },
   },
   async run({ $ }) {
-    if (this.audio && !this.modelId.includes("gpt-4o-audio-preview")) {
-      throw new ConfigurationError("Use of audio files requires using the `gpt-4o-audio-preview` model.");
-    }
-
-    const args = this._getChatArgs();
+    const args = await this._getChatArgs();
 
     const response = await this.openai.createChatCompletion({
       $,
@@ -159,6 +154,16 @@ export default {
       },
     });
 
+    if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      for (const choice of response.choices) {
+        try {
+          choice.message.content = JSON.parse(choice.message.content);
+        } catch {
+          console.log(`Unable to parse JSON: ${choice.message.content}`);
+        }
+      }
+    }
+
     if (response) {
       $.export("$summary", `Successfully sent chat with id ${response.id}`);
     }

package/actions/common/common.mjs

@@ -1,7 +1,8 @@
-import { ConfigurationError } from "@pipedream/platform";
+import {
+  ConfigurationError, getFileStreamAndMetadata,
+} from "@pipedream/platform";
 import constants from "../../common/constants.mjs";
 import { parse } from "../../common/helpers.mjs";
-import fs from "fs";
 
 const CHAT_DOCS_MESSAGE_FORMAT_URL = "https://platform.openai.com/docs/guides/chat/introduction";
 
@@ -80,24 +81,44 @@ export default {
         user: this.user,
       };
     },
-    _getUserMessageContent() {
+    async _getUserMessageContent() {
       let content = [];
       if (this.images) {
         for (const image of this.images) {
+          let base64Image = image;
+          let imageType = "image/jpeg";
+          if (image.startsWith("http") || image.includes("tmp/")) {
+            const {
+              stream, metadata,
+            } = await getFileStreamAndMetadata(image);
+            const chunks = [];
+            for await (const chunk of stream) {
+              chunks.push(chunk);
+            }
+            base64Image = Buffer.concat(chunks).toString("base64");
+            if (metadata.contentType) imageType = metadata.contentType;
+          }
           content.push({
             "type": "image_url",
             "image_url": {
-              "url": image,
+              "url": base64Image.startsWith("data:")
+                ? base64Image
+                : `data:${imageType};base64,${base64Image}`,
             },
           });
         }
       }
 
       if (this.audio) {
-        const fileContent = fs.readFileSync(this.audio.includes("tmp/")
-          ? this.audio
-          : `/tmp/${this.audio}`).toString("base64");
-        const extension = this.audio.match(/\.(\w+)$/)?.[1];
+        const {
+          stream, metadata,
+        } = await getFileStreamAndMetadata(this.audio);
+        const chunks = [];
+        for await (const chunk of stream) {
+          chunks.push(chunk);
+        }
+        const fileContent = Buffer.concat(chunks).toString("base64");
+        const extension = metadata.name.split(".").pop();
         content.push({
           type: "input_audio",
           input_audio: {
@@ -114,7 +135,7 @@ export default {
 
       return content;
     },
-    _getChatArgs() {
+    async _getChatArgs() {
       if (this.messages && this.messages.length && !this.userMessage) {
         throw new ConfigurationError(
           `When you provide previous messages, you must provide the next User Message for the assistant to answer. See the OpenAI Chat format docs here: ${CHAT_DOCS_MESSAGE_FORMAT_URL}`,
@@ -160,7 +181,7 @@ export default {
 
       messages.push({
         "role": "user",
-        "content": this._getUserMessageContent(),
+        "content": await this._getUserMessageContent(),
       });
 
       const responseFormat = {};

package/actions/create-batch/create-batch.mjs

@@ -1,14 +1,15 @@
 import openai from "../../openai.app.mjs";
 import constants from "../../common/constants.mjs";
-import { ConfigurationError } from "@pipedream/platform";
+import {
+  ConfigurationError, getFileStreamAndMetadata,
+} from "@pipedream/platform";
 import FormData from "form-data";
-import fs from "fs";
 
 export default {
   key: "openai-create-batch",
   name: "Create Batch",
   description: "Creates and executes a batch from an uploaded file of requests. [See the documentation](https://platform.openai.com/docs/api-reference/batch/create)",
-  version: "0.0.9",
+  version: "0.1.0",
   type: "action",
   props: {
     openai,
@@ -30,8 +31,8 @@ export default {
     },
     filePath: {
       type: "string",
-      label: "File Path",
-      description: "The path to a .jsonl file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      label: "File Path or URL",
+      description: "The .jsonl file to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)",
       optional: true,
     },
     metadata: {
@@ -49,11 +50,15 @@ export default {
     let fileId = this.fileId;
     if (this.filePath) {
       const fileData = new FormData();
-      const content = fs.createReadStream(this.filePath.includes("tmp/")
-        ? this.filePath
-        : `/tmp/${this.filePath}`);
+      const {
+        stream, metadata,
+      } = await getFileStreamAndMetadata(this.filePath);
       fileData.append("purpose", "batch");
-      fileData.append("file", content);
+      fileData.append("file", stream, {
+        contentType: metadata.contentType,
+        knownLength: metadata.size,
+        filename: metadata.name,
+      });
 
       const { id } = await this.openai.uploadFile({
         $,

package/actions/create-transcription/create-transcription.mjs

@@ -1,12 +1,12 @@
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import openai from "../../openai.app.mjs";
 import FormData from "form-data";
-import fs from "fs";
 
 export default {
   key: "openai-create-transcription",
   name: "Create Transcription",
   description: "Transcribes audio into the input language. [See the documentation](https://platform.openai.com/docs/api-reference/audio/createTranscription)",
-  version: "0.2.0",
+  version: "0.3.0",
   type: "action",
   props: {
     openai,
@@ -90,11 +90,15 @@ export default {
     } = this;
 
     const data = new FormData();
-    const content = fs.createReadStream(file.includes("tmp/")
-      ? file
-      : `/tmp/${file}`);
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(file);
 
-    data.append("file", content);
+    data.append("file", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
 
     for (const [
       key,

package/actions/upload-file/upload-file.mjs

@@ -1,12 +1,12 @@
 import FormData from "form-data";
-import fs from "fs";
 import openai from "../../openai.app.mjs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 
 export default {
   key: "openai-upload-file",
   name: "Upload File",
   description: "Upload a file that can be used across various endpoints/features. The size of individual files can be a maximum of 512mb. [See the documentation](https://platform.openai.com/docs/api-reference/files/create)",
-  version: "0.0.18",
+  version: "0.1.0",
   type: "action",
   props: {
     openai,
@@ -28,11 +28,15 @@ export default {
       file, purpose,
     } = this;
     const data = new FormData();
-    const content = fs.createReadStream(file.includes("tmp/")
-      ? file
-      : `/tmp/${file}`);
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(file);
     data.append("purpose", purpose);
-    data.append("file", content);
+    data.append("file", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
 
     const response = await this.openai.uploadFile({
       $,

package/openai.app.mjs

@@ -255,8 +255,8 @@ export default {
     },
     file: {
       type: "string",
-      label: "File",
-      description: "The path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp). See the [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files.",
+      label: "File Path or URL",
+      description: "The file to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`). See the [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files.",
     },
     purpose: {
       type: "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/openai",
-  "version": "0.10.0",
+  "version": "1.0.0",
   "description": "Pipedream OpenAI Components",
   "main": "openai.app.mjs",
   "keywords": [
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.3",
+    "@pipedream/platform": "^3.1.0",
     "@pipedream/types": "^0.1.4",
     "axios": "^1.6.2",
     "bottleneck": "^2.19.5",