@pipedream/openai 0.7.3 → 0.9.0

package/actions/analyze-image-content/analyze-image-content.mjs

@@ -8,7 +8,7 @@ export default {
   key: "openai-analyze-image-content",
   name: "Analyze Image Content",
   description: "Send a message or question about an image and receive a response. [See the documentation](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)",
-  version: "0.1.4",
+  version: "0.1.5",
   type: "action",
   props: {
     openai,

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

@@ -4,7 +4,7 @@ export default {
   key: "openai-cancel-run",
   name: "Cancel Run (Assistants)",
   description: "Cancels a run that is in progress. [See the documentation](https://platform.openai.com/docs/api-reference/runs/cancelRun)",
-  version: "0.0.13",
+  version: "0.0.14",
   type: "action",
   props: {
     openai,

package/actions/chat/chat.mjs

@@ -6,12 +6,17 @@ import { ConfigurationError } from "@pipedream/platform";
 export default {
   ...common,
   name: "Chat",
-  version: "0.2.5",
+  version: "0.2.6",
   key: "openai-chat",
   description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",
   props: {
     openai,
+    alert: {
+      type: "alert",
+      alertType: "info",
+      content: "Looking to chat with your tools? Check out our individual actions: [Chat using Web Search](https://pipedream.com/apps/openai/actions/chat-using-web-search), [Chat using File Search](https://pipedream.com/apps/openai/actions/chat-using-file-search), and [Chat using Functions](https://pipedream.com/apps/openai/actions/chat-using-functions).",
+    },
     modelId: {
       propDefinition: [
         openai,

package/actions/chat-using-file-search/chat-using-file-search.mjs

@@ -0,0 +1,229 @@
+import openai from "../../openai.app.mjs";
+import common from "../common/common.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  name: "Chat using File Search",
+  version: "0.0.1",
+  key: "openai-chat-using-file-search",
+  description: "Chat with your files knowledge base (vector stores). [See the documentation](https://platform.openai.com/docs/guides/tools-file-search)",
+  type: "action",
+  props: {
+    openai,
+    alert: {
+      type: "alert",
+      alertType: "info",
+      content: "To use this action, you need to have set up a knowledge base in a vector store and uploaded files to it. [More infomation here](https://platform.openai.com/docs/guides/tools-file-search?lang=javascript#overview).",
+    },
+    modelId: {
+      propDefinition: [
+        openai,
+        "chatCompletionModelId",
+      ],
+    },
+    vectorStoreId: {
+      propDefinition: [
+        openai,
+        "vectorStoreId",
+      ],
+      description: "The identifier of a vector store. Currently supports only one vector store at a time",
+    },
+    input: {
+      type: "string",
+      label: "Chat Input",
+      description: "Text, image, or file inputs to the model, used to generate a response",
+    },
+    instructions: {
+      type: "string",
+      label: "Instructions",
+      description: "Inserts a system (or developer) message as the first item in the model's context",
+      optional: true,
+    },
+    includeSearchResults: {
+      type: "boolean",
+      label: "Include Search Results",
+      description: "Include the search results in the response",
+      default: false,
+      optional: true,
+    },
+    maxNumResults: {
+      type: "integer",
+      label: "Max Number of Results",
+      description: "Customize the number of results you want to retrieve from the vector store",
+      optional: true,
+    },
+    metadataFiltering: {
+      type: "boolean",
+      label: "Metadata Filtering",
+      description: "Configure how the search results are filtered based on file metadata",
+      optional: true,
+      reloadProps: true,
+    },
+    previousResponseId: {
+      type: "string",
+      label: "Previous Response ID",
+      description: "The unique ID of the previous response to the model. Use this to create multi-turn conversations",
+      optional: true,
+    },
+    truncation: {
+      type: "string",
+      label: "Truncation",
+      description: "Specifies the truncation mode for the response if it's larger than the context window size",
+      optional: true,
+      default: "auto",
+      options: [
+        "auto",
+        "disabled",
+      ],
+    },
+    responseFormat: {
+      type: "string",
+      label: "Response Format",
+      description: "Specify the format that the model must output. \n- **Text**: Returns unstructured text output.\n- **JSON Schema**: Enables you to define a [specific structure for the model's output using a JSON schema](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses).",
+      options: [
+        "text",
+        "json_schema",
+      ],
+      default: "text",
+      optional: true,
+      reloadProps: true,
+    },
+    skipThisStep: {
+      type: "boolean",
+      label: "Skip This Step",
+      description: "Pass in a boolean custom expression to skip this step's execution at runtime",
+      optional: true,
+      default: false,
+    },
+  },
+  additionalProps() {
+    const {
+      modelId,
+      metadataFiltering,
+      responseFormat,
+    } = this;
+    const props = {};
+
+    if (this.openai.isReasoningModel(modelId)) {
+      props.reasoningEffort = {
+        type: "string",
+        label: "Reasoning Effort",
+        description: "Constrains effort on reasoning for reasoning models",
+        optional: true,
+        options: [
+          "low",
+          "medium",
+          "high",
+        ],
+      };
+
+      // aparrently not supported yet as of 12/march/2025
+      // props.generateSummary = {
+      //   type: "string",
+      //   label: "Generate Reasoning Summary",
+      //   description: "A summary of the reasoning performed by the model",
+      //   optional: true,
+      //   options: [
+      //     "concise",
+      //     "detailed",
+      //   ],
+      // };
+    }
+
+    // TODO: make this configuration user-friendly
+    // https://platform.openai.com/docs/guides/retrieval?attributes-filter-example=region#attribute-filtering
+    if (metadataFiltering) {
+      props.filters = {
+        type: "object",
+        label: "Filters",
+        description: "Filter the search results based on file metadata. [See the documentation here](https://platform.openai.com/docs/guides/retrieval#attribute-filtering)",
+      };
+    }
+
+    if (responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      props.jsonSchema = {
+        type: "string",
+        label: "JSON Schema",
+        description: "Define the schema that the model's output must adhere to. [Generate one here](https://platform.openai.com/docs/guides/structured-outputs/supported-schemas).",
+      };
+    }
+
+    return props;
+  },
+  methods: {
+    ...common.methods,
+  },
+  async run({ $ }) {
+    if (this.skipThisStep) {
+      $.export("$summary", "Step execution skipped");
+      return;
+    }
+
+    const data = {
+      model: this.modelId,
+      input: this.input,
+      instructions: this.instructions,
+      previous_response_id: this.previousResponseId,
+      truncation: this.truncation,
+      tools: [
+        {
+          type: "file_search",
+          vector_store_ids: [
+            this.vectorStoreId,
+          ],
+          max_num_results: this.maxNumResults,
+        },
+      ],
+    };
+
+    if (this.includeSearchResults) {
+      data.include = [
+        "output[*].file_search_call.search_results",
+      ];
+    }
+
+    if (this.filters) {
+      data.tools[0].filters = this.filters;
+    }
+
+    if (this.openai.isReasoningModel(this.modelId) && this.reasoningEffort) {
+      data.reasoning = {
+        ...data.reasoning,
+        effort: this.reasoningEffort,
+      };
+    }
+
+    if (this.openai.isReasoningModel(this.modelId) && this.generateSummary) {
+      data.reasoning = {
+        ...data.reasoning,
+        generate_summary: this.generateSummary,
+      };
+    }
+
+    if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      try {
+        data.text = {
+          format: {
+            type: this.responseFormat,
+            ...JSON.parse(this.jsonSchema),
+          },
+        };
+      } catch (error) {
+        throw new Error("Invalid JSON format in the provided JSON Schema");
+      }
+    }
+
+    const response = await this.openai.responses({
+      $,
+      data,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully sent chat with id ${response.id}`);
+      $.export("chat_responses", response.output);
+    }
+
+    return response;
+  },
+};

package/actions/chat-using-functions/chat-using-functions.mjs

@@ -0,0 +1,255 @@
+import openai from "../../openai.app.mjs";
+import common from "../common/common.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  name: "Chat using Functions",
+  version: "0.0.1",
+  key: "openai-chat-using-functions",
+  description: "Chat with your models and allow them to invoke functions. Optionally, you can build and invoke workflows as functions. [See the documentation](https://platform.openai.com/docs/guides/function-calling)",
+  type: "action",
+  props: {
+    openai,
+    alert: {
+      type: "alert",
+      alertType: "info",
+      content: "Provide function names and parameters, and the model will either answer the question directly or decide to invoke one of the functions, returning a function call that adheres to your specified schema. Add a custom code step that includes all available functions which can be invoked based on the model's response - [you can even build an entire workflow as a function](https://pipedream.com/docs/workflows/building-workflows/code/nodejs/#invoke-another-workflow)! Once the appropriate function or workflow is executed, continue the overall execution or pass the result back to the model for further analysis. For more details, [see this guide](https://platform.openai.com/docs/guides/function-calling?api-mode=responses#overview).",
+    },
+    modelId: {
+      propDefinition: [
+        openai,
+        "chatCompletionModelId",
+      ],
+    },
+    input: {
+      type: "string",
+      label: "Chat Input",
+      description: "Text, image, or file inputs to the model, used to generate a response",
+    },
+    functions: {
+      type: "string",
+      label: "Functions",
+      description: "A valid JSON array of functions using OpenAI's function schema definition. [See guide here](https://platform.openai.com/docs/guides/function-calling?api-mode=responses&example=search-knowledge-base#defining-functions).",
+      default:
+`[
+  {
+    "type": "function",
+    "name": "your_function_name",
+    "description": "Details on when and how to use the function",
+    "strict": true,
+    "parameters": {
+      "type": "object",
+      "properties": {
+        "property_name": {
+          "type": "property_type",
+          "description": "A description for this property"
+        },
+        "another_property_name": {
+          "type": "property_type",
+          "description": "A description for this property"
+        }
+      },
+      "required": [
+        "list",
+        "of",
+        "required",
+        "properties",
+        "for",
+        "this",
+        "object"
+      ],
+      "additionalProperties": false
+    }
+  }
+]`,
+    },
+    instructions: {
+      type: "string",
+      label: "Instructions",
+      description: "Inserts a system (or developer) message as the first item in the model's context",
+      optional: true,
+    },
+    toolChoice: {
+      type: "string",
+      label: "Tool Choice",
+      description: "- **auto**: The model decides whether and how many functions to call.\n- **required**: The model must call one or more functions.\n- **function_name**: Enter a custom expression to force the model to call this specific function.",
+      optional: true,
+      default: "auto",
+      options: [
+        "auto",
+        "required",
+      ],
+    },
+    parallelToolCalls: {
+      type: "boolean",
+      label: "Parallel Function Calling",
+      description: "Allow or prevent the model to call multiple functions in a single turn",
+      optional: true,
+      default: true,
+    },
+    previousResponseId: {
+      type: "string",
+      label: "Previous Response ID",
+      description: "The unique ID of the previous response to the model. Use this to create multi-turn conversations",
+      optional: true,
+    },
+    truncation: {
+      type: "string",
+      label: "Truncation",
+      description: "Specifies the truncation mode for the response if it's larger than the context window size",
+      optional: true,
+      default: "auto",
+      options: [
+        "auto",
+        "disabled",
+      ],
+    },
+    responseFormat: {
+      type: "string",
+      label: "Response Format",
+      description: "Specify the format that the model must output. \n- **Text**: Returns unstructured text output.\n- **JSON Schema**: Enables you to define a [specific structure for the model's output using a JSON schema](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses).",
+      options: [
+        "text",
+        "json_schema",
+      ],
+      default: "text",
+      optional: true,
+      reloadProps: true,
+    },
+    skipThisStep: {
+      type: "boolean",
+      label: "Skip This Step",
+      description: "Pass in a boolean custom expression to skip this step's execution at runtime",
+      optional: true,
+      default: false,
+    },
+  },
+  additionalProps() {
+    const {
+      modelId,
+      responseFormat,
+    } = this;
+    const props = {};
+
+    if (this.openai.isReasoningModel(modelId)) {
+      props.reasoningEffort = {
+        type: "string",
+        label: "Reasoning Effort",
+        description: "Constrains effort on reasoning for reasoning models",
+        optional: true,
+        options: [
+          "low",
+          "medium",
+          "high",
+        ],
+      };
+
+      // aparrently not supported yet as of 12/march/2025
+      // props.generateSummary = {
+      //   type: "string",
+      //   label: "Generate Reasoning Summary",
+      //   description: "A summary of the reasoning performed by the model",
+      //   optional: true,
+      //   options: [
+      //     "concise",
+      //     "detailed",
+      //   ],
+      // };
+    }
+
+    if (responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      props.jsonSchema = {
+        type: "string",
+        label: "JSON Schema",
+        description: "Define the schema that the model's output must adhere to. [Generate one here](https://platform.openai.com/docs/guides/structured-outputs/supported-schemas).",
+      };
+    }
+
+    return props;
+  },
+  methods: {
+    ...common.methods,
+  },
+  async run({ $ }) {
+    if (this.skipThisStep) {
+      $.export("$summary", "Step execution skipped");
+      return;
+    }
+
+    const data = {
+      model: this.modelId,
+      input: this.input,
+      instructions: this.instructions,
+      previous_response_id: this.previousResponseId,
+      truncation: this.truncation,
+      parallel_tool_calls: this.parallelToolCalls,
+      tools: [],
+    };
+
+    let functions = this.functions;
+    if (typeof functions === "string") {
+      try {
+        functions = JSON.parse(functions);
+      } catch (error) {
+        throw new Error("Invalid JSON format in the provided Functions Schema");
+      }
+    }
+
+    if (Array.isArray(functions)) {
+      data.tools.push(...functions);
+    } else {
+      data.tools.push(functions);
+    }
+
+    if (this.toolChoice) {
+      if (this.toolChoice === "auto" || this.toolChoice === "required") {
+        data.tool_choice = this.toolChoice;
+      } else {
+        data.tool_choice = {
+          type: "function",
+          name: this.toolChoice,
+        };
+      }
+    }
+
+    if (this.openai.isReasoningModel(this.modelId) && this.reasoningEffort) {
+      data.reasoning = {
+        ...data.reasoning,
+        effort: this.reasoningEffort,
+      };
+    }
+
+    if (this.openai.isReasoningModel(this.modelId) && this.generateSummary) {
+      data.reasoning = {
+        ...data.reasoning,
+        generate_summary: this.generateSummary,
+      };
+    }
+
+    if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      try {
+        data.text = {
+          format: {
+            type: this.responseFormat,
+            ...JSON.parse(this.jsonSchema),
+          },
+        };
+      } catch (error) {
+        throw new Error("Invalid JSON format in the provided JSON Schema");
+      }
+    }
+
+    const response = await this.openai.responses({
+      $,
+      data,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully sent chat with id ${response.id}`);
+      $.export("chat_responses", response.output);
+    }
+
+    return response;
+  },
+};