Skip to content

OpenAI Text 操作#

使用此操作向模型发送消息或对 OpenAI 中的文本进行违规分类。有关 OpenAI 节点本身的更多信息,请参考 OpenAI。

旧版本节点

n8n 版本 1.117.0 引入了支持 OpenAI Responses API 的 OpenAI 节点 V2。它将"Message a Model"操作重命名为"Generate a Chat Completion",以阐明其与 Chat Completions API 的关联,并引入了使用 Responses API 的单独"Generate a Model Response"操作。

Generate a Chat Completion 生成聊天完成#

使用此操作向 OpenAI 模型发送消息或提示 - 使用 Chat Completions API - 并接收响应。

输入这些参数：

  • Credential to connect with 连接凭据：创建或选择现有的 OpenAI 凭据。
  • Resource 资源：选择 Text 文本。
  • Operation 操作：选择 Generate a Chat Completion 生成聊天完成。
  • Model 模型：选择你想要使用的模型。如果你不确定使用哪个模型,如果需要高智能,请尝试 gpt-4o,如果需要最快速度和最低成本,请尝试 gpt-4o-mini。有关更多信息,请参考 Models overview | OpenAI Platform。
  • Messages 消息：输入 Text 文本提示并分配模型将用于生成响应的 Role 角色。有关如何通过使用这些角色编写更好的提示的更多信息,请参考 Prompt engineering | OpenAI。从以下角色中选择一个：
    • User 用户：以用户身份发送消息并从模型获取响应。
    • Assistant 助手：告诉模型采用特定的语气或个性。
    • System 系统：默认情况下,没有系统消息。你可以在用户消息中定义指令,但在系统消息中设置的指令更有效。你可以为每个对话设置多个系统消息。使用此选项为下一条用户消息设置模型的行为或上下文。
  • Simplify Output 简化输出：开启以返回响应的简化版本而不是原始数据。
  • Output Content as JSON 输出内容为 JSON：开启以尝试以 JSON 格式返回响应。与 GPT-4 Turbo 和所有比 gpt-3.5-turbo-1106 更新的 GPT-3.5 Turbo 模型兼容。

Options 选项#

  • Frequency Penalty 频率惩罚：应用惩罚以减少模型重复类似行的倾向。范围在 0.0 到 2.0 之间。
  • Maximum Number of Tokens 最大令牌数：设置响应的最大令牌数。对于标准英文文本,一个令牌大约是四个字符。使用此选项限制输出的长度。
  • Number of Completions 完成数量：默认为 1。设置要为每个提示生成的完成数量。请谨慎使用,因为设置较高的数字会快速消耗你的令牌。
  • Presence Penalty 存在惩罚：应用惩罚以影响模型讨论新主题。范围在 0.0 到 2.0 之间。
  • Output Randomness (Temperature) 输出随机性（温度）：调整响应的随机性。范围在 0.0（确定性）到 1.0（最大随机性）之间。我们建议更改此选项或 Output Randomness (Top P) 输出随机性（Top P）,但不要同时更改两者。从中等温度（大约 0.7）开始,并根据观察到的输出进行调整。如果响应过于重复或僵硬,请提高温度。如果它们过于混乱或偏离轨道,请降低温度。默认为 1.0。
  • Output Randomness (Top P) 输出随机性（Top P）：调整 Top P 设置以控制助手响应的多样性。例如,0.5 表示考虑所有可能性加权选项的一半。我们建议更改此选项或 Output Randomness (Temperature) 输出随机性（温度）,但不要同时更改两者。默认为 1.0。

有关更多信息,请参考 Chat Completions | OpenAI 文档。

Generate a Model Response 生成模型响应#

使用此操作向 OpenAI 模型发送消息或提示 - 使用 Responses API - 并接收响应。

