> ## 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 模型，使用可配置的提示词处理消息，并在数据流中生成结构化输出。

export const CommonActionType = ({resource = "script"}) => <>
    <p>此端口可以执行三种端口操作类型中的任何一种：</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <em>触发</em> 按计划执行一个 {resource} ，并且可能会生成要沿着工作流发送的文件。此操作充当工作流的起点。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <em>转换</em> 接受来自工作流的消息作为 {resource} 的输入并生成输出。此操作充当工作流的中间部分。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <em>终结</em> 接受来自工作流的消息作为 {resource} 的输入并充当工作流的终点。</p>
  </>;

export const SlasTab = ({siteName = "知行之桥"}) => <>
    <p><em>与配置服务级别协议 (SLA) 相关的设置。</em></p>
    <p>
      SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 <em>存在风险</em>，这意味着如果 SLA 未能尽快达到，则会被标记为 <em>已违反</em>。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
    </p>
    <p>
      要定义 SLA，请启用 <strong>预期数据量</strong>，然后点击 <strong>设置</strong> 选项卡。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
      <li>在窗口的 <strong>预计至少</strong> 部分中：
        <ul>
          <li>设置预计处理的最小事务数量（交易量）</li>
          <li>使用 <strong>每个</strong> 字段指定时间范围</li>
          <li>指示 SLA 生效的时间。如果选择 <strong>开始于</strong>，请填写日期和时间字段。</li>
          <li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 <strong>每天</strong>。</li>
        </ul>
      </li>
      <li>在窗口的 <strong>将状态设置为“有风险”</strong> 部分中，指定应将 SLA 标记为有风险的时间。
        <ul>
          <li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 <strong>发送“有风险”通知</strong>。</li>
        </ul>
      </li>
    </ul>
    <p>
      以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 <strong>设置</strong>，然后跳转到 <strong>通知 &gt; 通用通知</strong>。点击平板和铅笔图标进行编辑，并取消勾选 <strong>SLA 通知</strong> 设置。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
    <p><em>与配置通知相关的设置。</em></p>
    <p>
      在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 选项卡上的全局设置。要为此端口使用其他设置，请启用 <strong>覆盖全局设置</strong>。
    </p>
    <p>
      默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 <strong>启用</strong> 复选框。
    </p>
    <p>
      输入 <strong>主题</strong>（必填），然后（可选）输入以逗号分隔的 <strong>收件人</strong> 电子邮件列表。
    </p>
  </>;

