@pipedream/openai 1.0.1 → 1.1.0

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

@@ -8,7 +8,7 @@ export default {
   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: "1.0.0",
+  version: "1.0.1",
   type: "action",
   props: {
     openai,
@@ -33,6 +33,12 @@ export default {
       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,
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
   },
   async run({ $ }) {
     const { id: assistantId } = await this.openai.createAssistant({

package/actions/chat/chat.mjs

@@ -5,7 +5,7 @@ import constants from "../../common/constants.mjs";
 export default {
   ...common,
   name: "Chat",
-  version: "0.3.1",
+  version: "0.3.2",
   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",

package/actions/chat-using-file-search/chat-using-file-search.mjs

@@ -5,7 +5,7 @@ import constants from "../../common/constants.mjs";
 export default {
   ...common,
   name: "Chat using File Search",
-  version: "0.0.5",
+  version: "0.0.6",
   key: "openai-chat-using-file-search",
   description: "Chat with your files knowledge base (vector stores). [See the documentation](https://platform.openai.com/docs/guides/tools-file-search)",
   type: "action",

package/actions/chat-using-functions/chat-using-functions.mjs

@@ -5,7 +5,7 @@ import constants from "../../common/constants.mjs";
 export default {
   ...common,
   name: "Chat using Functions",
-  version: "0.0.6",
+  version: "0.0.7",
   key: "openai-chat-using-functions",
   description: "Chat with your models and allow them to invoke functions. Optionally, you can build and invoke workflows as functions. [See the documentation](https://platform.openai.com/docs/guides/function-calling)",
   type: "action",

package/actions/chat-using-web-search/chat-using-web-search.mjs

@@ -5,7 +5,7 @@ import constants from "../../common/constants.mjs";
 export default {
   ...common,
   name: "Chat using Web Search",
-  version: "0.0.5",
+  version: "0.0.6",
   key: "openai-chat-using-web-search",
   description: "Chat using the web search tool. [See the documentation](https://platform.openai.com/docs/guides/tools-web-search)",
   type: "action",

package/actions/chat-with-responses-api/chat-with-responses-api.mjs

@@ -0,0 +1,171 @@
+import openai from "../../openai.app.mjs";
+import common from "../common/common.mjs";
+import constants from "../../common/constants.mjs";
+import {
+  parseArray,
+  parseJson,
+} from "../../common/helpers.mjs";
+
+export default {
+  ...common,
+  key: "openai-chat-with-responses-api",
+  name: "Chat With Responses API",
+  version: "0.0.1",
+  description: "Send a chat via the Responses API, mixing built-in tools and MCP server tools. [See the documentation](https://platform.openai.com/docs/guides/tools?api-mode=responses).",
+  type: "action",
+  props: {
+    openai,
+    modelId: {
+      description: "Model used to generate the response",
+      propDefinition: [
+        openai,
+        "chatCompletionModelId",
+      ],
+    },
+    input: {
+      description: "Text input to the model used to generate a response",
+      propDefinition: [
+        openai,
+        "input",
+      ],
+    },
+    instructions: {
+      description: "Inserts a system (or developer) message as the first item in the model's context",
+      propDefinition: [
+        openai,
+        "instructions",
+      ],
+    },
+    previousResponseId: {
+      type: "string",
+      label: "Previous Response ID",
+      description: "The unique ID of the previous response to the model. Use this to create multi-turn conversations",
+      optional: true,
+    },
+    truncation: {
+      type: "string",
+      label: "Truncation",
+      description:
+        "Specifies the truncation mode for the response if it exceeds the context window",
+      default: "auto",
+      options: [
+        "auto",
+        "disabled",
+      ],
+      optional: true,
+    },
+    responseFormat: {
+      type: "string",
+      label: "Response Format",
+      description: "- `text`: Returns unstructured text output.\n- `json_schema`: Enforces a specific structure using a JSON schema.",
+      options: [
+        "text",
+        "json_schema",
+      ],
+      default: "text",
+      optional: true,
+      reloadProps: true,
+    },
+    builtInTools: {
+      type: "string[]",
+      label: "Built-In Tools",
+      description: "Which of OpenAI's first-party tools to enable (web search, file search, code interpreter).",
+      options: [
+        {
+          label: "Web Search",
+          value: "web_search_preview",
+        },
+        {
+          label: "File Search",
+          value: "file_search",
+        },
+        {
+          label: "Code Interpreter",
+          value: "code_interpreter",
+        },
+      ],
+      default: [],
+    },
+    otherTools: {
+      type: "string[]",
+      label: "Other Tools",
+      description: "Other tools to include in the chat. [See the documentation](https://platform.openai.com/docs/guides/tools-remote-mcp). Example: `{ type: \"mcp\", server_label: \"gmail\", server_url: \"https://remote.mcp.pipedream.net\", headers: {}, require_approval: \"never\" }`",
+      optional: true,
+    },
+  },
+  additionalProps() {
+    if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      return {
+        schemaName: {
+          type: "string",
+          label: "Name",
+          description: "The name of the schema.",
+        },
+        schema: {
+          type: "string",
+          label: "JSON Schema",
+          description: "Define the schema that the model's output must adhere to.  Only supported models are `gpt-4o-mini`, `gpt-4o-mini-2024-07-18`, `gpt-4o-2024-08-06` and later.",
+        },
+      };
+    }
+    return {};
+  },
+  async run({ $ }) {
+    const {
+      builtInTools,
+      otherTools,
+      modelId,
+      input,
+      instructions,
+      previousResponseId,
+      truncation,
+      responseFormat,
+      schemaName,
+      schema,
+    } = this;
+
+    const tools = builtInTools.map((tool) => ({
+      type: tool,
+    }));
+
+    if (otherTools) {
+      tools.push(...parseArray(otherTools));
+    }
+
+    const data = {
+      model: modelId,
+      input,
+      instructions,
+      previous_response_id: previousResponseId,
+      truncation,
+      tools,
+    };
+
+    if (responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      try {
+        data.text = {
+          format: {
+            type: responseFormat,
+            name: schemaName,
+            schema: parseJson(schema),
+          },
+        };
+      } catch {
+        throw new Error("Invalid JSON format in the provided JSON Schema");
+      }
+    }
+
+    const response = await this.openai.responses({
+      $,
+      data,
+      debug: true,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully sent chat to OpenAI Responses API with ID \`${response.id}\`.`);
+      $.export("chat_responses", response.output);
+    }
+
+    return response;
+  },
+};

package/actions/classify-items-into-categories/classify-items-into-categories.mjs

@@ -3,7 +3,7 @@ import common from "../common/common-helper.mjs";
 export default {
   ...common,
   name: "Classify Items into Categories",
-  version: "0.1.7",
+  version: "0.1.8",
   key: "openai-classify-items-into-categories",
   description: "Classify items into specific categories using the Chat API. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",

package/actions/convert-text-to-speech/convert-text-to-speech.mjs

@@ -5,7 +5,7 @@ export default {
   key: "openai-convert-text-to-speech",
   name: "Convert Text to Speech (TTS)",
   description: "Generates audio from the input text. [See the documentation](https://platform.openai.com/docs/api-reference/audio/createSpeech)",
-  version: "0.0.14",
+  version: "0.0.15",
   type: "action",
   props: {
     openai,
@@ -42,7 +42,12 @@ export default {
     outputFile: {
       type: "string",
       label: "Output Filename",
-      description: "The filename of the output audio file that will be written to the `/tmp` folder, e.g. `/tmp/myFile.mp3`",
+      description: "The filename of the output audio file that will be written to the `/tmp` folder, e.g. `myFile.mp3`",
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "write",
+      sync: true,
     },
   },
   async run({ $ }) {
@@ -60,7 +65,7 @@ export default {
 
     const outputFilePath = this.outputFile.includes("tmp/")
       ? this.outputFile
-      : `/tmp/${this.outputFile}`;
+      : `${process.env.STASH_DIR || "/tmp"}/${this.outputFile}`;
 
     await fs.promises.writeFile(outputFilePath, Buffer.from(response));
 

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

@@ -9,7 +9,7 @@ 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.1.0",
+  version: "0.1.1",
   type: "action",
   props: {
     openai,
@@ -41,6 +41,12 @@ export default {
         "metadata",
       ],
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
   },
   async run({ $ }) {
     if (!this.fileId && !this.filePath) {

package/actions/create-embeddings/create-embeddings.mjs

@@ -4,7 +4,7 @@ import common from "../common/common.mjs";
 
 export default {
   name: "Create Embeddings",
-  version: "0.0.19",
+  version: "0.0.20",
   key: "openai-create-embeddings",
   description: "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. [See the documentation](https://platform.openai.com/docs/api-reference/embeddings)",
   type: "action",

package/actions/create-image/create-image.mjs

@@ -4,7 +4,7 @@ import fs from "fs";
 
 export default {
   name: "Create Image (Dall-E)",
-  version: "0.1.22",
+  version: "0.1.23",
   key: "openai-create-image",
   description: "Creates an image given a prompt returning a URL to the image. [See the documentation](https://platform.openai.com/docs/api-reference/images)",
   type: "action",
@@ -39,6 +39,11 @@ export default {
       options: constants.IMAGE_SIZES,
       default: "1024x1024",
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "write",
+      sync: true,
+    },
   },
   async additionalProps() {
     const props = {};
@@ -106,7 +111,7 @@ export default {
           : this.filename.replace(/(\.[^/.]+)$/, `_${i}$1`);
         const outputFilePath = filename.includes("tmp/")
           ? filename
-          : `/tmp/${filename}`;
+          : `${process.env.STASH_DIR || "/tmp"}/${filename}`;
         await fs.writeFileSync(outputFilePath, Buffer.from(response.data[0].b64_json.toString(), "base64"));
         fileData.push({
           tmp: [

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

@@ -6,7 +6,7 @@ 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.3.0",
+  version: "0.3.1",
   type: "action",
   props: {
     openai,
@@ -70,6 +70,12 @@ export default {
       description: "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.",
       optional: true,
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
   },
   methods: {
     createTranscription(opts = {}) {

package/actions/retrieve-file-content/retrieve-file-content.mjs

@@ -5,7 +5,7 @@ export default {
   key: "openai-retrieve-file-content",
   name: "Retrieve File Content",
   description: "Retrieves the contents of the specified file. [See the documentation](https://platform.openai.com/docs/api-reference/files/retrieve-content)",
-  version: "0.0.15",
+  version: "0.0.16",
   type: "action",
   props: {
     openai,
@@ -21,6 +21,11 @@ export default {
       description: "Optionally, download the file to the `/tmp` directory using the given filename",
       optional: true,
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "write",
+      sync: true,
+    },
   },
   async run({ $ }) {
     const response = await this.openai.retrieveFileContent({

package/actions/send-prompt/send-prompt.mjs

@@ -4,7 +4,7 @@ import common from "../common/common.mjs";
 export default {
   ...common,
   name: "Create Completion (Send Prompt)",
-  version: "0.1.18",
+  version: "0.1.19",
   key: "openai-send-prompt",
   description: "OpenAI recommends using the **Chat** action for the latest `gpt-3.5-turbo` API, since it's faster and 10x cheaper. This action creates a completion for the provided prompt and parameters using the older `/completions` API. [See the documentation](https://beta.openai.com/docs/api-reference/completions/create)",
   type: "action",

package/actions/summarize/summarize.mjs

@@ -4,7 +4,7 @@ import constants from "../../common/constants.mjs";
 export default {
   ...common,
   name: "Summarize Text",
-  version: "0.1.7",
+  version: "0.1.8",
   key: "openai-summarize",
   description: "Summarizes text using the Chat API. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",

package/actions/translate-text/translate-text.mjs

@@ -9,7 +9,7 @@ const langOptions = lang.LANGUAGES.map((l) => ({
 export default {
   ...common,
   name: "Translate Text (Whisper)",
-  version: "0.1.7",
+  version: "0.1.8",
   key: "openai-translate-text",
   description: "Translate text from one language to another using the Chat API. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",

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

@@ -6,7 +6,7 @@ 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.1.0",
+  version: "0.1.1",
   type: "action",
   props: {
     openai,
@@ -22,6 +22,12 @@ export default {
         "purpose",
       ],
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
   },
   async run({ $ }) {
     const {

package/common/helpers.mjs

@@ -37,3 +37,52 @@ export function parse(value) {
     throw new ConfigurationError("Make sure the schema contains a valid JSON object.");
   }
 }
+
+export const parseJson = (input, maxDepth = 100) => {
+  const seen = new WeakSet();
+  const parse = (value) => {
+    if (maxDepth <= 0) {
+      return value;
+    }
+    if (typeof(value) === "string") {
+      // Only parse if the string looks like a JSON object or array
+      const trimmed = value.trim();
+      if (
+        (trimmed.startsWith("{") && trimmed.endsWith("}")) ||
+        (trimmed.startsWith("[") && trimmed.endsWith("]"))
+      ) {
+        try {
+          return parseJson(JSON.parse(value), maxDepth - 1);
+        } catch (e) {
+          return value;
+        }
+      }
+      return value;
+    } else if (typeof(value) === "object" && value !== null && !Array.isArray(value)) {
+      if (seen.has(value)) {
+        return value;
+      }
+      seen.add(value);
+      return Object.entries(value)
+        .reduce((acc, [
+          key,
+          val,
+        ]) => Object.assign(acc, {
+          [key]: parse(val),
+        }), {});
+    } else if (Array.isArray(value)) {
+      return value.map((item) => parse(item));
+    }
+    return value;
+  };
+
+  return parse(input);
+};
+
+export function parseArray (input, maxDepth = 100) {
+  if (!Array.isArray(input)) {
+    return input;
+  }
+
+  return input.map((item) => parseJson(item, maxDepth));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/openai",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Pipedream OpenAI Components",
   "main": "openai.app.mjs",
   "keywords": [
@@ -16,7 +16,6 @@
   "dependencies": {
     "@pipedream/platform": "^3.1.0",
     "@pipedream/types": "^0.1.4",
-    "axios": "^1.6.2",
     "bottleneck": "^2.19.5",
     "form-data": "^4.0.0",
     "got": "^12.6.0",