输入这些参数：

  • Credential to connect with 连接凭据：创建或选择现有的 OpenAI 凭据。
  • Resource 资源：选择 Text 文本。
  • Operation 操作：选择 Generate a Model Response 生成模型响应。
  • Model 模型：选择你想要使用的模型。有关概述,请参考 Models overview | OpenAI Platform。
  • Messages 消息：从以下 Message Types 消息类型中选择一个：
    • Text 文本：输入 Text 文本提示并分配模型将用于生成响应的 Role 角色。有关如何通过使用这些角色编写更好的提示的更多信息,请参考 Prompt engineering | OpenAI。
    • Image 图像：通过 Image URL、File ID（使用 OpenAI Files API）或从工作流中较早节点传递二进制数据来提供 Image 图像。
    • File 文件：以支持的格式（目前：仅 PDF）提供 File 文件,通过 File URL、File ID（使用 OpenAI Files API）或从工作流中较早节点传递二进制数据。
    • 对于任何消息类型,你可以从以下角色中选择一个：
      • User 用户：以用户身份发送消息并从模型获取响应。
      • Assistant 助手：告诉模型采用特定的语气或个性。
      • System 系统：默认情况下,系统消息是 "You are a helpful assistant"。你可以在用户消息中定义指令,但在系统消息中设置的指令更有效。你只能为每个对话设置一个系统消息。使用此选项为下一条用户消息设置模型的行为或上下文。
  • Simplify Output 简化输出：开启以返回响应的简化版本而不是原始数据。

Built-in Tools 内置工具#

OpenAI Responses API 提供了一系列内置工具来丰富模型的响应：

  • Web Search 网络搜索：允许模型在生成响应之前搜索网络以获取最新信息。
  • MCP Servers MCP 服务器：允许模型连接到远程 MCP 服务器。在这里了解有关使用远程 MCP 服务器作为工具的更多信息。
  • File Search 文件搜索：允许模型在生成响应之前从先前上传的文件搜索知识库中的相关信息。有关更多信息,请参考 OpenAI 文档。
  • Code Interpreter 代码解释器：允许模型在沙盒环境中编写和运行 Python 代码。

Options 选项#

  • Maximum Number of Tokens 最大令牌数：设置响应的最大令牌数。对于标准英文文本,一个令牌大约是四个字符。使用此选项限制输出的长度。
  • Output Randomness (Temperature) 输出随机性（温度）：调整响应的随机性。范围在 0.0（确定性）到 1.0（最大随机性）之间。我们建议更改此选项或 Output Randomness (Top P) 输出随机性（Top P）,但不要同时更改两者。从中等温度（大约 0.7）开始,并根据观察到的输出进行调整。如果响应过于重复或僵硬,请提高温度。如果它们过于混乱或偏离轨道,请降低温度。默认为 1.0。
  • Output Randomness (Top P) 输出随机性（Top P）：调整 Top P 设置以控制助手响应的多样性。例如,0.5 表示考虑所有可能性加权选项的一半。我们建议更改此选项或 Output Randomness (Temperature) 输出随机性（温度）,但不要同时更改两者。默认为 1.0。
  • Conversation ID 对话 ID：此响应所属的对话。此响应完成后,此响应的输入项和输出项将自动添加到此对话中。
  • Previous Response ID 上一个响应 ID：要继续的上一个响应的 ID。不能与 Conversation ID 一起使用。
  • Reasoning 推理：模型生成响应应花费的推理努力级别。包括返回模型执行的推理的 Summary 摘要的能力（例如,用于调试目的）。
  • Store 存储：是否存储生成的模型响应以供稍后通过 API 检索。默认为 true。
  • Output Format 输出格式：是否将响应返回为 Text 文本、指定的 JSON Schema JSON 架构或 JSON Object JSON 对象。
  • Background 后台：是否在后台模式下运行模型。这允许更可靠地执行长时间运行的任务。

有关更多信息,请参考 Responses | OpenAI 文档。

Classify Text for Violations 分类文本违规#

使用此操作识别和标记可能有害的内容。OpenAI 模型将分析文本并返回包含以下内容的响应：

  • flagged：一个布尔字段，指示内容是否可能有害。
  • categories：特定类别违规标志的列表。
  • category_scores：每个类别的分数。

输入这些参数：

  • Credential to connect with 连接凭据：创建或选择现有的 OpenAI 凭据。
  • Resource 资源：选择 Text 文本。
  • Operation 操作：选择 Classify Text for Violations 分类文本违规。
  • Text Input 文本输入：输入要分类的文本以检查是否违反审核政策。
  • Simplify Output 简化输出：开启以返回响应的简化版本而不是原始数据。

Options 选项#

  • Use Stable Model 使用稳定模型：开启以使用模型的稳定版本而不是最新版本，准确性可能会稍微降低。

请参阅 审核 | OpenAI 文档了解更多信息。

常见问题#

有关常见错误或问题以及建议的解决步骤，请参阅 常见问题。