OpenAIに連携する

2026-08-252026-09-08

概要¶

RAG連携機能を使い、指定したテーブルのレコードをOpenAI Platformへ連携する手順を説明します。

検証環境と本番環境で異なるストレージとAPIキーを指定してください。同じストレージとAPIキーを共用すると、一方の環境における同期操作により、もう一方の環境の文書が削除される場合があります。
連携設定で指定するAPIキーは、サイトの設定情報の一部として平文で保存されます。画面上はマスクした文字列（********）を表示しますが、保存値そのものは平文です。エクスポートしたサイトパッケージには平文で記載されますので、サイトパッケージの取り扱いには注意してください。
OpenAIでは無料で使用できるストレージ容量に制限があります。課金を避けたい場合は、不要なファイルを削除する必要があります。
連携設定のEndpointとAiConnect.jsonのパラメータProviderEndpoints.OpenAiが未設定の場合、エラーとなります。ただしAiConnect.jsonのパラメータAllowInsecureLoopbackEndpointをtrueに設定した場合に限り、ループバックアドレスへのHTTP接続だけが許可されます。ループバック以外のホストへのHTTP接続は、AllowInsecureLoopbackEndpointがtrueでも拒否されます。この検査は保存時には行われず、連携の実行時に行われます。

マークダウンファイルはレコードを更新したユーザの権限で出力されます。そのユーザに閲覧権限のない項目の値は空文字列で出力されます。
登録状態の確認で連携先から空の応答、不正なJSON、状態のない応答、未知の状態が返されたときは、一時的な確認失敗として既定では10回まで再確認します（この回数はAiConnect.jsonのパラメータRag.IndexCheckMaxAttemptsで変更できます）。10回確認しても連携先から正しい応答を得られない場合は、ジョブが失敗します。この場合、連携文書の再送は行いません。再送が行われるのは、連携先が「失敗」または「取り消し」を返した場合だけです。

設定を変更するには「サイトの管理」権限が必要です。
AiConnect.jsonのパラメータEnabledをtrueに設定してください。
AiConnect.jsonのパラメータOutputFilePathに、連携文書の出力先フォルダを設定してください。未設定の場合、同期を実行するとエラーメッセージが表示されます。

「AI連携」ダイアログが開きます。下記を参考に各項目を設定してください。

項目	必須	説明
ID	—	設定不要です。連携先を識別する番号です。自動で採番され変更できません。新規作成時は表示されません。
タイトル	○	サイト管理者が連携先を識別するための名前を指定してください。
連携フォーマット	○	下記「連携フォーマット」を参考に、マークダウンファイルの書式を指定してください。初期値はAiConnect.jsonのパラメータFormatTemplateです。
連携方式	—	「OpenAI」を選択してください。
連携設定	¹	下記「連携設定」を参考に、必要な情報をJSON形式で指定してください。
無効	—	オンにすると、連携を行いません。

角括弧（ [ と ] ）と波括弧（ { と } ）で囲んだ文字列は、以下の規則で置換されます。

記法	内容
[「カラム名」]	当該カラムの表示値に置換されます。例：[Title]、[Status]、[Owner]、[Body]
{Url}	レコードの編集画面の絶対URLに置換されます。
{LoginId}	操作者のログインIDに置換されます。
{UserName}	操作者のユーザ名に置換されます。
{MailAddress}	操作者のメールアドレスに置換されます。

連携フォーマットの設定例

# [Title]

状況: [Status]

URL: {Url}

「連携方式」で「OpenAI」を選択すると、以下のテンプレートが「連携設定」欄に表示されます。

{
    "Endpoint": "",
    "VectorStoreId": "",
    "ApiKey": ""
}

パラメータ	説明
Endpoint	OpenAIのAPIエンドポイントです。例：https://api.openai.com/v1
VectorStoreId	OpenAIのストレージIDです
ApiKey	OpenAIで発行したAPIキーです

各パラメータの設定値は、以下の手順で取得してください。詳細はOpenAI API Platform Documentationを参照してください。

APIエンドポイント（Endpoint）

OpenAI PlatformのAPIエンドポイントは以下のとおりです（バージョン1.5.8.0のリリース時点）。
```
https://api.openai.com/v1
```
ストレージID（VectorStoreId）
1. OpenAI Platformへログインしてください。
2. ダッシュボード左側のメニューでStorageまたはVector Storageを選択してください。
3. ベクトルストアが一覧表示されます。対象のベクトルストアを選択するか、新規作成してください。
4. 画面上に表示される「vs_」から始まる文字列がベクトルストアIDです。
APIキー（ApiKey）
1. OpenAI Platformへログインしてください。
2. ダッシュボード左側のメニューでAPI Keysを選択してください。
3. APIキーの一覧が表示されます。対象のAPIキーを選択するか、新規作成してください。
4. 画面に表示される「sk_」から始まる文字列がAPIキーです。

対応バージョン	内容
1.5.8.0 以降	機能追加