export const CommonProxySettings = () => <>
    <p>这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/security">安全设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/proxy-settings">代理设置</a> 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。</p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>代理类型</strong></td>
          <td>基于代理的防火墙使用的协议。</td>
        </tr>
        <tr>
          <td><strong>代理主机</strong></td>
          <td>基于代理的防火墙的名称或 IP 地址。</td>
        </tr>
        <tr>
          <td><strong>代理端口</strong></td>
          <td>基于代理的防火墙的 TCP 端口。</td>
        </tr>
        <tr>
          <td><strong>代理用户</strong></td>
          <td>用于通过基于代理的防火墙进行身份验证的用户名。</td>
        </tr>
        <tr>
          <td><strong>代理密码</strong></td>
          <td>用于对基于代理的防火墙进行身份验证的密码。</td>
        </tr>
        <tr>
          <td><strong>身份验证方案</strong></td>
          <td>保留默认值 <strong>None</strong> 或选择以下身份验证方案之一：<strong>Basic</strong>、<strong>Digest</strong>、<strong>Proprietary</strong> 或 <strong>NTLM</strong>。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Message = () => <>
    <p><em>消息设置确定端口如何搜索消息并在处理后管理它们。</em></p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>保存到已发送文件夹</strong></td>
            <td>选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。</td>
          </tr>
        
        <tr>
          <td><strong>已发送文件夹方案</strong></td>
          <td>端口根据选定的时间间隔对 <strong>已发送</strong> 文件夹中的文件进行分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 <strong>已发送</strong> 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>特殊设置适用于特定用例。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>其他设置</strong></td>
          <td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 <code>setting1=value1;setting2=value2</code>。正常的端口用例和功能不需要使用这些设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>用于管理日志创建和存储的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>日志级别</strong></td>
          <td>指定要记录在端口日志目录中的信息类型：
            <ul>
              <li><b>None</b> - 不创建任何日志。</li>
              <li><b>Error</b> - 仅当端口遇到错误时才创建日志。</li>
              <li><b>Warning</b> - 仅当端口发出警告时才创建日志。</li>
              <li><b>Info</b> - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
              <li><b>Debug</b> - 记录成功和失败工作流的详细调试信息。</li>
              <li><b>Trace</b> - 记录成功和失败工作流的详细跟踪信息。</li>
            </ul>
            <strong>请注意：</strong><strong>Debug</strong> 和 <strong>Trace</strong> 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td>
        </tr>
        <tr>
          <td><strong>日志文件夹结构</strong></td>
          <td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td>
        </tr>
        <tr>
          <td><strong>保留消息副本</strong></td>
          <td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：<code>%Macro:argument%</code>
    </p>

    <p>以下是带有参数的宏的一些示例：</p>

    <ul>
      <li>%Header:headername%：其中 <code>headername</code> 是消息上消息头的名称。</li>
      <li>%Header:mycustomheader% 解析为输入消息上设置的 <code>mycustomheader</code> 消息头的值。</li>
      <li>%Header:ponum% 解析为输入消息上设置的 <code>ponum</code> 消息头的值。</li>
      <li>%RegexFilename:pattern%：其中 <code>pattern</code> 是正则表达式模式。例如，<code>%RegexFilename:^([\w][A-Za-z]+)%</code> 匹配并解析为文件名中的第一个单词，并且不区分大小写（<code>test_file.xml</code> 解析为 <code>test</code>）。</li>
      <li>%Vault:vaultitem%：其中 <code>vaultitem</code> 是 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault">vault</a> 中项目的名称。例如，<code>%Vault:companyname%</code> 解析为存储在保管库中的 <code>companyname</code> 项的值。</li>
      <li>%DateFormat:format%：其中 <code>format</code> 是可接受的日期格式（有关详细信息，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#sample-date-formats">示例日期格式</a>）。例如，<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> 解析为文件上的日期和时间戳。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>还可以创建更复杂的宏，如以下示例所示：</p>

    <ul>
      <li>将多个宏组合在一个文件名中：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>包括宏之外的文本：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>在宏中包含文本：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
    <p>
      在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
    </p>

    <p>{siteName} 支持这些宏，它们都使用以下语法：<code>%Macro%</code>。</p>

    <table>
      <thead>
        <tr><th>宏</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
        <tr><td>Ext</td><td>替换为端口当前正在处理的文件的文件扩展名。</td></tr>
        <tr><td>Filename</td><td>替换为端口当前正在处理的文件的文件名（包括扩展名）。</td></tr>
        <tr><td>FilenameNoExt</td><td>替换为端口当前正在处理的文件的文件名（不带扩展名）。</td></tr>
        <tr><td>MessageId</td><td>计算端口输出的消息的 MessageId。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>替换为端口正在处理的当前消息的目标消息头（<code>headername</code>）的值。</td></tr>
        <tr><td>LongDate</td><td>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</td></tr>
        <tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>以指定格式（<code>format</code>）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">示例日期格式</a>。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>计算指定保管库项目的值。</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

