> ## Documentation Index > Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt > Use this file to discover all available pages before exploring further. # AI Connector > Connect to AI models via a REST API to process messages using configurable prompts and generate structured outputs within your data flows. AI connectors are designed to connect to a number of AI models that expose a REST API. The supported list is [below](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/ai.md#ai-config-tab). ## Key Capabilities * Multi-provider AI integration * Flexible prompt engineering * Customizable AI model selection * Structured output control * Intelligent content processing ## Overview The CData Arc AI connector is a flexible integration tool that connects to any AI model via REST APIs, enabling you to process input messages using configurable system and user prompts to generate structured outputs within your data flows. It supports popular AI services like OpenAI, Gemini, Ollama, and other OpenAI-compatible providers, with full control over API endpoints, models, and parameters. With ArcScript-enabled prompts and customizable output formats, the connector enables use cases such as extracting insights from unstructured feedback, translating content across languages, and transforming text data into actionable structured information. ### Actions このコネクタは、3 つのコネクタアクションタイプのいずれも実行できます。 • *Trigger* は、スケジュールに基づいてrequestを実行し、フローに送信するファイルを生成する場合があります。このアクションはフローの起点として機能します。 • *Transform* は、フローからのメッセージをrequestへの入力として受け取り、出力を生成します。このアクションはフローの中間として機能します。 • *Terminal* は、フローからのメッセージをrequestへの入力として受け取り、フローの終端として機能します。 ## Connector Configuration This section contains all of the configurable connector properties. ### AI Config Tab If you have not already configured the global AI settings at **Settings > Advanced > AI Settings**, the **AI Config** tab displays a message that you must do this before you can use the connector. Click the **Configure AI Settings** button, and follow the instructions in [AI Settings](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/ai-settings.md). If the global settings have already been configured but you want to override them in this connector, click **Edit**. To override the global settings, toggle on **Override global setting**. Now you can select which AI provider you want to use, enter the appropriate connection details and then save the configuration. The connector supports the following providers: * Claude * Deepseek * Gemini * Grok * Ollama (cloud and local) * OpenAI * OpenAI Compatible (any AI provider that implements OpenAI's API) Use the **Edit AI Settings** pane to define the **Base URL** (only available when the provider is **Ollama** or **OpenAI Compatible**), add the provider's **API Key**, and select a **Model**. To populate the **User Prompt** field, you can click **Suggested Prompts** to see a set of predefined prompts for a variety of use cases, or you can enter your own prompt directly into the field. This is where you define the task or request that you want the connector to perform when it receives a file. For example, you could enter something like *Summarize the inbound EDI X12 file using natural language* so that employees who are not familiar with the EDI X12 structure can read the summary and understand what information the document contains. This field supports ArcScript. You can also choose to **Attach input messages to requests**. This is especially useful when you are providing binary files (such as a PDF or image) to the AI provider. To include non-binary files in the request, you need to use \_message.body in your prompt, like this: ``` [_message.body] ``` > [!NOTE] > > See the Summarize option in the Suggested Prompts dropdown for a complete example. Toggle **System Prompt** to provide a set of specific instructions, constraints, languages, or roles that the AI provider should use when providing its response. For example: *Do not use any em dashes or emojis in your response.* This field also supports ArcScript. The way in which you test your configuration and prompts varies by the connector's [action type](#actions): * If your connector is a trigger, click the **Test** button. * If your connector is a transform or terminal, on the **Testing** tab, paste content into the **Input Body** or use the dropdown to add **Headers** and values, then click the **Test** button. In both cases, the test results appear in the **Testing** tab. Logs from the test are displayed in the **Log** tab. ### Settings Tab *Settings related to the core configuration of the connector.* #### Configuration | Setting | Description | | - | - | | **Connector Id** | The static, unique identifier for the connector. | | **Connector Type** | Displays the connector name and a description of what it does. | | **Connector Description** | An optional field to provide a free-form description of the connector and its role in the flow. | | **Action** | The action this connector is performing: trigger, transform, or terminal. | | **Output in JSON** | If your model supports structured outputs, check this to deliver the connector output in JSON format. This is useful when you want to ensure the AI output is structured and machine-readable, so it is easier to parse, extract data, or use in downstream connectors and processes. | #### Advanced Settings | Setting | Description | | - | - | | **Local File Scheme** | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see [Macros](#macros). | ### Advanced Tab #### Other Settings | Setting | Description | | - | - | | **Timeout** | The AI response timeout, in seconds. By default, this value is set to 60 seconds. | #### Proxy Settings これらは、接続のルーティング先となるプロキシを識別し認証するための一連の設定です。デフォルトでは、このセクションは[Security Settings](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/security.md) ページの[Proxy Settings](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/proxy-settings.md) 部分にあるグローバル設定を使用します。チェックボックスをオフにすると、コネクタ固有の設定を指定できます。
設定説明
**Proxy Type** プロキシベースのファイアウォールで使用されるプロトコル。
**Proxy Host** プロキシベースのファイアウォールの名前またはIP アドレス。
**Proxy Port** プロキシベースのファイアウォールのTCP ポート。
**Proxy User** プロキシベースのファイアウォールで認証するために使用するユーザー名。
**Proxy Password** プロキシベースのファイアウォールで認証するために使用するパスワード。
**Authentication Scheme** デフォルトの**None** のままにするか、次の認証スキームのいずれかを選択します：**Basic**、**Digest**、**Proprietary**、または**NTLM**。
#### Message *Message 設定は、コネクタがメッセージを検索する方法と、処理後にメッセージを管理する方法を決定します。* **Note：** 以下の設定は非推奨となり、デフォルトで非表示になっています。以前に有効化またはデフォルト以外の値に設定されていたコネクタにのみ表示されます。処理済みファイルのコピーを保持するには、フロー内のコネクタを右クリックし、**成功パスを表示**を選択して、成功パスを[File コネクタ](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/file.md)に接続してください。
設定説明
**Sent フォルダに保存**（非推奨） コネクタが処理したファイルをSent フォルダにコピーします。デフォルトで無効です。Sent フォルダに保存されたファイルは[保存データの暗号化](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/encryption-at-rest.md)の対象外です。
**Sent フォルダのスキーム**（非推奨） 選択した時間間隔で**Sent** フォルダ内のファイルをグループ化します。**Sent フォルダに保存**が有効な場合のみ適用されます。
#### Logging *ログの作成と保存を制御する設定です。*
設定 説明
**Log Level** コネクタが生成するログの詳細度です。サポートを依頼する際は、これを**Debug** に設定してください。
**Log Subfolder Scheme** 選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。**Weekly** オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。
**Log Messages** 処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、**Transactions** タブからファイルのコピーをダウンロードできなくなる場合があります。
#### Miscellaneous *Miscellaneous 設定は、特定のユースケース向けの設定です。*
設定 説明
**Other Settings** 非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：`setting1=value1;setting2=value2`）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。
### Automation Tab #### Automation Settings *Settings related to the automatic processing of files by the connector.* | Setting | Description | | - | - | | **Send** | Whether files arriving at the connector are automatically uploaded. | | **Retry Interval** | The amount of time before a failed upload is retried. | | **Max Attempts** | The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the file indefinitely. | | **Receive** | Whether the connector should automatically poll the remote download path for files to download. | | **Interval** | The interval between automatic download attempts. | | **Minutes Past the Hour** | The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to *Hourly*. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc. | | **Time** | The time of day that the attempt should occur. Only applicable when the interval setting above is set to *Daily*, *Weekly*, or *Monthly*. | | **Day** | The day on which the attempt should occur. Only applicable when the interval setting above is set to *Weekly* or *Monthly*. | | **Minutes** | The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to *Minute*. | | **Cron Expression** | A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to *Advanced*. | | **Start Date and Time** | The date and time at which the automation first runs. Every run after that follows the interval setting above. The last and next run times appear in the [Automation Status](#automation-status) section. | #### Automation Status *オートメーションが実行されているか、前回の実行で何が起きたか、次回の実行がいつかを示す読み取り専用のサマリです。* **オートメーションステータス**カードは、**受信**、**ダウンロード**、**スケジュール送信**のオートメーションにおいて、**オートメーション**タブの**有効**チェックボックスの下に表示されます。このカードでは、オートメーションが実行されたか、実行が成功したか、次回の実行がいつかという3点を確認できます。 コネクタを保存する前に、**有効**チェックボックス、**間隔**、または**開始日時**の設定を変更すると、カードもそれに合わせて更新されます。 ![一時停止中のステータス、失敗した最後に処理された結果、および次回の実行時刻を表示するオートメーションタブのオートメーションステータスカード](https://docs.arc.cdata.com/26.4/images/automation-status-card.png) ステータス コネクタのオートメーションの現在の状態です。
ステータス 説明
**進行中** 実行が現在行われているか、別のインスタンスがスケジュールされた枠をロックしています。
**アイドル** オートメーションは次のスケジュールされた実行を待機しています。
**一時停止中** 実行の失敗が繰り返された後、コネクタは[バックオフ](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/connector-backoff.md)状態にあり、オートメーションサービスはこのコネクタをスキップしています。
**無効** このコネクタのオートメーションはオフになっています。
前回の実行時刻 直近の実行の結果です。
フィールド 説明
**日付** 前回の実行のスケジュールされた時刻。
**最後に処理された開始** コネクタが前回の実行の処理を実際に開始した時刻。スケジュールされた時刻よりわずかに遅れる場合があります。
**最後に処理された結果** 前回の実行の結果：
  • **成功**：実行が完了し、データが処理されました。
  • **データなし**：実行は完了しましたが、クエリが行を返さなかった場合など、処理するものがありませんでした。
  • **失敗**：実行が完了しませんでした。
**最後に成功した日時** 直近で成功した実行の日時。このフィールドは、前回の実行が失敗した場合またはデータなしだった場合に表示され、コネクタが成功した実行なしでどれくらい経過しているかを確認できます。
次回の実行時刻 **日付**フィールドには、次にオートメーションが実行される予定の日時が表示されます。オートメーションが無効の場合は空白になります。 詳細を表示 **一時停止中**ステータス、**失敗**の結果、および**データなし**の結果にはそれぞれ**詳細を表示**リンクがあり、クリックすると完全なメッセージを表示するダイアログが開きます： 未実行とデータなしの違い このカードでは、まだ実行されていないコネクタと、実行されたものの何も見つからなかったコネクタを区別できます。**最後に処理された結果**が空の場合、オートメーションはまだ実行されていないため、**次回の実行時刻**とスケジュール設定を確認してください。結果が**データなし**の場合、オートメーションはスケジュールどおりに実行されましたが、データソースから何も返されなかったため、ソースに新しいデータがあるかどうかを確認してください。 無効なコネクタ 無効なコネクタは前回の実行情報を保持するため、いつ最後に実行され、何が起きたかを引き続き確認できます。クリアされるのは**次回の実行時刻**のみです。 ### Alerts Tab *アラートの設定に関する設定です。* サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、Arc は[Alerts](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/alerts.md) タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、**Override global setting** をオンに切り替えます。 デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、**Enable** チェックボックスのチェックを外します。 **Subject**（必須）を入力します。**Allow ArcScript in Subject** をチェックすると、**Subject** フィールドでArcScript を使用できます。これを選択すると、**ArcScript エディタ**ボタンが表示されます（![arcscript editor button](https://docs.arc.cdata.com/26.4/images/rest_arcscript_editor.png)）。 必要に応じて**Recipient** のメールアドレスをカンマ区切りのリストで入力します。 ### SLAs Tab *サービスレベルアグリーメント（SLA）の設定に関する設定です。* SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。CData Arc は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA を*At Risk* としてマークします。これは、SLA が間もなく達成されない場合に*Violated* としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。 SLA が*At Risk* または*Violated* に移行したことも[アプリケーションログ](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/activity.md#アプリケーションログ)に書き込まれるため、Application Performance Monitoring（APM）やログ収集ツールでもアラートを設定できます。 SLA を定義するには、**Expected Volume** をオンに切り替え、**Settings** タブをクリックします。 ![SLA Empty](https://docs.arc.cdata.com/26.4/images/sla_empty.png) 次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。 ![SLA Configuration Example](https://docs.arc.cdata.com/26.4/images/sla_defined.png) > [!NOTE] > > 必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar で**Settings** をクリックし、**Alerts > General Alerts** に移動します。タブレットと鉛筆のアイコンをクリックして編集し、**SLA Alerts** 設定のチェックを外します。 ### Transactions Tab This tab lists all messages associated with the connector. Use the search bar to find specific messages, or click the funnel icon to apply a filter. You can filter by time, message direction, and/or status. Options on this tab vary depending on the connector's [action type](#actions): * If your connector is a **Trigger**, use the **Receive Files** button to start the flow. * If your connector is a **Transform** or **Terminal**, use the **Upload Files** button to upload files to the flow. ## Macros ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。 ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を 動的に含めることができ、各ファイルに有用な文脈を提供します。 CData Arc は次のマクロをサポートしています。これらはすべて次の構文を使用します。`%Macro%`
マクロ説明
ConnectorIDコネクタのConnectorID に評価されます。
ConnectorNameコネクタの名前に評価されます。ファイル名やパスに接続名を含めることができます。例えば、どのデータベース接続が生成したかによってバックアップファイルにタグを付けるために使用できます。
Extコネクタが現在処理しているファイルの拡張子に評価されます。
Filenameコネクタが現在処理しているファイルのファイル名（拡張子を含む）に評価されます。
FilenameNoExtコネクタが現在処理しているファイルのファイル名（拡張子を除く）に評価されます。
MessageIdコネクタが出力しているメッセージのMessageId に評価されます。
RegexFilename:*pattern*コネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。
Header:*headername*コネクタが現在処理しているメッセージ上の対象ヘッダー（`headername`）の値に評価されます。
LongDateシステムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。
ShortDateシステムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。
DateFormat:*format*システムの現在の日時を指定された形式（`format`）で評価します。利用可能な日時形式については、[日付形式のサンプル](https://docs.arc.cdata.com/26.4/self-hosted/ja/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)を参照してください。
Vault:*vaultitem*指定されたVault アイテムの値に評価されます。
### Examples %Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。 引数を取るすべてのマクロは次の構文を使用します。`%Macro:argument%` 引数を取るマクロの例を次に示します。 次の例に示すように、より高度なマクロを作成することもできます。 This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.