> ## Documentation Index > Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt > Use this file to discover all available pages before exploring further. # AI 端口 > 通过 REST API 连接到 AI 模型，使用可配置的提示词处理消息，并在数据流中生成结构化输出。 AI 端口旨在连接到一系列提供 REST API 的 AI 模型。支持的列表见[下方](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/ai.md#ai-配置页面)。 ## 核心功能 * 多供应商 AI 集成 * 灵活的提示词工程（Prompt Engineering） * 可自定义的 AI 模型选择 * 结构化输出控制 * 智能内容处理 ## 概述 知行之桥 AI 端口是一个灵活的集成工具，通过 REST API 连接到任何 AI 模型，能够使用可配置的系统提示词和用户提示词处理输入消息，从而在工作流中生成结构化输出。它支持流行的 AI 服务，如 OpenAI、Gemini、Ollama 以及其他兼容 OpenAI 的供应商，并能完全控制 API 端点、模型和参数。通过支持 ArcScript 的提示词和可自定义的输出格式，该端口支持多种使用场景，例如从非结构化反馈中提取见解、跨语言翻译内容以及将文本数据转换为可操作的结构化信息。 ### 操作 此端口可以执行三种端口操作类型中的任何一种： • *触发* 按计划执行一个 request ，并且可能会生成要沿着工作流发送的文件。此操作充当工作流的起点。 • *转换* 接受来自工作流的消息作为 request 的输入并生成输出。此操作充当工作流的中间部分。 • *终结* 接受来自工作流的消息作为 request 的输入并充当工作流的终点。 ## 端口配置 本节包含所有可配置的端口属性。 ### AI 配置页面 如果尚未在 **设置 > 高级 > AI 设置** 中配置全局 AI 设置，**AI 配置** 页面将显示一条消息，提示必须先完成此配置才能使用该端口。点击 **配置 AI 设置** 按钮，并按照 [AI 设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/ai-settings.md) 中的说明进行操作。如果全局设置已配置，但想在此端口中覆盖这些设置，请点击 **编辑**。要覆盖全局设置，请开启 **覆盖全局设置** 切换开关。现在可以选择要使用的 AI 供应商，输入相应的连接详细信息并保存配置。该端口支持以下供应商： * Claude * Deepseek * Gemini * Grok * Ollama（云端和本地） * OpenAI * OpenAI Compatible（任何实现 OpenAI API 的 AI 供应商） 使用 **编辑 AI 设置** 面板定义 **基地址 (Base URL)**（仅当供应商为 **Ollama** 或 **OpenAI Compatible** 时可用），添加供应商的 **API Key**，并选择 **模型**。 要填充 **用户提示词** 字段，可以点击 **推荐提示词** 查看针对各种场景预定义的一组提示词，也可以直接在字段中输入自己的提示词。这是定义在接收到文件时希望端口执行的任务或请求的地方。例如，可以输入类似 *使用自然语言总结入站的 EDI X12 文件* 的内容，以便不熟悉 EDI X12 结构的员工能够阅读摘要并了解文档包含的信息。此字段支持 ArcScript。 还可以选择 **将输入消息附加到请求**。当向 AI 供应商提供二进制文件（如 PDF 或图像）时，这尤其有用。 要在请求中包含非二进制文件，需要在提示词中使用 `_message.body`，如下所示： ``` [_message.body] ``` > [!NOTE] > > 如需完整示例，请查看 **推荐提示词** 下拉列表中的“总结”选项。 开启 **系统提示词** 以提供一组特定的指令、约束、语言或角色，供 AI 供应商在提供响应时使用。例如：*在回答中不要使用任何破折号或表情符号。* 此字段同样支持 ArcScript。 测试配置和提示词的方式取决于端口的[操作类型](#操作)： * 如果端口是触发端口，点击 **测试** 按钮。 * 如果端口是转换或终结端口，在 **测试** 页面上，将内容粘贴到 **输入正文** 中，或使用下拉列表添加 **请求头** 和值，然后点击 **测试** 按钮。 在这两种情况下，测试结果都会显示在 **测试** 页面中。测试日志显示在 **日志** 页面中。 ### 设置页面 *与端口核心配置相关的设置。* #### 配置 | 设置 | 说明 | | - | - | | **端口 Id** | 端口的静态唯一标识符。 | | **端口类型** | 显示端口名称及其功能说明。 | | **端口描述** | 可选字段，用于以自由文本形式描述端口及其在工作流中的角色。 | | **操作** | 此端口执行的操作：触发、转换或终结。 | | **输出为 JSON** | 如果模型支持结构化输出，勾选此项以 JSON 格式交付端口输出。当希望确保 AI 输出是结构化且机器可读的，以便更容易解析、提取数据或用于下游端口和流程时，这非常有用。 | #### 高级设置 | 设置 | 说明 | | - | - | | **本地文件方案** | 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符和时间戳等信息。有关更多信息，请参阅[宏](#宏)。 | ### 高级页面 #### 其他设置 | 设置 | 说明 | | - | - | | **超时时间** | AI 响应超时时间（秒）。默认情况下，此值设置为 60 秒。 | #### 代理设置 这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 [安全设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 页面的 [代理设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/proxy-settings.md) 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。
设置描述
**代理类型** 基于代理的防火墙使用的协议。
**代理主机** 基于代理的防火墙的名称或 IP 地址。
**代理端口** 基于代理的防火墙的 TCP 端口。
**代理用户** 用于通过基于代理的防火墙进行身份验证的用户名。
**代理密码** 用于对基于代理的防火墙进行身份验证的密码。
**身份验证方案** 保留默认值 **None** 或选择以下身份验证方案之一：**Basic**、**Digest**、**Proprietary** 或 **NTLM**。
#### 消息 *消息设置确定端口如何搜索消息并在处理后管理它们。* **注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。
设置描述
**保存到已发送文件夹**（已弃用） 将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受[静态加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保护。
**已发送文件夹方案**（已弃用） 按所选时间间隔对 **Sent** 文件夹中的文件进行分组。仅在启用**保存到已发送文件夹**时适用。
#### 日志 *用于管理日志创建和存储的设置。*
设置 描述
**日志级别** 指定要记录在端口日志目录中的信息类型：
  • **None** - 不创建任何日志。
  • **Error** - 仅当端口遇到错误时才创建日志。
  • **Warning** - 仅当端口发出警告时才创建日志。
  • **Info** - 记录工作流的一般信息，包括任何错误和警告（如果适用）。
  • **Debug** - 记录成功和失败工作流的详细调试信息。
  • **Trace** - 记录成功和失败工作流的详细跟踪信息。
\*\*请注意：\*\***Debug** 和 **Trace** 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。
**日志文件夹结构** 指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。
**保留消息副本** 指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。
#### 其他 *特殊设置适用于特定用例。*
设置 描述
**其他设置** 允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。
### 自动化页面 #### 自动化设置 *与端口自动处理文件相关的设置。* | 设置 | 说明 | | - | - | | **发送** | 到达端口的文件是否自动上传。 | | **重试间隔** | 失败上传重试前的时间间隔。 | | **最大尝试次数** | 端口处理输入文件的最大次数。成功与否基于服务器的成功确认。如果设置为 0，端口将无限次重试文件。 | | **接收** | 端口是否应自动轮询远程下载路径以获取待下载文件。 | | **间隔** | 自动下载尝试之间的时间间隔。 | | **整点后的分钟数** | 小时计划的分钟偏移量。仅当上方的间隔设置为 *每小时* 时适用。例如，如果该值设置为 5，自动化服务将在 1:05、2:05、3:05 等时间下载。 | | **时间** | 尝试发生的一天中的具体时间。仅当上方的间隔设置为 *每天*、*每周* 或 *每月* 时适用。 | | **日期** | 尝试发生的日期。仅当上方的间隔设置为 *每周* 或 *每月* 时适用。 | | **分钟** | 尝试下载前等待的分钟数。仅当上方的间隔设置为 *分钟* 时适用。 | | **Cron 表达式** | 一个五段字符串，表示用于确定尝试发生时间的 cron 表达式。仅当上方的间隔设置为 *高级* 时适用。 | | **开始日期和时间** | 自动化首次运行的日期和时间。之后的每次运行都遵循上方的间隔设置。上次和下次运行时间显示在 [自动化状态](#自动化状态) 部分中。 | #### 自动化状态 *只读摘要，显示自动化是否正在运行、上次运行的结果以及下次运行的时间。* **自动化状态**卡片显示在 **自动化** 选项卡的 **启用** 复选框下方，适用于 **接收**、**下载** 和 **定时发送** 自动化。该卡片回答三个问题：自动化是否已运行、运行是否成功，以及下次运行的时间。 在保存端口之前，当您更改 **启用** 复选框，或者更改 **间隔** 或 **开始日期和时间** 设置时，卡片会随之更新。 ![自动化选项卡上的自动化状态卡片，显示已暂停状态、失败的上次处理结果以及下次运行时间](https://docs.kasoftware.com/26.4/images/automation-status-card.png) 状态 端口自动化的当前状态。
状态 描述
**进行中** 当前有一次运行正在进行，或者其他实例已锁定该计划时段。
**空闲** 自动化正在等待下一次计划运行。
**已暂停** 端口在多次运行失败后处于[退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)状态，自动化服务会跳过该端口。
**已禁用** 该端口的自动化已关闭。
上次运行时间 最近一次运行的结果。
字段 描述
**日期** 上次运行的计划时间。
**上次处理开始时间** 端口实际开始处理上次运行的时间。该时间可能略晚于计划时间。
**上次处理结果** 上次运行的结果：
  • **成功**：运行已完成并处理了数据。
  • **无数据**：运行已完成，但没有需要处理的内容，例如查询未返回任何行。
  • **失败**：运行未完成。
**上次成功时间** 最近一次成功运行的日期和时间。当上次运行失败或未返回数据时，会显示此字段，以便您了解端口已有多长时间未成功运行。
下次运行时间 **日期** 字段显示自动化下一次计划运行的时间。自动化禁用时，该字段为空。 查看详情 **已暂停** 状态、**失败** 结果和 **无数据** 结果都包含一个 **查看详情** 链接，单击后会打开一个显示完整消息的对话框： 未运行与无数据 该卡片会区分尚未运行的端口与已运行但未找到任何内容的端口。如果 **上次处理结果** 为空，说明自动化尚未运行，请检查 **下次运行时间** 和计划设置。如果结果为 **无数据**，说明自动化已按计划运行，但数据源未返回任何内容，请检查数据源中是否有新数据。 已禁用的端口 已禁用的端口会保留其上次运行信息，因此您仍可以查看其上次运行的时间及结果。只有 **下次运行时间** 会被清除。 ### 警报页面 *与配置通知相关的设置。* 在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 选项卡上的全局设置。要为此端口使用其他设置，请启用 **覆盖全局设置**。 默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 **启用** 复选框。 输入 **主题**（必填）。勾选**允许在主题中使用 ArcScript**，即可在**主题**字段中使用 ArcScript。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。 （可选）输入以逗号分隔的**收件人**电子邮件地址列表。 ### SLA 页面 *与配置服务级别协议 (SLA) 相关的设置。* SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥 会发送电子邮件警告用户，并将 SLA 标记为 *存在风险*，这意味着如果 SLA 未能尽快达到，则会被标记为 *已违反*。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。 SLA 转换为 *存在风险* 或 *已违反* 状态时，也会写入[应用程序日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，这意味着应用性能监控 (APM) 和日志采集工具也可以针对这些状态发出警报。 要定义 SLA，请启用 **预期数据量**，然后点击 **设置** 选项卡。 ![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png) 以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。 ![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png) > [!NOTE] > > 如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 **设置**，然后跳转到 **通知 > 通用通知**。点击平板和铅笔图标进行编辑，并取消勾选 **SLA 通知** 设置。 ### 交易页面 此页面列出了与该端口关联的所有消息。使用搜索栏查找特定消息，或点击漏斗图标应用过滤器。可以按时间、消息方向和/或状态进行过滤。 此页面上的选项因端口的[操作类型](#操作)而异： * 如果端口是 **触发** 端口，使用 **接收文件** 按钮开始工作流。 * 如果端口是 **转换** 或 **终结** 端口，使用 **上传文件** 按钮将文件上传到工作流。 ## 宏 在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。 知行之桥 支持这些宏，它们都使用以下语法：`%Macro%`。
宏描述
ConnectorID替换为端口的 ConnectorID。
ConnectorName替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。
Ext替换为端口当前正在处理的文件的文件扩展名。
Filename替换为端口当前正在处理的文件的文件名（包括扩展名）。
FilenameNoExt替换为端口当前正在处理的文件的文件名（不带扩展名）。
MessageId计算端口输出的消息的 MessageId。
RegexFilename:*pattern*将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:*headername*替换为端口正在处理的当前消息的目标消息头（`headername`）的值。
LongDate以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。
ShortDate以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。
DateFormat:*format*以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。
Vault:*vaultitem*计算指定保管库项目的值。
### 示例 某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：`%Macro:argument%` 以下是带有参数的宏的一些示例： 还可以创建更复杂的宏，如以下示例所示： This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.