AI 端口旨在连接到一系列提供 REST API 的 AI 模型。支持的列表见[下方](./ai#ai-配置页面)。

## 核心功能

* 多供应商 AI 集成
* 灵活的提示词工程（Prompt Engineering）
* 可自定义的 AI 模型选择
* 结构化输出控制
* 智能内容处理

## 概述

{siteName} AI 端口是一个灵活的集成工具，通过 REST API 连接到任何 AI 模型，能够使用可配置的系统提示词和用户提示词处理输入消息，从而在工作流中生成结构化输出。它支持流行的 AI 服务，如 OpenAI、Gemini、Ollama 以及其他兼容 OpenAI 的供应商，并能完全控制 API 端点、模型和参数。通过支持 {siteNameShort}Script 的提示词和可自定义的输出格式，该端口支持多种使用场景，例如从非结构化反馈中提取见解、跨语言翻译内容以及将文本数据转换为可操作的结构化信息。

### 操作

<CommonActionType resource="request" />

## 端口配置

本节包含所有可配置的端口属性。

### AI 配置页面

如果尚未在 **设置 > 高级 > AI 设置** 中配置全局 AI 设置，**AI 配置** 页面将显示一条消息，提示必须先完成此配置才能使用该端口。点击 **配置 AI 设置** 按钮，并按照 [AI 设置](../getting-started/administration/settings/ai-settings) 中的说明进行操作。如果全局设置已配置，但想在此端口中覆盖这些设置，请点击 **编辑**。要覆盖全局设置，请开启 **覆盖全局设置** 切换开关。现在可以选择要使用的 AI 供应商，输入相应的连接详细信息并保存配置。该端口支持以下供应商：

* Claude
* Deepseek
* Gemini
* Grok
* Ollama（云端和本地）
* OpenAI
* OpenAI Compatible（任何实现 OpenAI API 的 AI 供应商）

使用 **编辑 AI 设置** 面板定义 **基地址 (Base URL)**（仅当供应商为 **Ollama** 或 **OpenAI Compatible** 时可用），添加供应商的 **API Key**，并选择 **模型**。

要填充 **用户提示词** 字段，可以点击 **推荐提示词** 查看针对各种场景预定义的一组提示词，也可以直接在字段中输入自己的提示词。这是定义在接收到文件时希望端口执行的任务或请求的地方。例如，可以输入类似 *使用自然语言总结入站的 EDI X12 文件* 的内容，以便不熟悉 EDI X12 结构的员工能够阅读摘要并了解文档包含的信息。此字段支持 {siteNameShort}Script。

还可以选择 **将输入消息附加到请求**。当向 AI 供应商提供二进制文件（如 PDF 或图像）时，这尤其有用。

要在请求中包含非二进制文件，需要在提示词中使用 `_message.body`，如下所示：

```
<BEGIN FILE>
[_message.body]
<END FILE>
```

<Note>如需完整示例，请查看 **推荐提示词** 下拉列表中的“总结”选项。</Note>

开启 **系统提示词** 以提供一组特定的指令、约束、语言或角色，供 AI 供应商在提供响应时使用。例如：*在回答中不要使用任何破折号或表情符号。* 此字段同样支持 {siteNameShort}Script。

测试配置和提示词的方式取决于端口的[操作类型](#操作)：

* 如果端口是触发端口，点击 **测试** 按钮。
* 如果端口是转换或终结端口，在 **测试** 页面上，将内容粘贴到 **输入正文** 中，或使用下拉列表添加 **请求头** 和值，然后点击 **测试** 按钮。

在这两种情况下，测试结果都会显示在 **测试** 页面中。测试日志显示在 **日志** 页面中。

### 设置页面

*与端口核心配置相关的设置。*

#### 配置

| 设置           | 说明                                                                                   |
| ------------ | ------------------------------------------------------------------------------------ |
| **端口 Id**    | 端口的静态唯一标识符。                                                                          |
| **端口类型**     | 显示端口名称及其功能说明。                                                                        |
| **端口描述**     | 可选字段，用于以自由文本形式描述端口及其在工作流中的角色。                                                        |
| **操作**       | 此端口执行的操作：触发、转换或终结。                                                                   |
| **输出为 JSON** | 如果模型支持结构化输出，勾选此项以 JSON 格式交付端口输出。当希望确保 AI 输出是结构化且机器可读的，以便更容易解析、提取数据或用于下游端口和流程时，这非常有用。 |

#### 高级设置

| 设置         | 说明                                                               |
| ---------- | ---------------------------------------------------------------- |
| **本地文件方案** | 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符和时间戳等信息。有关更多信息，请参阅[宏](#宏)。 |

### 高级页面

#### 其他设置

| 设置       | 说明                             |
| -------- | ------------------------------ |
| **超时时间** | AI 响应超时时间（秒）。默认情况下，此值设置为 60 秒。 |

#### 代理设置

<CommonProxySettings />

#### 消息

<Message />

#### 日志

<Logging />

#### 其他

<MiscConnector />

### 自动化页面

#### 自动化设置

*与端口自动处理文件相关的设置。*

| 设置           | 说明                                                                         |
| ------------ | -------------------------------------------------------------------------- |
| **发送**       | 到达端口的文件是否自动上传。                                                             |
| **重试间隔**     | 失败上传重试前的时间间隔。                                                              |
| **最大尝试次数**   | 端口处理输入文件的最大次数。成功与否基于服务器的成功确认。如果设置为 0，端口将无限次重试文件。                           |
| **接收**       | 端口是否应自动轮询远程下载路径以获取待下载文件。                                                   |
| **间隔**       | 自动下载尝试之间的时间间隔。                                                             |
| **整点后的分钟数**  | 小时计划的分钟偏移量。仅当上方的间隔设置为 *每小时* 时适用。例如，如果该值设置为 5，自动化服务将在 1:05、2:05、3:05 等时间下载。 |
| **时间**       | 尝试发生的一天中的具体时间。仅当上方的间隔设置为 *每天*、*每周* 或 *每月* 时适用。                             |
| **日期**       | 尝试发生的日期。仅当上方的间隔设置为 *每周* 或 *每月* 时适用。                                        |
| **分钟**       | 尝试下载前等待的分钟数。仅当上方的间隔设置为 *分钟* 时适用。                                           |
| **Cron 表达式** | 一个五段字符串，表示用于确定尝试发生时间的 cron 表达式。仅当上方的间隔设置为 *高级* 时适用。                        |

### 警报页面

<AlertsTab />

### SLA 页面

<SlasTab />

### 交易页面

此页面列出了与该端口关联的所有消息。使用搜索栏查找特定消息，或点击漏斗图标应用过滤器。可以按时间、消息方向和/或状态进行过滤。

此页面上的选项因端口的[操作类型](#操作)而异：

* 如果端口是 **触发** 端口，使用 **接收文件** 按钮开始工作流。
* 如果端口是 **转换** 或 **终结** 端口，使用 **上传文件** 按钮将文件上传到工作流。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />