@n8n/n8n-nodes-langchain 1.117.0 → 1.118.0

package/dist/nodes/llms/LMChatOpenAi/LmChatOpenAi.node.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var LmChatOpenAi_node_exports = {};
 __export(LmChatOpenAi_node_exports, {
@@ -22,13 +32,49 @@ __export(LmChatOpenAi_node_exports, {
 });
 module.exports = __toCommonJS(LmChatOpenAi_node_exports);
 var import_openai = require("@langchain/openai");
+var import_pick = __toESM(require("lodash/pick"));
 var import_n8n_workflow = require("n8n-workflow");
 var import_httpProxyAgent = require("../../../utils/httpProxyAgent");
 var import_sharedFields = require("../../../utils/sharedFields");
-var import_loadModels = require("./methods/loadModels");
 var import_error_handling = require("../../vendors/OpenAi/helpers/error-handling");
 var import_n8nLlmFailedAttemptHandler = require("../n8nLlmFailedAttemptHandler");
 var import_N8nLlmTracing = require("../N8nLlmTracing");
+var import_common = require("./common");
+var import_loadModels = require("./methods/loadModels");
+const INCLUDE_JSON_WARNING = {
+  displayName: 'If using JSON response format, you must include word "json" in the prompt in your chain or agent. Also, make sure to select latest models released post November 2023.',
+  name: "notice",
+  type: "notice",
+  default: ""
+};
+const completionsResponseFormat = {
+  displayName: "Response Format",
+  name: "responseFormat",
+  default: "text",
+  type: "options",
+  options: [
+    {
+      name: "Text",
+      value: "text",
+      description: "Regular text response"
+    },
+    {
+      name: "JSON",
+      value: "json_object",
+      description: "Enables JSON mode, which should guarantee the message the model generates is valid JSON"
+    }
+  ]
+};
+const jsonSchemaExample = `{
+  "type": "object",
+  "properties": {
+    "message": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["message"]
+}`;
 class LmChatOpenAi {
   constructor() {
     this.methods = {
@@ -41,7 +87,7 @@ class LmChatOpenAi {
       name: "lmChatOpenAi",
       icon: { light: "file:openAiLight.svg", dark: "file:openAiLight.dark.svg" },
       group: ["transform"],
-      version: [1, 1.1, 1.2],
+      version: [1, 1.1, 1.2, 1.3],
       description: "For advanced usage with an AI chain",
       defaults: {
         name: "OpenAI Chat Model"
@@ -76,16 +122,21 @@ class LmChatOpenAi {
       properties: [
         (0, import_sharedFields.getConnectionHintNoticeField)([import_n8n_workflow.NodeConnectionTypes.AiChain, import_n8n_workflow.NodeConnectionTypes.AiAgent]),
         {
-          displayName: 'If using JSON response format, you must include word "json" in the prompt in your chain or agent. Also, make sure to select latest models released post November 2023.',
-          name: "notice",
-          type: "notice",
-          default: "",
+          ...INCLUDE_JSON_WARNING,
           displayOptions: {
             show: {
               "/options.responseFormat": ["json_object"]
             }
           }
         },
+        {
+          ...INCLUDE_JSON_WARNING,
+          displayOptions: {
+            show: {
+              "/options.textFormat.textOptions.type": ["json_object"]
+            }
+          }
+        },
         {
           displayName: "Model",
           name: "model",
@@ -193,6 +244,118 @@ class LmChatOpenAi {
             }
           }
         },
+        {
+          displayName: "Use Responses API",
+          name: "responsesApiEnabled",
+          type: "boolean",
+          default: true,
+          description: 'Whether to use the Responses API to generate the response. <a href="https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/#use-responses-api">Learn more</a>.',
+          displayOptions: {
+            show: {
+              "@version": [{ _cnd: { gte: 1.3 } }]
+            }
+          }
+        },
+        {
+          displayName: "Built-in Tools",
+          name: "builtInTools",
+          placeholder: "Add Built-in Tool",
+          type: "collection",
+          default: {},
+          options: [
+            {
+              displayName: "Web Search",
+              name: "webSearch",
+              type: "collection",
+              default: { searchContextSize: "medium" },
+              options: [
+                {
+                  displayName: "Search Context Size",
+                  name: "searchContextSize",
+                  type: "options",
+                  default: "medium",
+                  description: "High level guidance for the amount of context window space to use for the search",
+                  options: [
+                    { name: "Low", value: "low" },
+                    { name: "Medium", value: "medium" },
+                    { name: "High", value: "high" }
+                  ]
+                },
+                {
+                  displayName: "Web Search Allowed Domains",
+                  name: "allowedDomains",
+                  type: "string",
+                  default: "",
+                  description: "Comma-separated list of domains to search. Only domains in this list will be searched.",
+                  placeholder: "e.g. google.com, wikipedia.org"
+                },
+                {
+                  displayName: "Country",
+                  name: "country",
+                  type: "string",
+                  default: "",
+                  placeholder: "e.g. US, GB"
+                },
+                {
+                  displayName: "City",
+                  name: "city",
+                  type: "string",
+                  default: "",
+                  placeholder: "e.g. New York, London"
+                },
+                {
+                  displayName: "Region",
+                  name: "region",
+                  type: "string",
+                  default: "",
+                  placeholder: "e.g. New York, London"
+                }
+              ]
+            },
+            {
+              displayName: "File Search",
+              name: "fileSearch",
+              type: "collection",
+              default: { vectorStoreIds: "[]" },
+              options: [
+                {
+                  displayName: "Vector Store IDs",
+                  name: "vectorStoreIds",
+                  description: 'The vector store IDs to use for the file search. Vector stores are managed via OpenAI Dashboard. <a href="https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/#built-in-tools">Learn more</a>.',
+                  type: "json",
+                  default: "[]",
+                  required: true
+                },
+                {
+                  displayName: "Filters",
+                  name: "filters",
+                  type: "json",
+                  default: "{}"
+                },
+                {
+                  displayName: "Max Results",
+                  name: "maxResults",
+                  type: "number",
+                  default: 1,
+                  typeOptions: { minValue: 1, maxValue: 50 }
+                }
+              ]
+            },
+            {
+              displayName: "Code Interpreter",
+              name: "codeInterpreter",
+              type: "boolean",
+              default: true,
+              description: "Whether to allow the model to execute code in a sandboxed environment"
+            }
+          ],
+          displayOptions: {
+            show: {
+              "@version": [{ _cnd: { gte: 1.3 } }],
+              "/responsesApiEnabled": [true]
+            }
+          }
+        },
         {
           displayName: "Options",
           name: "options",
@@ -231,23 +394,124 @@ class LmChatOpenAi {
                 maxValue: 32768
               }
             },
+            {
+              ...completionsResponseFormat,
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { lt: 1.3 } }]
+                }
+              }
+            },
+            {
+              ...completionsResponseFormat,
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [false]
+                }
+              }
+            },
             {
               displayName: "Response Format",
-              name: "responseFormat",
-              default: "text",
-              type: "options",
+              name: "textFormat",
+              type: "fixedCollection",
+              default: { textOptions: [{ type: "text" }] },
               options: [
                 {
-                  name: "Text",
-                  value: "text",
-                  description: "Regular text response"
-                },
-                {
-                  name: "JSON",
-                  value: "json_object",
-                  description: "Enables JSON mode, which should guarantee the message the model generates is valid JSON"
+                  displayName: "Text",
+                  name: "textOptions",
+                  values: [
+                    {
+                      displayName: "Type",
+                      name: "type",
+                      type: "options",
+                      default: "",
+                      options: [
+                        { name: "Text", value: "text" },
+                        // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                        { name: "JSON Schema (recommended)", value: "json_schema" },
+                        { name: "JSON Object", value: "json_object" }
+                      ]
+                    },
+                    {
+                      displayName: "Verbosity",
+                      name: "verbosity",
+                      type: "options",
+                      default: "medium",
+                      options: [
+                        { name: "Low", value: "low" },
+                        { name: "Medium", value: "medium" },
+                        { name: "High", value: "high" }
+                      ]
+                    },
+                    {
+                      displayName: "Name",
+                      name: "name",
+                      type: "string",
+                      default: "my_schema",
+                      description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
+                      displayOptions: {
+                        show: {
+                          type: ["json_schema"]
+                        }
+                      }
+                    },
+                    {
+                      displayName: 'All properties in the schema must be set to "required", when using "strict" mode.',
+                      name: "requiredNotice",
+                      type: "notice",
+                      default: "",
+                      displayOptions: {
+                        show: {
+                          strict: [true]
+                        }
+                      }
+                    },
+                    {
+                      displayName: "Schema",
+                      name: "schema",
+                      type: "json",
+                      default: jsonSchemaExample,
+                      description: "The schema of the response format",
+                      displayOptions: {
+                        show: {
+                          type: ["json_schema"]
+                        }
+                      }
+                    },
+                    {
+                      displayName: "Description",
+                      name: "description",
+                      type: "string",
+                      default: "",
+                      description: "The description of the response format",
+                      displayOptions: {
+                        show: {
+                          type: ["json_schema"]
+                        }
+                      }
+                    },
+                    {
+                      displayName: "Strict",
+                      name: "strict",
+                      type: "boolean",
+                      default: false,
+                      description: "Whether to require that the AI will always generate responses that match the provided JSON Schema",
+                      displayOptions: {
+                        show: {
+                          type: ["json_schema"]
+                        }
+                      }
+                    }
+                  ]
                 }
-              ]
+              ],
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
             },
             {
               displayName: "Presence Penalty",
@@ -316,6 +580,136 @@ class LmChatOpenAi {
               typeOptions: { maxValue: 1, minValue: 0, numberPrecision: 1 },
               description: "Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.",
               type: "number"
+            },
+            {
+              displayName: "Conversation ID",
+              name: "conversationId",
+              default: "",
+              description: "The conversation that this response belongs to. Input items and output items from this response are automatically added to this conversation after this response completes.",
+              type: "string",
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
+            },
+            {
+              displayName: "Prompt Cache Key",
+              name: "promptCacheKey",
+              type: "string",
+              default: "",
+              description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates",
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
+            },
+            {
+              displayName: "Safety Identifier",
+              name: "safetyIdentifier",
+              type: "string",
+              default: "",
+              description: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user.",
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
+            },
+            {
+              displayName: "Service Tier",
+              name: "serviceTier",
+              type: "options",
+              default: "auto",
+              description: "The service tier to use for the request",
+              options: [
+                { name: "Auto", value: "auto" },
+                { name: "Flex", value: "flex" },
+                { name: "Default", value: "default" },
+                { name: "Priority", value: "priority" }
+              ],
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
+            },
+            {
+              displayName: "Metadata",
+              name: "metadata",
+              type: "json",
+              description: "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.",
+              default: "{}",
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
+            },
+            {
+              displayName: "Top Logprobs",
+              name: "topLogprobs",
+              type: "number",
+              default: 0,
+              description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability",
+              typeOptions: {
+                minValue: 0,
+                maxValue: 20
+              },
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
+            },
+            {
+              displayName: "Prompt",
+              name: "promptConfig",
+              type: "fixedCollection",
+              description: 'Configure the reusable prompt template configured via OpenAI Dashboard. <a href="https://platform.openai.com/docs/guides/prompt-engineering#reusable-prompts">Learn more</a>.',
+              default: { promptOptions: [{ promptId: "" }] },
+              options: [
+                {
+                  displayName: "Prompt",
+                  name: "promptOptions",
+                  values: [
+                    {
+                      displayName: "Prompt ID",
+                      name: "promptId",
+                      type: "string",
+                      default: "",
+                      description: "The unique identifier of the prompt template to use"
+                    },
+                    {
+                      displayName: "Version",
+                      name: "version",
+                      type: "string",
+                      default: "",
+                      description: "Optional version of the prompt template"
+                    },
+                    {
+                      displayName: "Variables",
+                      name: "variables",
+                      type: "json",
+                      default: "{}",
+                      description: "Variables to be substituted into the prompt template"
+                    }
+                  ]
+                }
+              ],
+              displayOptions: {
+                show: {
+                  "@version": [{ _cnd: { gte: 1.3 } }],
+                  "/responsesApiEnabled": [true]
+                }
+              }
             }
           ]
         }
