@pipedream/openai 0.1.10 → 0.3.0

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.9",
+  version: "0.1.2",
   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.2",
+  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;
+  },
+};

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

@@ -0,0 +1,27 @@
+import openai from "../../openai.app.mjs";
+
+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.2",
+  type: "action",
+  props: {
+    openai,
+    purpose: {
+      propDefinition: [
+        openai,
+        "purpose",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.listFiles({
+      purpose: this.purpose,
+    });
+    const summary = `Successfully listed ${response.length} files`;
+    $.export("$summary", summary);
+    return response;
+  },
+};

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

@@ -0,0 +1,54 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-list-messages",
+  name: "List Messages",
+  description: "Lists the messages for a given thread. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        openai,
+        "limit",
+      ],
+    },
+    order: {
+      propDefinition: [
+        openai,
+        "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,
+    });
+
+    $.export("$summary", `Successfully listed ${response.data.length} messages for thread ID ${this.threadId}`);
+    return response.data;
+  },
+};

package/actions/list-run-steps/list-run-steps.mjs

@@ -0,0 +1,65 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-list-run-steps",
+  name: "List Run Steps",
+  description: "Returns a list of run steps belonging to a run. [See the documentation](https://platform.openai.com/docs/api-reference/runs/list-run-steps)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    runId: {
+      propDefinition: [
+        openai,
+        "runId",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        openai,
+        "limit",
+      ],
+      optional: true,
+    },
+    order: {
+      propDefinition: [
+        openai,
+        "order",
+      ],
+      optional: true,
+    },
+    after: {
+      propDefinition: [
+        openai,
+        "after",
+      ],
+      optional: true,
+    },
+    before: {
+      propDefinition: [
+        openai,
+        "before",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.listRunSteps({
+      threadId: this.threadId,
+      runId: this.runId,
+      limit: this.limit,
+      order: this.order,
+      after: this.after,
+      before: this.before,
+    });
+
+    $.export("$summary", `Successfully listed run steps for run ${this.runId}`);
+    return response;
+  },
+};

package/actions/list-runs/list-runs.mjs

@@ -0,0 +1,68 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-list-runs",
+  name: "List Runs",
+  description: "Returns a list of runs belonging to a thread. [See the documentation](https://platform.openai.com/docs/api-reference/runs/list)",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        openai,
+        "limit",
+      ],
+      optional: true,
+    },
+    order: {
+      propDefinition: [
+        openai,
+        "order",
+      ],
+      optional: true,
+    },
+    after: {
+      propDefinition: [
+        openai,
+        "after",
+      ],
+    },
+    before: {
+      propDefinition: [
+        openai,
+        "before",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const params = {
+      ...(this.limit && {
+        limit: this.limit,
+      }),
+      ...(this.order && {
+        order: this.order,
+      }),
+      ...(this.after && {
+        after: this.after,
+      }),
+      ...(this.before && {
+        before: this.before,
+      }),
+    };
+
+    const response = await this.openai.listRuns({
+      threadId: this.threadId,
+      ...params,
+    });
+
+    $.export("$summary", `Successfully retrieved runs for thread ${this.threadId}`);
+    return response;
+  },
+};

package/actions/modify-assistant/modify-assistant.mjs

@@ -0,0 +1,82 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-modify-assistant",
+  name: "Modify an Assistant",
+  description: "Modifies an existing OpenAI assistant. [See the documentation](https://platform.openai.com/docs/api-reference/assistants/modifyAssistant)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    openai,
+    assistant: {
+      propDefinition: [
+        openai,
+        "assistant",
+      ],
+    },
+    model: {
+      propDefinition: [
+        openai,
+        "assistantModel",
+      ],
+      optional: true,
+    },
+    name: {
+      propDefinition: [
+        openai,
+        "name",
+      ],
+      optional: true,
+    },
+    description: {
+      propDefinition: [
+        openai,
+        "description",
+      ],
+      optional: true,
+    },
+    instructions: {
+      propDefinition: [
+        openai,
+        "instructions",
+      ],
+      optional: true,
+    },
+    tools: {
+      propDefinition: [
+        openai,
+        "tools",
+      ],
+      optional: true,
+    },
+    file_ids: {
+      propDefinition: [
+        openai,
+        "file_ids",
+      ],
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.modifyAssistant({
+      $,
+      assistant: this.assistant,
+      model: this.model,
+      name: this.name,
+      description: this.description,
+      instructions: this.instructions,
+      tools: this.tools,
+      file_ids: this.file_ids,
+      metadata: this.metadata,
+    });
+    $.export("$summary", `Successfully modified assistant ${this.assistant}`);
+    return response;
+  },
+};

package/actions/modify-message/modify-message.mjs

@@ -0,0 +1,42 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-modify-message",
+  name: "Modify Message",
+  description: "Modifies an existing message in a thread. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        openai,
+        "messageId",
+      ],
+    },
+    metadata: {
+      type: "string",
+      label: "Metadata",
+      description: "Metadata for the message in JSON string format",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.modifyMessage({
+      threadId: this.threadId,
+      messageId: this.messageId,
+      metadata: this.metadata
+        ? JSON.parse(this.metadata)
+        : undefined,
+    });
+
+    $.export("$summary", `Successfully modified message ${this.messageId} in thread ${this.threadId}`);
+    return response;
+  },
+};

package/actions/modify-run/modify-run.mjs

@@ -0,0 +1,42 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-modify-run",
+  name: "Modify Run",
+  description: "Modifies an existing run. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    runId: {
+      propDefinition: [
+        openai,
+        "runId",
+      ],
+    },
+    metadata: {
+      propDefinition: [
+        openai,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.modifyRun({
+      threadId: this.threadId,
+      runId: this.runId,
+      ...(this.metadata && {
+        metadata: this.metadata,
+      }),
+    });
+
+    $.export("$summary", `Successfully modified run with ID: ${this.runId}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,26 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-retrieve-file",
+  name: "Retrieve File",
+  description: "Retrieves a specific file from OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/retrieve)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    file_id: {
+      propDefinition: [
+        openai,
+        "file_id",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.retrieveFile({
+      file_id: this.file_id,
+    });
+
+    $.export("$summary", `Successfully retrieved file with ID ${this.file_id}`);
+    return response;
+  },
+};

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

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

package/actions/retrieve-run/retrieve-run.mjs

@@ -0,0 +1,33 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-retrieve-run",
+  name: "Retrieve Run",
+  description: "Retrieves a specific run within a thread. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    runId: {
+      propDefinition: [
+        openai,
+        "runId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.retrieveRun({
+      threadId: this.threadId,
+      runId: this.runId,
+    });
+
+    $.export("$summary", `Successfully retrieved run ${this.runId} in thread ${this.threadId}`);
+    return response;
+  },
+};

package/actions/retrieve-run-step/retrieve-run-step.mjs

@@ -0,0 +1,40 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-retrieve-run-step",
+  name: "Retrieve Run Step",
+  description: "Retrieve a specific run step 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",
+      ],
+    },
+    runId: {
+      propDefinition: [
+        openai,
+        "runId",
+      ],
+    },
+    stepId: {
+      propDefinition: [
+        openai,
+        "stepId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.openai.retrieveRunStep({
+      threadId: this.threadId,
+      runId: this.runId,
+      stepId: this.stepId,
+    });
+
+    $.export("$summary", `Successfully retrieved run step with ID ${this.stepId}`);
+    return response;
+  },
+};

package/actions/send-prompt/send-prompt.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: "Create Completion (Send Prompt)",
-  version: "0.1.1",
+  version: "0.1.3",
   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 docs here](https://beta.openai.com/docs/api-reference/completions/create)",
   type: "action",

package/actions/submit-tool-outputs-to-run/submit-tool-outputs-to-run.mjs

@@ -0,0 +1,41 @@
+import openai from "../../openai.app.mjs";
+
+export default {
+  key: "openai-submit-tool-outputs-to-run",
+  name: "Submit Tool Outputs to Run",
+  description: "Submits tool outputs to a run that requires action. [See the documentation](https://platform.openai.com/docs/api-reference)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    openai,
+    threadId: {
+      propDefinition: [
+        openai,
+        "threadId",
+      ],
+    },
+    runId: {
+      propDefinition: [
+        openai,
+        "runId",
+      ],
+    },
+    toolOutputs: {
+      propDefinition: [
+        openai,
+        "toolOutputs",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const parsedToolOutputs = this.toolOutputs.map(JSON.parse);
+    const response = await this.openai.submitToolOutputs({
+      threadId: this.threadId,
+      runId: this.runId,
+      toolOutputs: parsedToolOutputs,
+    });
+
+    $.export("$summary", `Successfully submitted tool outputs to run ${this.runId}`);
+    return response;
+  },
+};

package/actions/summarize/summarize.mjs

@@ -3,7 +3,7 @@ import common from "../common/common-helper.mjs";
 export default {
   ...common,
   name: "Summarize Text",
-  version: "0.0.4",
+  version: "0.0.6",
   key: "openai-summarize",
   description: "Summarizes text using the Chat API",
   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",
-  version: "0.0.6",
+  version: "0.0.8",
   key: "openai-translate-text",
   description: "Translate text from one language to another using the Chat API",
   type: "action",

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

@@ -0,0 +1,46 @@
+import openai from "../../openai.app.mjs";
+import FormData from "form-data";
+import fs from "fs";
+
+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.5",
+  type: "action",
+  props: {
+    openai,
+    file: {
+      propDefinition: [
+        openai,
+        "file",
+      ],
+    },
+    purpose: {
+      propDefinition: [
+        openai,
+        "purpose",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      file, purpose,
+    } = this;
+    const data = new FormData();
+    const content = fs.createReadStream(file.includes("tmp/")
+      ? file
+      : `/tmp/${file}`);
+    data.append("purpose", purpose);
+    data.append("file", content);
+
+    const response = await this.openai.uploadFile({
+      $,
+      data,
+      headers: data.getHeaders(),
+    });
+
+    $.export("$summary", `Successfully uploaded file with purpose: ${purpose}`);
+    return response;
+  },
+};