@pipedream/openai 0.5.1 → 0.5.2

package/actions/create-assistant/create-assistant.mjs

@@ -1,11 +1,12 @@
-import { parseToolsArray } from "../../common/helpers.mjs";
 import openai from "../../openai.app.mjs";
+import common from "../common/common-assistants.mjs";
 
 export default {
+  ...common,
   key: "openai-create-assistant",
   name: "Create Assistant",
-  description: "Creates an assistant with a model and instructions. [See the docs here](https://platform.openai.com/docs/api-reference/assistants/createAssistant)",
-  version: "0.1.3",
+  description: "Creates an assistant with a model and instructions. [See the documentation](https://platform.openai.com/docs/api-reference/assistants/createAssistant)",
+  version: "0.1.4",
   type: "action",
   props: {
     openai,
@@ -33,35 +34,26 @@ export default {
         "instructions",
       ],
     },
-    tools: {
-      propDefinition: [
-        openai,
-        "tools",
-      ],
-    },
-    file_ids: {
-      propDefinition: [
-        openai,
-        "file_ids",
-      ],
-    },
     metadata: {
       propDefinition: [
         openai,
         "metadata",
       ],
     },
+    ...common.props,
   },
   async run({ $ }) {
     const response = await this.openai.createAssistant({
       $,
-      model: this.model,
-      name: this.name,
-      description: this.description,
-      instructions: this.instructions,
-      tools: parseToolsArray(this.tools),
-      file_ids: this.file_ids,
-      metadata: this.metadata,
+      data: {
+        model: this.model,
+        name: this.name,
+        description: this.description,
+        instructions: this.instructions,
+        tools: this.buildTools(),
+        tool_resources: this.buildToolResources(),
+        metadata: this.metadata,
+      },
     });
 
     $.export("$summary", `Successfully created an assistant with ID: ${response.id}`);

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

@@ -0,0 +1,78 @@
+import openai from "../../openai.app.mjs";
+import constants from "../../common/constants.mjs";
+import { ConfigurationError } 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.1",
+  type: "action",
+  props: {
+    openai,
+    endpoint: {
+      type: "string",
+      label: "Endpoint",
+      description: "The endpoint to be used for all requests in the batch",
+      options: constants.BATCH_ENDPOINTS,
+    },
+    fileId: {
+      propDefinition: [
+        openai,
+        "fileId",
+        () => ({
+          purpose: "batch",
+        }),
+      ],
+      optional: true,
+    },
+    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)",
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    if (!this.fileId && !this.filePath) {
+      throw new ConfigurationError("Must provide one of File ID or File Path");
+    }
+
+    let fileId = this.fileId;
+    if (this.filePath) {
+      const fileData = new FormData();
+      const content = fs.createReadStream(this.filePath.includes("tmp/")
+        ? this.filePath
+        : `/tmp/${this.filePath}`);
+      fileData.append("purpose", "batch");
+      fileData.append("file", content);
+
+      const { id } = await this.openai.uploadFile({
+        $,
+        data: fileData,
+        headers: fileData.getHeaders(),
+      });
+      fileId = id;
+    }
+
+    const response = await this.openai.createBatch({
+      $,
+      data: {
+        input_file_id: fileId,
+        endpoint: this.endpoint,
+        completion_window: "24h",
+        metadata: this.metadata,
+      },
+    });
+    $.export("$summary", `Successfully created batch with ID ${response.id}`);
+    return response;
+  },
+};

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

@@ -4,9 +4,9 @@ import common from "../common/common.mjs";
 
 export default {
   name: "Create Embeddings",
-  version: "0.0.8",
+  version: "0.0.9",
   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 docs here](https://platform.openai.com/docs/api-reference/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",
   props: {
     openai,
@@ -36,7 +36,7 @@ export default {
 
     const response = await this.openai.createEmbeddings({
       $,
-      args: {
+      data: {
         model: this.modelId,
         input: this.input,
       },

package/actions/create-fine-tuning-job/create-fine-tuning-job.mjs

@@ -4,7 +4,7 @@ export default {
   key: "openai-create-fine-tuning-job",
   name: "Create Fine Tuning Job",
   description: "Creates a job that fine-tunes a specified model from a given dataset. [See the documentation](https://platform.openai.com/docs/api-reference/fine-tuning/create)",
-  version: "0.0.5",
+  version: "0.0.6",
   type: "action",
   props: {
     openai,
@@ -17,8 +17,13 @@ export default {
     trainingFile: {
       propDefinition: [
         openai,
-        "trainingFile",
+        "fileId",
+        () => ({
+          purpose: "fine-tune",
+        }),
       ],
+      label: "Training File",
+      description: "The ID of an uploaded file that contains training data. You can use the **Upload File** action and reference the returned ID here.",
     },
     hyperParameters: {
       type: "object",
@@ -33,7 +38,13 @@ export default {
       optional: true,
     },
     validationFile: {
-      type: "string",
+      propDefinition: [
+        openai,
+        "fileId",
+        () => ({
+          purpose: "fine-tune",
+        }),
+      ],
       label: "Validation File",
       description: "The ID of an uploaded file that contains validation data. [See details in the documentation](https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-validation_file).",
       optional: true,

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

@@ -1,10 +1,11 @@
 import openai from "../../openai.app.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   name: "Create Image (Dall-E)",
-  version: "0.1.13",
+  version: "0.1.14",
   key: "openai-create-image",
-  description: "Creates an image given a prompt returning a URL to the image. [See docs here](https://platform.openai.com/docs/api-reference/images)",
+  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",
   props: {
     openai,
@@ -12,79 +13,20 @@ export default {
       label: "Model",
       description: "Choose the DALL·E models to generate image(s) with.",
       type: "string",
-      options: [
-        {
-          label: "dall-e-2",
-          value: "dall-e-2",
-        },
-        {
-          label: "dall-e-3",
-          value: "dall-e-3",
-        },
-      ],
-      default: "dall-e-3",
+      options: constants.IMAGE_MODELS,
+      reloadProps: true,
     },
     prompt: {
       label: "Prompt",
-      description: "A text description of the desired image(s). The maximum length is 1000 characters.",
+      description: "A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.",
       type: "string",
     },
-    n: {
-      label: "N",
-      description: "The number of images to generate. Must be between 1 and 10.",
-      type: "integer",
-      optional: true,
-      default: 1,
-    },
-    quality: {
-      label: "Quality",
-      description: "The quality of the image",
-      type: "string",
-      optional: true,
-      options: [
-        {
-          label: "Standard",
-          value: "standard",
-        },
-        {
-          label: "HD",
-          value: "hd",
-        },
-      ],
-      default: "standard",
-    },
-    style: {
-      label: "Style",
-      description: "The style of the image",
-      type: "string",
-      optional: true,
-      options: [
-        {
-          label: "Natural",
-          value: "natural",
-        },
-        {
-          label: "Vivid",
-          value: "vivid",
-        },
-      ],
-      default: "natural",
-    },
     responseFormat: {
       label: "Response Format",
       description: "The format in which the generated images are returned.",
       type: "string",
       optional: true,
-      options: [
-        {
-          label: "URL",
-          value: "url",
-        },
-        {
-          label: "Base64 JSON",
-          value: "b64_json",
-        },
-      ],
+      options: constants.IMAGE_RESPONSE_FORMATS,
       default: "url",
     },
     size: {
@@ -92,35 +34,47 @@ export default {
       description: "The size of the generated images.",
       type: "string",
       optional: true,
-      options: [
-        {
-          label: "256x256",
-          value: "256x256",
-        },
-        {
-          label: "512x512",
-          value: "512x512",
-        },
-        {
-          label: "1024x1024",
-          value: "1024x1024",
-        },
-        {
-          label: "1792x1024",
-          value: "1792x1024",
-        },
-        {
-          label: "1024x1792",
-          value: "1024x1792",
-        },
-      ],
+      options: constants.IMAGE_SIZES,
       default: "1024x1024",
     },
   },
+  async additionalProps() {
+    const props = {};
+    if (!this.model) {
+      return props;
+    }
+    if (this.model !== "dall-e-3") {
+      props.n = {
+        type: "integer",
+        label: "N",
+        description: "The number of images to generate. Must be between 1 and 10.",
+        optional: true,
+        default: 1,
+      };
+    } else {
+      props.quality = {
+        type: "string",
+        label: "Quality",
+        description: "The quality of the image",
+        options: constants.IMAGE_QUALITIES,
+        optional: true,
+        default: "standard",
+      };
+      props.style = {
+        type: "string",
+        label: "Style",
+        description: "The style of the image",
+        options: constants.IMAGE_STYLES,
+        optional: true,
+        default: "natural",
+      };
+    }
+    return props;
+  },
   async run({ $ }) {
     const response = await this.openai.createImage({
       $,
-      args: {
+      data: {
         prompt: this.prompt,
         n: this.n,
         size: this.size,

package/actions/create-moderation/create-moderation.mjs

@@ -0,0 +1,35 @@
+import openai from "../../openai.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "openai-create-moderation",
+  name: "Create Moderation",
+  description: "Classifies if text is potentially harmful. [See the documentation](https://platform.openai.com/docs/api-reference/moderations/create)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    openai,
+    input: {
+      type: "string",
+      label: "Input",
+      description: "The input text to classify",
+    },
+    model: {
+      type: "string",
+      label: "Model",
+      description: "The model to use",
+      options: constants.MODERATION_MODELS,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.createModeration({
+      $,
+      data: {
+        input: this.input,
+        model: this.model,
+      },
+    });
+    $.export("$summary", `Successfully created moderation with ID ${response.id}`);
+    return response;
+  },
+};

package/actions/create-thread/create-thread.mjs

@@ -1,10 +1,12 @@
 import openai from "../../openai.app.mjs";
+import common from "../common/common-assistants.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   key: "openai-create-thread",
   name: "Create Thread (Assistants)",
-  description: "Creates a thread with optional messages and metadata. [See the documentation](https://platform.openai.com/docs/api-reference/threads/createThread)",
-  version: "0.0.5",
+  description: "Creates a thread with optional messages and metadata, and optionally runs the thread using the specified assistant. [See the documentation](https://platform.openai.com/docs/api-reference/threads/createThread)",
+  version: "0.0.6",
   type: "action",
   props: {
     openai,
@@ -22,15 +24,115 @@ export default {
       ],
       optional: true,
     },
+    runThread: {
+      type: "boolean",
+      label: "Run Thread",
+      description: "Set to `true` to run the thread after creation",
+      optional: true,
+      reloadProps: true,
+    },
+    toolTypes: {
+      type: "string[]",
+      label: "Tool Types",
+      description: "The types of tools to enable on the assistant",
+      options: constants.TOOL_TYPES.filter((type) => type !== "function"),
+      optional: true,
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (this.runThread) {
+      props.assistantId = {
+        type: "string",
+        label: "Assistant ID",
+        description: "The unique identifier for the assistant.",
+        options: async () => { return this.getAssistantPropOptions(); },
+      };
+      props.model = {
+        type: "string",
+        label: "Model",
+        description: "The ID of the model to use for the assistant",
+        options: async () => { return this.getAssistantModelPropOptions(); },
+      };
+      props.instructions = {
+        type: "string",
+        label: "Instructions",
+        description: "The system instructions that the assistant uses.",
+        optional: true,
+      };
+      props.waitForCompletion = {
+        type: "boolean",
+        label: "Wait For Completion",
+        description: "Set to `true` to poll the API in 3-second intervals until the run is completed",
+        optional: true,
+      };
+    }
+    const toolProps = this.toolTypes?.length
+      ? await this.getToolProps()
+      : {};
+    return {
+      ...props,
+      ...toolProps,
+    };
+  },
+  methods: {
+    ...common.methods,
+    async getAssistantPropOptions() {
+      const { data } = await this.openai.listAssistants();
+      return data.map(({
+        name, id,
+      }) => ({
+        label: name || id,
+        value: id,
+      }));
+    },
+    async getAssistantModelPropOptions() {
+      const models = (await this.openai.models({})).filter(({ id }) => (id.includes("gpt-3.5-turbo") || id.includes("gpt-4-turbo")) && (id !== "gpt-3.5-turbo-0301"));
+      return models.map(({ id }) => id);
+    },
   },
   async run({ $ }) {
-    const response = await this.openai.createThread({
-      $,
-      messages: this.messages,
-      metadata: this.metadata,
-    });
+    const messages = this.messages?.length
+      ? this.messages.map((message) => ({
+        role: "user",
+        content: message,
+      }))
+      : undefined;
+    let response = !this.runThread
+      ? await this.openai.createThread({
+        $,
+        data: {
+          messages,
+          metadata: this.metadata,
+          tool_resources: this.buildToolResources(),
+        },
+      })
+      : await this.openai.createThreadAndRun({
+        $,
+        data: {
+          assistant_id: this.assistantId,
+          thread: {
+            messages,
+            metadata: this.metadata,
+          },
+          model: this.model,
+          instructions: this.instructions,
+          tools: this.buildTools(),
+          tool_resources: this.buildToolResources(),
+          metadata: this.metadata,
+        },
+      });
+
+    if (this.waitForCompletion) {
+      const runId = response.id;
+      const threadId = response.thread_id;
+      response = await this.pollRunUntilCompleted(response, threadId, runId, $);
+    }
 
-    $.export("$summary", `Successfully created a thread with ID: ${response.id}`);
+    $.export("$summary", `Successfully created a thread ${this.runThread
+      ? "and run"
+      : ""} with ID: ${response.id}`);
     return response;
   },
 };

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

@@ -13,7 +13,7 @@ import stream from "stream";
 import { promisify } from "util";
 import openai from "../../openai.app.mjs";
 import common from "../common/common.mjs";
-import constants from "../common/constants.mjs";
+import constants from "../../common/constants.mjs";
 import lang from "../common/lang.mjs";
 
 const COMMON_AUDIO_FORMATS_TEXT = "Your audio file must be in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.";
@@ -24,9 +24,9 @@ const pipelineAsync = promisify(stream.pipeline);
 
 export default {
   name: "Create Transcription (Whisper)",
-  version: "0.1.8",
+  version: "0.1.9",
   key: "openai-create-transcription",
-  description: "Transcribes audio into the input language. [See docs here](https://platform.openai.com/docs/api-reference/audio/create).",
+  description: "Transcribes audio into the input language. [See the documentation](https://platform.openai.com/docs/api-reference/audio/create).",
   type: "action",
   props: {
     openai,
@@ -227,7 +227,7 @@ export default {
 
       file = path;
     } else if (url) {
-      const ext = extname(url);
+      const ext = extname(url).split("?")[0];
 
       const response = await axios({
         method: "GET",

package/actions/delete-file/delete-file.mjs

@@ -4,23 +4,24 @@ export default {
   key: "openai-delete-file",
   name: "Delete File",
   description: "Deletes a specified file from OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/delete)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
-    file_id: {
+    fileId: {
       propDefinition: [
         openai,
-        "file_id",
+        "fileId",
       ],
     },
   },
   async run({ $ }) {
     const response = await this.openai.deleteFile({
-      file_id: this.file_id,
+      $,
+      file_id: this.fileId,
     });
 
-    $.export("$summary", `Successfully deleted file with ID: ${this.file_id}`);
+    $.export("$summary", `Successfully deleted file with ID: ${this.fileId}`);
     return response;
   },
 };

package/actions/list-files/list-files.mjs

@@ -4,7 +4,7 @@ export default {
   key: "openai-list-files",
   name: "List Files",
   description: "Returns a list of files that belong to the user's organization. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
@@ -18,9 +18,10 @@ export default {
   },
   async run({ $ }) {
     const response = await this.openai.listFiles({
+      $,
       purpose: this.purpose,
     });
-    const summary = `Successfully listed ${response.length} files`;
+    const summary = `Successfully listed ${response.data.length} files`;
     $.export("$summary", summary);
     return response;
   },

package/actions/list-messages/list-messages.mjs

@@ -4,7 +4,7 @@ export default {
   key: "openai-list-messages",
   name: "List Messages (Assistants)",
   description: "Lists the messages for a given thread. [See the documentation](https://platform.openai.com/docs/api-reference/messages/listMessages)",
-  version: "0.0.7",
+  version: "0.0.8",
   type: "action",
   props: {
     openai,
@@ -26,29 +26,26 @@ export default {
         "order",
       ],
     },
-    after: {
-      propDefinition: [
-        openai,
-        "after",
-      ],
-    },
-    before: {
-      propDefinition: [
-        openai,
-        "before",
-      ],
-    },
   },
   async run({ $ }) {
-    const response = await this.openai.listMessages({
-      threadId: this.threadId,
-      limit: this.limit,
-      order: this.order,
-      after: this.after,
-      before: this.before,
+    const response = this.openai.paginate({
+      resourceFn: this.openai.listMessages,
+      args: {
+        $,
+        threadId: this.threadId,
+        params: {
+          order: this.order,
+        },
+      },
+      max: this.limit,
     });
 
-    $.export("$summary", `Successfully listed ${response.data.length} messages for thread ID ${this.threadId}`);
-    return response.data;
+    const messages = [];
+    for await (const message of response) {
+      messages.push(message);
+    }
+
+    $.export("$summary", `Successfully listed ${messages.length} messages for thread ID ${this.threadId}`);
+    return messages;
   },
 };