@pipedream/openai 0.1.9 → 0.2.0

package/actions/cancel-run/cancel-run.mjs

@@ -0,0 +1,33 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-cancel-run",
+  name: "Cancel Run",
+  description: "Cancels a run that is in progress. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    runId: {
+      propDefinition: [
+        openai,
+        "runId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.cancelRun({
+      threadId: this.threadId,
+      runId: this.runId,
+    });
+
+    $.export("$summary", `Successfully cancelled run ${this.runId} in thread ${this.threadId}`);
+    return response;
+  },
+};

package/actions/chat/chat.mjs

@@ -1,10 +1,10 @@
-import openai from "../../app/openai.app.mjs";
+import openai from "../../openai.app.mjs";
 import common from "../common/common.mjs";
 
 export default {
   ...common,
   name: "Chat",
-  version: "0.1.2",
+  version: "0.1.3",
   key: "openai-chat",
   description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",
@@ -33,10 +33,17 @@ export default {
       description: "_Advanced_. Because [the models have no memory of past chat requests](https://platform.openai.com/docs/guides/chat/introduction), all relevant information must be supplied via the conversation. You can provide [an array of messages](https://platform.openai.com/docs/guides/chat/introduction) from prior conversations here. If this param is set, the action ignores the values passed to **System Instructions** and **Assistant Response**, appends the new **User Message** to the end of this array, and sends it to the API.",
       optional: true,
     },
+    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`",
+      optional: true,
+    },
     ...common.props,
   },
   async run({ $ }) {
     const args = this._getChatArgs();
+
     const response = await this.openai.createChatCompletion({
       $,
       args,

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.0.4",
+  version: "0.0.5",
   key: "openai-classify-items-into-categories",
   description: "Classify items into specific categories using the Chat API",
   type: "action",

package/actions/common/common-helper.mjs

@@ -1,4 +1,4 @@
-import openai from "../../app/openai.app.mjs";
+import openai from "../../openai.app.mjs";
 import common from "./common.mjs";
 
 export default {

package/actions/common/common.mjs

@@ -77,6 +77,26 @@ export default {
         user: this.user,
       };
     },
+    _getUserMessageContent() {
+      let content = [];
+      if (this.images) {
+        for (const image of this.images) {
+          content.push({
+            "type": "image_url",
+            "image_url": {
+              "url": image,
+            },
+          });
+        }
+      }
+
+      content.push({
+        "type": "text",
+        "text": this.userMessage,
+      });
+
+      return content;
+    },
     _getChatArgs() {
       if (this.messages && this.messages.length && !this.userMessage) {
         throw new ConfigurationError(
@@ -112,13 +132,6 @@ export default {
           }
           messages.push(parsed);
         }
-        // Finally, we want to append the user message to the end of the array
-        if (this.userMessage) {
-          messages.push({
-            "role": "user",
-            "content": this.userMessage,
-          });
-        }
       } else {
         if (this.systemInstructions) {
           messages.push({
@@ -126,12 +139,13 @@ export default {
             "content": this.systemInstructions,
           });
         }
-        messages.push({
-          "role": "user",
-          "content": this.userMessage,
-        });
       }
 
+      messages.push({
+        "role": "user",
+        "content": this._getUserMessageContent(),
+      });
+
       return {
         ...this._getCommonArgs(),
         messages,

package/actions/common/lang.mjs

@@ -34,67 +34,67 @@ export default {
     },
     {
       "label": "Arabic (Algeria)",
-      "value": "ar-dz"
+      "value": "ar-dz",
     },
     {
       "label": "Arabic (Bahrain)",
-      "value": "ar-bh"
+      "value": "ar-bh",
     },
     {
       "label": "Arabic (Egypt)",
-      "value": "ar-eg"
+      "value": "ar-eg",
     },
     {
       "label": "Arabic (Iraq)",
-      "value": "ar-iq"
+      "value": "ar-iq",
     },
     {
       "label": "Arabic (Jordan)",
-      "value": "ar-jo"
+      "value": "ar-jo",
     },
     {
       "label": "Arabic (Kuwait)",
-      "value": "ar-kw"
+      "value": "ar-kw",
     },
     {
       "label": "Arabic (Lebanon)",
-      "value": "ar-lb"
+      "value": "ar-lb",
     },
     {
       "label": "Arabic (Libya)",
-      "value": "ar-ly"
+      "value": "ar-ly",
     },
     {
       "label": "Arabic (Morocco)",
-      "value": "ar-ma"
+      "value": "ar-ma",
     },
     {
       "label": "Arabic (Oman)",
-      "value": "ar-om"
+      "value": "ar-om",
     },
     {
       "label": "Arabic (Qatar)",
-      "value": "ar-qa"
+      "value": "ar-qa",
     },
     {
       "label": "Arabic (Saudi Arabia)",
-      "value": "ar-sa"
+      "value": "ar-sa",
     },
     {
       "label": "Arabic (Syria)",
-      "value": "ar-sy"
+      "value": "ar-sy",
     },
     {
       "label": "Arabic (Tunisia)",
-      "value": "ar-tn"
+      "value": "ar-tn",
     },
     {
       "label": "Arabic (U.A.E.)",
-      "value": "ar-ae"
+      "value": "ar-ae",
     },
     {
       "label": "Arabic (Yemen)",
-      "value": "ar-ye"
+      "value": "ar-ye",
     },
     {
       "label": "Assamese",

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

@@ -0,0 +1,71 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  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.0.{{ts}}",
+  type: "action",
+  props: {
+    openai,
+    model: {
+      propDefinition: [
+        openai,
+        "assistantModel",
+      ],
+    },
+    name: {
+      propDefinition: [
+        openai,
+        "name",
+      ],
+    },
+    description: {
+      propDefinition: [
+        openai,
+        "description",
+      ],
+    },
+    instructions: {
+      propDefinition: [
+        openai,
+        "instructions",
+      ],
+    },
+    tools: {
+      propDefinition: [
+        openai,
+        "tools",
+      ],
+    },
+    file_ids: {
+      propDefinition: [
+        openai,
+        "file_ids",
+      ],
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.createAssistant({
+      $,
+      model: this.model,
+      name: this.name,
+      description: this.description,
+      instructions: this.instructions,
+      tools: (this.tools || []).map((tool) => ({
+        type: tool,
+      })),
+      file_ids: this.file_ids,
+      metadata: this.metadata,
+    });
+
+    $.export("$summary", `Successfully created an assistant with ID: ${response.id}`);
+    return response;
+  },
+};

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

@@ -1,10 +1,10 @@
-import openai from "../../app/openai.app.mjs";
+import openai from "../../openai.app.mjs";
 import common from "../common/common.mjs";
 import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   name: "Create Embeddings",
-  version: "0.0.2",
+  version: "0.0.3",
   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)",
   type: "action",

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

@@ -1,14 +1,30 @@
-import openai from "../../app/openai.app.mjs";
+import openai from "../../openai.app.mjs";
 import constants from "../common/constants.mjs";
 
 export default {
   name: "Create Image",
-  version: "0.1.2",
+  version: "0.1.4",
   key: "openai-create-image",
   description: "Creates an image given a prompt. returns a URL to the image. [See docs here](https://platform.openai.com/docs/api-reference/images)",
   type: "action",
   props: {
     openai,
+    model: {
+      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",
+    },
     prompt: {
       label: "Prompt",
       description: "A text description of the desired image(s). The maximum length is 1000 characters.",
@@ -29,6 +45,40 @@ export default {
       options: constants.IMAGE_SIZES,
       default: "1024x1024",
     },
+    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",
+    },
   },
   async run({ $ }) {
     const response = await this.openai.createImage({
@@ -38,6 +88,9 @@ export default {
         n: this.n,
         size: this.size,
         response_format: this.responseFormat,
+        model: this.model,
+        quality: this.quality,
+        style: this.style,
       },
     });
 

package/actions/create-message/create-message.mjs

@@ -0,0 +1,64 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-create-message",
+  name: "Create Message",
+  description: "Create a message in a thread. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    content: {
+      propDefinition: [
+        openai,
+        "content",
+      ],
+    },
+    role: {
+      propDefinition: [
+        openai,
+        "role",
+      ],
+      default: "user",
+    },
+    fileIds: {
+      propDefinition: [
+        openai,
+        "fileIds",
+      ],
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const fileIdsArray = this.fileIds
+      ? this.fileIds.map((fileId) => fileId.trim())
+      : undefined;
+    const metadataObject = this.metadata
+      ? JSON.parse(this.metadata)
+      : undefined;
+
+    const response = await this.openai.createMessage({
+      threadId: this.threadId,
+      content: this.content,
+      role: this.role,
+      fileIds: fileIdsArray,
+      metadata: metadataObject,
+    });
+
+    $.export("$summary", `Successfully created a message in thread ${this.threadId}`);
+    return response;
+  },
+};

package/actions/create-run/create-run.mjs

@@ -0,0 +1,64 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-create-run",
+  name: "Create Run",
+  description: "Creates a run given a thread ID and assistant ID. [See the documentation](https://platform.openai.com/docs/api-reference/runs/create)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    assistantId: {
+      propDefinition: [
+        openai,
+        "assistantId",
+      ],
+    },
+    model: {
+      propDefinition: [
+        openai,
+        "model",
+      ],
+    },
+    instructions: {
+      propDefinition: [
+        openai,
+        "instructions",
+      ],
+    },
+    tools: {
+      propDefinition: [
+        openai,
+        "tools",
+      ],
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.createRun({
+      threadId: this.threadId,
+      assistantId: this.assistantId,
+      model: this.model,
+      instructions: this.instructions,
+      tools: this.tools,
+      metadata: this.metadata,
+    });
+
+    const summary = response.id
+      ? `Successfully created a run with ID: ${response.id}`
+      : `Successfully created a run in thread ${this.threadId}`;
+    $.export("$summary", summary);
+    return response;
+  },
+};

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

@@ -0,0 +1,36 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-create-thread",
+  name: "Create Thread",
+  description: "Creates a thread with optional messages and metadata. [See the documentation](https://platform.openai.com/docs/api-reference/threads/createThread)",
+  version: "0.0.{{ts}}",
+  type: "action",
+  props: {
+    openai,
+    messages: {
+      propDefinition: [
+        openai,
+        "messages",
+      ],
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.createThread({
+      $,
+      messages: this.messages,
+      metadata: this.metadata,
+    });
+
+    $.export("$summary", `Successfully created a thread with ID: ${response.id}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,61 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-create-thread-and-run",
+  name: "Create Thread and Run",
+  description: "Create a thread and run it in one request using the specified assistant ID and optional parameters. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    openai,
+    assistantId: {
+      propDefinition: [
+        openai,
+        "assistantId",
+      ],
+    },
+    thread: {
+      type: "object",
+      label: "Thread",
+      description: "The thread object containing messages and other optional properties.",
+      optional: true,
+    },
+    model: {
+      propDefinition: [
+        openai,
+        "model",
+      ],
+    },
+    instructions: {
+      propDefinition: [
+        openai,
+        "instructions",
+      ],
+    },
+    tools: {
+      propDefinition: [
+        openai,
+        "tools",
+      ],
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.createThreadAndRun({
+      assistant_id: this.assistantId,
+      thread: this.thread,
+      model: this.model,
+      instructions: this.instructions,
+      tools: this.tools,
+      metadata: this.metadata,
+    });
+
+    $.export("$summary", `Successfully created thread and initiated run with ID: ${response.id}`);
+    return response;
+  },
+};

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

