設定ファイル（ai_assistant.yml）
形式
YAML形式で記述します。
generative_ai:
azure:
- endpoint: Azure OpenAIのAPIのエンドポイント
models:
- api:
type: Azure OpenAIのAPIの種類
version: Azure OpenAIのAPIのバージョン
deployment_name: Azure OpenAIのデプロイ名
model_name: Azure OpenAIのモデル名
service:
langchain:
prompts:
- name: プロンプト名
type: プロンプトのtype
tools: 使用するツールの名前
tools:
- name: ツールの名前
azure_ai_search:
endpoint: Azuer AI SearchのAPIのエンドポイント
index_name: Azuer AI Searchのインデックス名
ui:
template: 質問文のテンプレート
chat:
max_size: 質問の最大文字数
logs:
filter: ログの出力抑止の有効化または無効化
ファイル
ai_assistant.yml
定義ファイル編集機能画面のタブ名
aiassistant
説明
生成AI連携の設定ファイルです。生成AI及びドキュメント検索エンジンの接続情報や，画面設定を定義します。
文字コード
UTF-8（BOMなし）
改行コード
LF
定義の反映時期
JP1/IM3の定義ファイル操作機能を使ってアップロードした際に，プログラムが再起動して定義が反映されます。
記述内容
|
項目名 |
説明 |
必須/任意 |
デフォルト値 |
||||
|---|---|---|---|---|---|---|---|
|
generative_ai: |
生成AI関連の接続先を記載します。 |
必須 |
- |
||||
|
azure: |
Azure OpenAI Serviceの接続先を記載します。 |
任意 |
- |
||||
|
- |
endpoint: |
Azure OpenAI APIのエンドポイントを記載します。１つのみ指定可能です。 指定可能な値 1〜256文字の下記形式 https://[\w/:%#\$&\?\(\)~\.=\+\-]+ |
必須 |
"<エンドポイント>" |
|||
|
models: |
生成AIモデルの情報を記載します。１つのみ指定可能です。 |
必須 |
- |
||||
|
- |
api: |
使用するAPIについて記載します。 |
必須 |
- |
|||
|
type: |
使用するAPIの種類，チャット入力候補（Chat Completion）または入力候補（Completion）を記載します。チャット入力候補の場合はchatを入力候補の場合はtextを指定してください。各モデルで指定可能な値はAzureの公式ドキュメントを参照してください。 指定可能な値 chatまたはtext |
必須 |
chat |
||||
|
version: |
使用するAPIのバージョンを指定します。 指定可能な値 半角英数字とハイフン 1〜32文字 |
必須 |
"2023-05-15" |
||||
|
deployment_name: |
Azure OpenAIのデプロイ名を記載します。 指定可能な値 半角英数字とハイフン，アンダースコア 1〜128文字 |
必須 |
<デプロイメント名> |
||||
|
model_name: |
Azure OpenAIのモデル名を記載します。 指定可能な値 APIの種類で指定可能な値が異なります。 APIの種類がchatの場合に指定可能な値
APIの種類がtextの場合に指定可能な値
|
必須 |
<モデル名> |
||||
|
service: |
必須 |
- |
|||||
|
langchain: |
必須 |
- |
|||||
|
prompts: |
任意 |
- |
|||||
|
- |
name: |
プロンプト名を記載します。英語小文字にて指定。prompts内で一意となる値を指定します。 指定可能な値 半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
- |
|||
|
type: |
プロンプトのtypeを指定します。生成AIのAPIの種類に合わせて指定してください。 指定可能な値 chatまたはtext |
必須 |
- |
||||
|
tools: |
使用するツールの名前（tools.nameの値）をカンマ区切りで記載します。ツールを使用しない場合は空文字を指定します。 指定可能な値 半角英数字（小文字）とアンダースコア，カンマ 0〜4096文字 |
必須 |
- |
||||
|
tools: |
任意 |
- |
|||||
|
- |
name: |
ツールの名前です。tools内で一意となる値を指定します。変更できません。 指定可能な値 半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
user_contents |
|||
|
azure_ai_search: |
Azure AI Searchの接続先を記載します。 |
任意 |
- |
||||
|
endpoint: |
Azure AI SearchのAPIのエンドポイントを記載します。 指定可能な値 1〜256文字の下記形式 https://[\w/:%#\$&\?\(\)~\.=\+\-]+ |
必須 |
<エンドポイント> |
||||
|
index_name: |
Azure AI Searchのインデックス名を記載します。 指定可能な値 半角英数字とハイフン 1〜128文字 |
必須 |
<インデックス名> |
||||
|
ui: |
UIに関する設定を定義します。 |
任意 |
- |
||||
|
template: |
チャット画面の質問エリアに自動的に生成される質問文のテンプレートを定義します。変数（{message}）と制御文字（\n）を使用可能です。展開に失敗した場合は，"{message}"として展開されます。 {message}にはイベントメッセージが入り，イベントが複数存在する場合は改行で結合します。 設定値に空文字を指定した場合は質問文を生成しません。 指定可能な値 0〜4096文字 |
任意 |
"{message}\n状況を教えてください。" |
||||
|
chat: |
任意 |
- |
|||||
|
max_size: |
生成AIへ投げる質問の文字数です。 指定可能な値 1〜8192 |
任意 |
2048 |
||||
|
logs: |
ログに関する設定を定義します。 |
任意 |
- |
||||
|
filter: |
ログの出力抑止の有効化（true）／無効化（false）の設定です。 指定可能な値 trueまたはfalse |
任意 |
true |
||||