@@ -326,6 +720,7 @@ class LmChatOpenAi {
     const credentials = await this.getCredentials("openAiApi");
     const version = this.getNode().typeVersion;
     const modelName = version >= 1.2 ? this.getNodeParameter("model.value", itemIndex) : this.getNodeParameter("model", itemIndex);
+    const responsesApiEnabled = this.getNodeParameter("responsesApiEnabled", itemIndex, false);
     const options = this.getNodeParameter("options", itemIndex, {});
     const configuration = {};
     if (options.baseURL) {
@@ -344,20 +739,49 @@ class LmChatOpenAi {
       };
     }
     const modelKwargs = {};
-    if (options.responseFormat) modelKwargs.response_format = { type: options.responseFormat };
-    if (options.reasoningEffort && ["low", "medium", "high"].includes(options.reasoningEffort))
-      modelKwargs.reasoning_effort = options.reasoningEffort;
-    const model = new import_openai.ChatOpenAI({
+    if (responsesApiEnabled) {
+      const kwargs = (0, import_common.prepareAdditionalResponsesParams)(options);
+      Object.assign(modelKwargs, kwargs);
+    } else {
+      if (options.responseFormat) modelKwargs.response_format = { type: options.responseFormat };
+      if (options.reasoningEffort && ["low", "medium", "high"].includes(options.reasoningEffort)) {
+        modelKwargs.reasoning_effort = options.reasoningEffort;
+      }
+    }
+    const includedOptions = (0, import_pick.default)(options, [
+      "frequencyPenalty",
+      "maxTokens",
+      "presencePenalty",
+      "temperature",
+      "topP",
+      "baseURL"
+    ]);
+    const fields = {
       apiKey: credentials.apiKey,
       model: modelName,
-      ...options,
+      ...includedOptions,
       timeout: options.timeout ?? 6e4,
       maxRetries: options.maxRetries ?? 2,
       configuration,
       callbacks: [new import_N8nLlmTracing.N8nLlmTracing(this)],
       modelKwargs,
       onFailedAttempt: (0, import_n8nLlmFailedAttemptHandler.makeN8nLlmFailedAttemptHandler)(this, import_error_handling.openAiFailedAttemptHandler)
-    });
+    };
+    if (responsesApiEnabled) {
+      fields.useResponsesApi = true;
+    }
+    const model = new import_openai.ChatOpenAI(fields);
+    if (responsesApiEnabled) {
+      const tools = (0, import_common.formatBuiltInTools)(
+        this.getNodeParameter("builtInTools", itemIndex, {})
+      );
+      if (tools.length) {
+        model.metadata = {
+          ...model.metadata,
+          tools
+        };
+      }
+    }
     return {
       response: model
     };