@pipedream/openai 0.0.1 → 0.1.0

package/LICENSE

@@ -1,7 +1,41 @@
-Copyright 2020 Pipedream, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

package/README.md

@@ -0,0 +1,22 @@
+# Overview
+
+The OpenAI API is a powerful tool that provides access to a range of
+high-powered machine learning models. With the OpenAI API, developers can
+create products, services, and tools that enable humanizing AI experiences, and
+build applications that extend the power of human language.
+
+Using the OpenAI API, developers can create language-driven applications such
+as:
+
+- Natural language understanding and sentiment analysis
+- Text-based search
+- Question answering
+- Dialogue systems and conversation agents
+- Intelligent text completion
+- Text summarization
+- Text classification
+- Machine translation
+- Language generation
+- Multi-factor authentication
+- Anomaly detection
+- Text analysis

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.1",
+  key: "openai-classify-items-into-categories",
+  description: "Classify items into specific categories using the Chat API",
+  type: "action",
+  props: {
+    items: {
+      label: "Items",
+      description: "Items to categorize",
+      type: "string[]",
+    },
+    categories: {
+      label: "Categories",
+      description: "Categories to classify items into",
+      type: "string[]",
+    },
+    ...common.props,
+  },
+  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()}}`;
+    },
+    summarize() {
+      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",
   ],
 };