@pipedream/openai 0.0.2 → 0.1.1

package/actions/chat/chat.mjs

@@ -0,0 +1,56 @@
+import openai from "../../app/openai.app.mjs";
+import common from "../common/common.mjs";
+
+export default {
+  ...common,
+  name: "Chat",
+  version: "0.1.0",
+  key: "openai-chat",
+  description: "The Chat API, using the `gpt-3.5-turbo` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)",
+  type: "action",
+  props: {
+    openai,
+    modelId: {
+      propDefinition: [
+        openai,
+        "chatCompletionModelId",
+      ],
+    },
+    userMessage: {
+      label: "User Message",
+      type: "string",
+      description: "The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.",
+    },
+    systemInstructions: {
+      label: "System Instructions",
+      type: "string",
+      description: "The system message helps set the behavior of the assistant. For example: \"You are a helpful assistant.\" [See these docs](https://platform.openai.com/docs/guides/chat/instructing-chat-models) for tips on writing good instructions.",
+      optional: true,
+    },
+    messages: {
+      label: "Prior Message History",
+      type: "string[]",
+      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,
+    },
+    ...common.props,
+  },
+  async run({ $ }) {
+    const args = this._getChatArgs();
+    const response = await this.openai.createChatCompletion({
+      $,
+      args,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully sent chat with id ${response.id}`);
+    }
+
+    const { messages } = args;
+    return {
+      original_messages: messages,
+      original_messages_with_assistant_response: messages.concat(response.choices[0]?.message),
+      ...response,
+    };
+  },
+};

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

@@ -0,0 +1,56 @@
+import common from "../common/common-helper.mjs";
+
+export default {
+  ...common,
+  name: "Classify Items into Categories",
+  version: "0.0.2",
+  key: "openai-classify-items-into-categories",
+  description: "Classify items into specific categories using the Chat API",
+  type: "action",
+  props: {
+    ...common.props,
+    items: {
+      label: "Items",
+      description: "Items to categorize",
+      type: "string[]",
+    },
+    categories: {
+      label: "Categories",
+      description: "Categories to classify items into",
+      type: "string[]",
+    },
+  },
+  methods: {
+    ...common.methods,
+    systemInstructions() {
+      return "Your goal is to categorize items into specific categories and produce ONLY JSON. The user will provide both the items and categories. Please only categorize items into the specific categories, and no others, and output ONLY JSON.";
+    },
+    outputFormat() {
+      return "Please only categorize items into the specific categories, and no others. Output a valid JSON string — an array of objects, where each object has the following properties: item, category. Do not return any English text other than the JSON, either before or after the JSON. I need to parse the response as JSON, and parsing will fail if you return any English before or after the JSON";
+    },
+    userMessage() {
+      return `Categorize each of the following items:\n\n${this.items.join("\n")}\n\ninto one of the following categories:\n\n${this.categories.join("\n")}\n\n${this.outputFormat()}}`;
+    },
+    summary() {
+      return `Categorized ${this.items.length} items into ${this.categories.length} categories`;
+    },
+    formatOutput({
+      messages, response,
+    }) {
+      if (!messages || !response) {
+        throw new Error("Invalid API output, please reach out to https://pipedream.com/support");
+      }
+      const assistantResponse = response.choices?.[0]?.message?.content;
+      let categorizations = assistantResponse;
+      try {
+        categorizations = JSON.parse(assistantResponse);
+      } catch (err) {
+        console.log("Failed to parse output, assistant returned malformed JSON");
+      }
+      return {
+        categorizations,
+        messages,
+      };
+    },
+  },
+};

package/actions/common/common-helper.mjs

@@ -0,0 +1,55 @@
+import openai from "../../app/openai.app.mjs";
+import common from "./common.mjs";
+
+export default {
+  ...common,
+  props: {
+    openai,
+    ...common.props,
+  },
+  methods: {
+    ...common.methods,
+    systemInstructions() {
+      throw new Error("systemInstructions() must be implemented by the component");
+    },
+    userMessage() {
+      throw new Error("userMessage() must be implemented by the component");
+    },
+    summary() {
+      return;
+    },
+    formatOutput() {
+      throw new Error("formatOutput() must be implemented by the component");
+    },
+  },
+  async run({ $ }) {
+    const messages = [
+      {
+        role: "system",
+        content: this.systemInstructions(),
+      },
+      {
+        role: "user",
+        content: this.userMessage(),
+      },
+    ];
+    const args = {
+      ...this._getCommonArgs(),
+      model: "gpt-3.5-turbo",
+      messages,
+    };
+    const response = await this.openai.createChatCompletion({
+      $,
+      args,
+    });
+
+    if (this.summary() && response) {
+      $.export("$summary", this.summary());
+    }
+
+    return this.formatOutput({
+      response,
+      messages,
+    });
+  },
+};

package/actions/common/common.mjs

@@ -0,0 +1,141 @@
+import { ConfigurationError } from "@pipedream/platform";
+
+const CHAT_DOCS_MESSAGE_FORMAT_URL = "https://platform.openai.com/docs/guides/chat/introduction";
+
+export default {
+  props: {
+    maxTokens: {
+      label: "Max Tokens",
+      description: "The maximum number of [tokens](https://beta.openai.com/tokenizer) to generate in the completion.",
+      type: "integer",
+      optional: true,
+    },
+    temperature: {
+      label: "Temperature",
+      description: "**Optional**. What [sampling temperature](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277) to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.",
+      type: "string",
+      optional: true,
+    },
+    topP: {
+      label: "Top P",
+      description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.",
+      type: "string",
+      optional: true,
+    },
+    n: {
+      label: "N",
+      description: "How many completions to generate for each prompt",
+      type: "integer",
+      optional: true,
+    },
+    stop: {
+      label: "Stop",
+      description: "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.",
+      type: "string[]",
+      optional: true,
+    },
+    presencePenalty: {
+      label: "Presence Penalty",
+      description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.",
+      type: "string",
+      optional: true,
+    },
+    frequencyPenalty: {
+      label: "Frequency Penalty",
+      description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.",
+      type: "string",
+      optional: true,
+    },
+    user: {
+      label: "User",
+      description: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more here](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).",
+      type: "string",
+      optional: true,
+    },
+  },
+  methods: {
+    _getCommonArgs() {
+      return {
+        model: this.modelId,
+        prompt: this.prompt,
+        max_tokens: this.maxTokens,
+        temperature: this.temperature
+          ? +this.temperature
+          : this.temperature,
+        top_p: this.topP
+          ? +this.topP
+          : this.topP,
+        n: this.n,
+        stop: this.stop,
+        presence_penalty: this.presencePenalty
+          ? +this.presencePenalty
+          : this.presencePenalty,
+        frequency_penalty: this.frequencyPenalty
+          ? +this.frequencyPenalty
+          : this.frequencyPenalty,
+        best_of: this.bestOf,
+        user: this.user,
+      };
+    },
+    _getChatArgs() {
+      if (this.messages && this.messages.length && !this.userMessage) {
+        throw new ConfigurationError(
+          `When you provide previous messages, you must provide the next User Message for the assistant to answer. See the OpenAI Chat format docs here: ${CHAT_DOCS_MESSAGE_FORMAT_URL}`,
+        );
+      }
+      let messages = [];
+      if (this.messages) {
+        for (const message of this.messages) {
+          console.log(`Message: ${JSON.stringify(message)}`);
+          let parsed;
+          try {
+            if (typeof message === "string") {
+              parsed = JSON.parse(message);
+            } else {
+              parsed = message;
+            }
+          } catch (err) {
+            throw new ConfigurationError(
+              `Please provide a valid array of chat messages. See the docs here: ${CHAT_DOCS_MESSAGE_FORMAT_URL}`,
+            );
+
+          }
+          if (!parsed.role) {
+            throw new ConfigurationError(
+              `The following message doesn't have a "role" property:\n\n${JSON.stringify(message, null, 2)}\n\nSee the docs here: ${CHAT_DOCS_MESSAGE_FORMAT_URL}`,
+            );
+          }
+          if (!parsed.content) {
+            throw new ConfigurationError(
+              `The following message doesn't have a "content" property:\n\n${JSON.stringify(message, null, 2)}\n\nSee the docs here: ${CHAT_DOCS_MESSAGE_FORMAT_URL}`,
+            );
+          }
+          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({
+            "role": "system",
+            "content": this.systemInstructions,
+          });
+        }
+        messages.push({
+          "role": "user",
+          "content": this.userMessage,
+        });
+      }
+
+      return {
+        ...this._getCommonArgs(),
+        messages,
+      };
+    },
+  },
+};

package/actions/common/constants.mjs

@@ -4,8 +4,11 @@ export default {
     "512x512",
     "1024x1024",
   ],
-  RESPONSE_FORMATS: [
-    "url",
-    "b64_json",
+  TRANSCRIPTION_FORMATS: [
+    "json",
+    "text",
+    "srt",
+    "verbose_json",
+    "vtt",
   ],
 };