> ## 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.3/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 索引標籤上的全域設定。要為此端口使用其他設定，請啟用 <strong>覆蓋全域設定</strong>。
    </p>
    <p>
      預設情況下，錯誤通知處於啟用狀態，這意味著每當出現錯誤時都會傳送電子郵件。要關閉錯誤通知，請取消選中 <strong>啟用</strong> 核取方塊。
    </p>
    <p>
      輸入 <strong>主題</strong>（必填）。勾選<strong>允許在主題中使用 ArcScript</strong>，即可在<strong>主題</strong>欄位中使用 ArcScript。選中後會顯示 <strong>ArcScript 編輯器</strong>按鈕（<img src="/public/images/rest_arcscript_editor.png" alt="ArcScript 編輯器按鈕" style={{
  display: 'inline',
  verticalAlign: 'middle',
  margin: 0
}} />）。
    </p>
    <p>
      （可選）輸入以逗號分隔的<strong>收件人</strong>電子郵件地址清單。
    </p>
  </>;

export const CommonProxySettings = () => <>
    <p>這是一組用於識別連線所經代理並對其進行身分驗證的設定。預設情況下，本節使用 <a href="/26.3/self-hosted/zh/getting-started/administration/settings/security">安全設定</a> 頁面的 <a href="/26.3/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>
    <p><strong>注意：</strong>以下設定已棄用，預設處於隱藏狀態。只有先前已啟用這些設定或將其配置為非預設值的端口才會顯示它們。若要保留成功處理的檔案副本，請在工作流程中右鍵單擊該端口，選擇<strong>顯示成功路徑</strong>，然後將成功路徑連線到 <a href="/26.3/self-hosted/zh/connectors/file">File 端口</a>。</p>
    <table>
      <thead>
        <tr><th>設定</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>儲存到已傳送資料夾</strong>（已棄用）</td>
          <td>將端口處理的檔案複製到 Sent 資料夾。預設停用。儲存到 Sent 資料夾中的檔案不受<a href="/26.3/self-hosted/zh/getting-started/administration/settings/encryption-at-rest">靜態加密</a>保護。</td>
        </tr>
        <tr>
          <td><strong>已傳送資料夾方案</strong>（已棄用）</td>
          <td>按所選時間間隔對 <strong>Sent</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.3/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.3/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>ConnectorName</td><td>替換為端口名稱。可用於在檔名或路徑中包含連線名稱，例如按生成備份檔案的資料庫連線標記檔案。</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.3/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 端點、模型和參數。透過支援 ArcScript 的提示詞和可自定義的輸出格式，該端口支援多種使用場景，例如從非結構化反饋中提取見解、跨語言翻譯內容以及將文字資料轉換為可操作的結構化資訊。

### 操作

<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 結構的員工能夠閱讀摘要並瞭解文件包含的資訊。此欄位支援 ArcScript。

還可以選擇 **將輸入訊息附加到請求**。當向 AI 供應商提供二進位檔案（如 PDF 或影像）時，這尤其有用。

要在請求中包含非二進位檔案，需要在提示詞中使用 `_message.body`，如下所示：

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

<Note>如需完整範例，請檢視 **推薦提示詞** 下拉式清單中的“總結”選項。</Note>

開啟 **系統提示詞** 以提供一組特定的指令、約束、語言或角色，供 AI 供應商在提供回應時使用。例如：*在回答中不要使用任何破折號或表情符號。* 此欄位同樣支援 ArcScript。

測試配置和提示詞的方式取決於端口的[操作型別](#操作)：

* 如果端口是觸發端口，點選 **測試** 按鈕。
* 如果端口是轉換或終結端口，在 **測試** 頁面上，將內容貼上到 **輸入正文** 中，或使用下拉式清單新增 **請求頭** 和值，然後點選 **測試** 按鈕。

在這兩種情況下，測試結果都會顯示在 **測試** 頁面中。測試日誌顯示在 **日誌** 頁面中。

### 設定頁面

*與端口核心配置相關的設定。*

#### 配置

| 設定           | 說明                                                                                   |
| ------------ | ------------------------------------------------------------------------------------ |
| **端口 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 />