@pipedream/openai 0.5.1 → 0.5.2

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

@@ -4,7 +4,7 @@ export default {
   key: "openai-list-run-steps",
   name: "List Run Steps (Assistants)",
   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.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
@@ -28,41 +28,34 @@ export default {
         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,
+    const response = this.openai.paginate({
+      resourceFn: this.openai.listRunSteps,
+      args: {
+        $,
+        threadId: this.threadId,
+        runId: this.runId,
+        params: {
+          order: this.order,
+        },
+      },
+      max: this.limit,
     });
 
+    const runSteps = [];
+    for await (const runStep of response) {
+      runSteps.push(runStep);
+    }
+
     $.export("$summary", `Successfully listed run steps for run ${this.runId}`);
-    return response;
+    return runSteps;
   },
 };

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

@@ -4,7 +4,7 @@ export default {
   key: "openai-list-runs",
   name: "List Runs (Assistants)",
   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.7",
+  version: "0.0.8",
   type: "action",
   props: {
     openai,
@@ -19,50 +19,33 @@ export default {
         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,
+    const response = this.openai.paginate({
+      resourceFn: this.openai.listRuns,
+      args: {
+        $,
+        threadId: this.threadId,
+        params: {
+          order: this.order,
+        },
+      },
+      max: this.limit,
     });
 
+    const runs = [];
+    for await (const run of response) {
+      runs.push(run);
+    }
+
     $.export("$summary", `Successfully retrieved runs for thread ${this.threadId}`);
-    return response;
+    return runs;
   },
 };

package/actions/modify-assistant/modify-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-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.1.3",
+  version: "0.1.4",
   type: "action",
   props: {
     openai,
@@ -43,20 +44,6 @@ export default {
       ],
       optional: true,
     },
-    tools: {
-      propDefinition: [
-        openai,
-        "tools",
-      ],
-      optional: true,
-    },
-    file_ids: {
-      propDefinition: [
-        openai,
-        "file_ids",
-      ],
-      optional: true,
-    },
     metadata: {
       propDefinition: [
         openai,
@@ -64,18 +51,21 @@ export default {
       ],
       optional: true,
     },
+    ...common.props,
   },
   async run({ $ }) {
     const response = await this.openai.modifyAssistant({
       $,
       assistant: this.assistant,
-      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 modified assistant ${this.assistant}`);
     return response;

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

@@ -4,23 +4,24 @@ 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.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
-    file_id: {
+    fileId: {
       propDefinition: [
         openai,
-        "file_id",
+        "fileId",
       ],
     },
   },
   async run({ $ }) {
     const response = await this.openai.retrieveFile({
-      file_id: this.file_id,
+      $,
+      file_id: this.fileId,
     });
 
-    $.export("$summary", `Successfully retrieved file with ID ${this.file_id}`);
+    $.export("$summary", `Successfully retrieved file with ID ${this.fileId}`);
     return response;
   },
 };

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

@@ -1,25 +1,48 @@
 import openai from "../../openai.app.mjs";
+import fs from "fs";
 
 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.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
-    file_id: {
+    fileId: {
       propDefinition: [
         openai,
-        "file_id",
+        "fileId",
       ],
     },
+    fileName: {
+      type: "string",
+      label: "Filename",
+      description: "Optionally, download the file to the `/tmp` directory using the given filename",
+      optional: true,
+    },
   },
   async run({ $ }) {
     const response = await this.openai.retrieveFileContent({
-      file_id: this.file_id,
+      $,
+      file_id: this.fileId,
+      responseType: "arraybuffer",
     });
-    $.export("$summary", `Successfully retrieved file content with ID ${this.file_id}`);
-    return response;
+
+    if (!this.fileName) {
+      $.export("$summary", `Successfully retrieved file content with ID ${this.fileId}`);
+      return response;
+    }
+
+    const outputFilePath = this.fileName.includes("tmp/")
+      ? this.fileName
+      : `/tmp/${this.fileName}`;
+    await fs.promises.writeFile(outputFilePath, Buffer.from(response));
+    const filedata = [
+      this.fileName,
+      outputFilePath,
+    ];
+    $.export("$summary", `Successfully retrieved and downloaded file content with ID ${this.fileId}`);
+    return filedata;
   },
 };

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

@@ -4,7 +4,7 @@ export default {
   key: "openai-retrieve-run",
   name: "Retrieve Run (Assistants)",
   description: "Retrieves a specific run within a thread. [See the documentation](https://platform.openai.com/docs/api-reference/runs/getRun)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
@@ -26,6 +26,7 @@ export default {
   },
   async run({ $ }) {
     const response = await this.openai.retrieveRun({
+      $,
       threadId: this.threadId,
       runId: this.runId,
     });

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

@@ -4,7 +4,7 @@ export default {
   key: "openai-retrieve-run-step",
   name: "Retrieve Run Step (Assistants)",
   description: "Retrieve a specific run step in a thread. [See the documentation](https://platform.openai.com/docs/api-reference/runs/getRunStep)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
@@ -27,11 +27,18 @@ export default {
       propDefinition: [
         openai,
         "stepId",
+        ({
+          threadId, runId,
+        }) => ({
+          threadId,
+          runId,
+        }),
       ],
     },
   },
   async run({ $ }) {
     const response = await this.openai.retrieveRunStep({
+      $,
       threadId: this.threadId,
       runId: this.runId,
       stepId: this.stepId,

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

@@ -4,12 +4,17 @@ import common from "../common/common.mjs";
 export default {
   ...common,
   name: "Create Completion (Send Prompt)",
-  version: "0.1.7",
+  version: "0.1.8",
   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)",
+  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",
   props: {
     openai,
+    alert: {
+      type: "alert",
+      alertType: "warning",
+      content: "We recommend using the Pipedream **Chat** action instead of this one. It supports the latest `gpt-3.5-turbo` API, which is faster and 10x cheaper. This action, **Create Completion (Send Prompt)**, creates a completion for the provided prompt and parameters using the older `/completions` API.",
+    },
     modelId: {
       propDefinition: [
         openai,
@@ -38,7 +43,7 @@ export default {
   async run({ $ }) {
     const response = await this.openai.createCompletion({
       $,
-      args: this._getCommonArgs(),
+      data: this._getCommonArgs(),
     });
 
     if (response) {

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

@@ -1,10 +1,11 @@
 import openai from "../../openai.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   key: "openai-submit-tool-outputs-to-run",
   name: "Submit Tool Outputs to Run (Assistants)",
   description: "Submits tool outputs to a run that requires action. [See the documentation](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     openai,
@@ -31,11 +32,25 @@ export default {
     },
   },
   async run({ $ }) {
-    const parsedToolOutputs = this.toolOutputs.map(JSON.parse);
+    const parsedToolOutputs = typeof this.toolOutputs === "string"
+      ? JSON.parse(this.toolOutputs)
+      : Array.isArray(this.toolOutputs)
+        ? this.toolOutputs.map((output) => typeof output === "string"
+          ? JSON.parse(output)
+          : output)
+        : null;
+
+    if (!parsedToolOutputs) {
+      throw new ConfigurationError("Could not parse tool outputs as JSON.");
+    }
+
     const response = await this.openai.submitToolOutputs({
+      $,
       threadId: this.threadId,
       runId: this.runId,
-      toolOutputs: parsedToolOutputs,
+      data: {
+        tool_outputs: parsedToolOutputs,
+      },
     });
 
     $.export("$summary", `Successfully submitted tool outputs to run ${this.runId}`);

package/actions/summarize/summarize.mjs

@@ -1,11 +1,12 @@
 import common from "../common/common-helper.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   ...common,
   name: "Summarize Text",
-  version: "0.0.10",
+  version: "0.0.11",
   key: "openai-summarize",
-  description: "Summarizes text using the Chat API",
+  description: "Summarizes text using the Chat API. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",
   props: {
     ...common.props,
@@ -19,12 +20,7 @@ export default {
       description: "The length of the summary",
       type: "string",
       optional: true,
-      options: [
-        "word",
-        "sentence",
-        "paragraph",
-        "page",
-      ],
+      options: constants.SUMMARIZE_LENGTH,
     },
   },
   methods: {
@@ -46,10 +42,15 @@ export default {
       if (!messages || !response) {
         throw new Error("Invalid API output, please reach out to https://pipedream.com/support");
       }
-      return {
-        summary: response.choices?.[0]?.message?.content,
+      const output = {
         messages,
       };
+      if (this.n > 1) {
+        output.summaries = response.choices?.map(({ message }) => message.content);
+      } else {
+        output.summary = response.choices?.[0]?.message?.content;
+      }
+      return output;
     },
   },
 };

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

@@ -9,9 +9,9 @@ const langOptions = lang.LANGUAGES.map((l) => ({
 export default {
   ...common,
   name: "Translate Text (Whisper)",
-  version: "0.0.12",
+  version: "0.0.13",
   key: "openai-translate-text",
-  description: "Translate text from one language to another using the Chat API",
+  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",
   props: {
     ...common.props,
@@ -50,13 +50,17 @@ export default {
       if (!messages || !response) {
         throw new Error("Invalid API output, please reach out to https://pipedream.com/support");
       }
-
-      return {
-        translation: response.choices?.[0]?.message?.content,
+      const output = {
         source_lang: this.sourceLang,
         target_lang: this.targetLang,
         messages,
       };
+      if (this.n > 1) {
+        output.translations = response.choices?.map(({ message }) => message.content);
+      } else {
+        output.translation = response.choices?.[0]?.message?.content;
+      }
+      return output;
     },
   },
 };

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.0.9",
+  version: "0.0.10",
   type: "action",
   props: {
     openai,

package/common/constants.mjs

@@ -1,4 +1,4 @@
-export const FINE_TUNING_MODEL_OPTIONS = [
+const FINE_TUNING_MODEL_OPTIONS = [
   {
     label: "gpt-3.5-turbo-1106 (recommended)",
     value: "gpt-3.5-turbo-1106",
@@ -16,8 +16,159 @@ export const FINE_TUNING_MODEL_OPTIONS = [
     value: "davinci-002",
   },
   {
-    label:
-      "gpt-4-0613 (experimental — eligible users will be presented with an option to request access in the fine-tuning UI)",
+    label: "gpt-4-0613 (experimental — eligible users will be presented with an option to request access in the fine-tuning UI)",
     value: "gpt-4-0613",
   },
 ];
+
+const TTS_MODELS = [
+  "tts-1",
+  "tts-1-hd",
+];
+
+const IMAGE_MODELS = [
+  "dall-e-2",
+  "dall-e-3",
+];
+
+const MODERATION_MODELS = [
+  "text-moderation-stable",
+  "text-moderation-latest",
+];
+
+const AUDIO_RESPONSE_FORMATS = [
+  "mp3",
+  "opus",
+  "aac",
+  "flac",
+  "wav",
+  "pcm",
+];
+
+const CHAT_RESPONSE_FORMATS = [
+  "text",
+  "json_object",
+];
+
+const IMAGE_RESPONSE_FORMATS = [
+  {
+    label: "URL",
+    value: "url",
+  },
+  {
+    label: "Base64 JSON",
+    value: "b64_json",
+  },
+];
+
+const USER_OPTIONS = [
+  {
+    label: "User",
+    value: "user",
+  },
+];
+
+const ORDER_OPTIONS = [
+  {
+    label: "Ascending",
+    value: "asc",
+  },
+  {
+    label: "Descending",
+    value: "desc",
+  },
+];
+
+const TRANSCRIPTION_FORMATS = [
+  "json",
+  "text",
+  "srt",
+  "verbose_json",
+  "vtt",
+];
+
+const PURPOSES = [
+  "fine-tune",
+  "assistants",
+  "vision",
+  "batch",
+];
+
+const VOICES = [
+  "alloy",
+  "echo",
+  "fable",
+  "onyx",
+  "nova",
+  "shimmer",
+];
+
+const IMAGE_QUALITIES = [
+  {
+    label: "Standard",
+    value: "standard",
+  },
+  {
+    label: "HD",
+    value: "hd",
+  },
+];
+
+const IMAGE_STYLES = [
+  {
+    label: "Natural",
+    value: "natural",
+  },
+  {
+    label: "Vivid",
+    value: "vivid",
+  },
+];
+
+const IMAGE_SIZES = [
+  "256x256",
+  "512x512",
+  "1024x1024",
+  "1792x1024",
+  "1024x1792",
+];
+
+const SUMMARIZE_LENGTH = [
+  "word",
+  "sentence",
+  "paragraph",
+  "page",
+];
+
+const TOOL_TYPES = [
+  "code_interpreter",
+  "file_search",
+  "function",
+];
+
+const BATCH_ENDPOINTS = [
+  "/v1/chat/completions",
+  "/v1/embeddings",
+  "/v1/completions",
+];
+
+export default {
+  FINE_TUNING_MODEL_OPTIONS,
+  TTS_MODELS,
+  IMAGE_MODELS,
+  MODERATION_MODELS,
+  AUDIO_RESPONSE_FORMATS,
+  CHAT_RESPONSE_FORMATS,
+  IMAGE_RESPONSE_FORMATS,
+  USER_OPTIONS,
+  ORDER_OPTIONS,
+  TRANSCRIPTION_FORMATS,
+  PURPOSES,
+  VOICES,
+  IMAGE_QUALITIES,
+  IMAGE_STYLES,
+  IMAGE_SIZES,
+  SUMMARIZE_LENGTH,
+  TOOL_TYPES,
+  BATCH_ENDPOINTS,
+};