@@ -9,7 +9,7 @@ import { ConfigurationError } from "@pipedream/platform";
 import common from "../common/common.mjs";
 import constants from "../common/constants.mjs";
 import lang from "../common/lang.mjs";
-import openai from "../../app/openai.app.mjs";
+import openai from "../../openai.app.mjs";
 import { promisify } from "util";
 import stream from "stream";
 import { exec } from "child_process";
@@ -22,7 +22,7 @@ const pipelineAsync = promisify(stream.pipeline);
 
 export default {
   name: "Create Transcription",
-  version: "0.0.8",
+  version: "0.1.1",
   key: "openai-create-transcription",
   description: "Transcribes audio into the input language. [See docs here](https://platform.openai.com/docs/api-reference/audio/create).",
   type: "action",
@@ -43,7 +43,6 @@ export default {
       description: "**Optional**. The language of the input audio. Supplying the input language will improve accuracy and latency.",
       type: "string",
       optional: true,
-      default: "en",
       options: lang.LANGUAGES.map((l) => ({
         label: l.label,
         value: l.value,

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

@@ -0,0 +1,26 @@
+import openai from "../../openai.app.mjs";
+
+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.1",
+  type: "action",
+  props: {
+    openai,
+    file_id: {
+      propDefinition: [
+        openai,
+        "file_id",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.deleteFile({
+      file_id: this.file_id,
+    });
+
+    $.export("$summary", `Successfully deleted file with ID: ${this.file_id}`);
+    return response;
+  },
+};