6.1.1 設定ファイル(ai_assistant.yml)
形式
YAML形式で記述します。
generative_ai:
azure:
- endpoint: Azure OpenAIのAPIのエンドポイント
models:
- name: Azure OpenAI で利用するモデルの名前
api:
type: Azure OpenAIのAPIの種類
version: Azure OpenAIのAPIのバージョン
temperature: Azure OpenAIのLLMの回答のランダム性
max_tokens: Azure OpenAI のLLMの回答の最大トークン数
deployment_name: Azure OpenAIのデプロイ名
model_name: Azure OpenAIのモデル名
aws:
- role_arn: Amazon Bedrockを実行するIAMロールのARN
external_id: Amazon Bedrockを実行するIAMロールの外部ID
endpoint_url: プライベート接続用のエンドポイントURL
models:
- name: Azure Bedrockで利用するモデルの名前
type: Amazon BedrockのAPIの種類
model_id: Amazon BedrockのモデルID
region_name: AWSのリージョン
role_session_name: AssumeRoleで指定するセッション名
custom_request_params:
- key: モデルのリクエストパラメータのキー
value: モデルのリクエストパラメータの値
service:
langchain:
prompts:
- name: プロンプト名
type: プロンプトのtype
tools: 使用するツールの名前
applied_node:
workflows: プロンプトを適用するノードが所属するワークフローの名前
node: プロンプトを適用するノードの識別子
tools:
- name: ツールの名前
azure_ai_search:
endpoint: Azure AI SearchのAPIのエンドポイント
index_name: Azure AI Searchのインデックス名
aws_knowledge_bases:
knowledge_base_id: Knowledge Bases for Amazon BedrockのID
role_arn: Knowledge Bases for Amazon Bedrock を実行するIAMロールのARN
external_id: Knowledge Bases for Amazon Bedrock を実行するIAMロールの外部ID
endpoint_url: プライベート接続用のエンドポイントURL
region_name: AWSのリージョン
role_session_name: AssumeRoleで指定するセッション名
aws_lambda_function:
function_name: AWS Lambda関数のARN
role_arn: AWS Lambda関数を実行するIAMロールのARN
external_id: AWS Lambda関数を実行するIAMロールの外部ID
endpoint_url: プライベート接続用のエンドポイントURL
region_name: AWSのリージョン
role_session_name: AssumeRoleで指定するセッション名
handle:
raise_function_processing_error: AWS Lambda関数処理中のエラー扱い
logging_start_info: AWS Lambda関数の呼び出し時のログ出力
logging_args_schema: AWS Lambda関数の実行引数作成に利用するJSONスキーマの出力
langgraph:
agents:
knowledge_search_agent:
llm_name: ナレッジ検索エージェントに利用するLLMの名前
event_analysis_agent:
llm_name: 運用管理データ取得エージェントに利用するLLMの名前
custom_agent:
llm_name: カスタムエージェントに利用するLLMの名前
workflows:
- name: ワークフローの名称
label: ワークフローの表示名
description: ワークフローの説明
nodes:
secretary:
llm_name: Secretaryノードに利用するLLMの名前
supervisor:
llm_name: Supervisorノードに利用するLLMの名前
child_agents: Supervisorが利用できるエージェントノード識別子
knowledge_search_agent:
- name: 利用するナレッジ検索エージェントの名前
event_analysis_agent:
- name: 利用する運用管理データ取得エージェントの名前
custom_agent:
- name: 利用するカスタムエージェントの名前
override_agent_parameter:
- key: 上書きするエージェントパラメータのキー
value: 上書きするエージェントパラメータの値
ui:
template: 質問文のテンプレート
jp1event_template: 質問文のうちJP1イベントに関するテンプレート
chat:
max_size: 質問の最大文字数
hyperlink:
- regexp: ハイパーリンク化する文字列の正規表現
replace: ハイパーリンク化する文字列の置換後の表示名
logs:
filter: ログの出力抑止の有効化または無効化ファイル
ai_assistant.yml
定義ファイル編集機能画面のタブ名
aiassistant
説明
生成AI連携の設定ファイルです。生成AI及びドキュメント検索エンジンの接続情報や,画面設定を定義します。
文字コード
UTF-8(BOMなし)
改行コード
LF
定義の反映時期
JP1/IM3の定義ファイル操作機能を使ってアップロードした際に,プログラムが再起動して定義が反映されます。
記述内容
|
項目名 |
説明 |
必須/任意 |
デフォルト値※ |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
generative_ai: |
生成AI関連の接続先を記載します。 |
必須 |
- |
||||||||
|
azure: |
Azure OpenAI Serviceの接続先を記載します。02-20以前はgenerative_ai.awsとどちらか片方のみ設定できます。 |
任意 |
- |
||||||||
|
- |
endpoint: |
Azure OpenAI APIのエンドポイントを記載します。02-20以前は1つのみ指定可能です。 指定可能な値 1〜256文字の下記形式 https?://[a-zA-Z0-9_/:%#\$&\?()~.=+-]+|endpoint |
必須 |
- |
|||||||
|
models: |
生成AIモデルの情報を記載します。02-20以前は1つのみ指定可能です。 |
必須 |
- |
||||||||
|
- |
name: |
02-30以降で定義可能。使用するLLMに生成AI連携機能内で利用する名前を指定します。重複した値が存在する場合,いずれか一つが利用されます。 指定可能な値 "azure_"で始まる,半角英数字とハイフン,アンダースコア 1〜128文字 |
必須 |
- |
|||||||
|
api: |
使用するAPIについて記載します。 |
必須 |
|||||||||
|
type: |
使用するAPIの種類を記載します。チャット入力候補(Chat Completion)のみ使用することができ,chatを指定します。各モデルで利用可能なAPIの種類はAzureの公式ドキュメントを参照してください。 指定可能な値 chat |
必須 |
- |
||||||||
|
version: |
使用するAPIのバージョンを指定します。設定ファイルの初期値では"2023-05-15"を指定しています。 指定可能な値 半角英数字とハイフン 1〜32文字 |
必須 |
- |
||||||||
|
temperature |
02-40以降で定義可能。LLMの回答のランダム性を指定します。 指定可能な値 0.0〜1.0 |
任意 |
1 |
||||||||
|
max_tokens |
02-30以降で定義可能。LLMの回答の最大トークン数を指定します。 指定可能な値 1〜8192 |
任意 |
2048 |
||||||||
|
deployment_name: |
Azure OpenAIのデプロイ名を記載します。 指定可能な値 半角英数字とハイフン,アンダースコア 1〜128文字 |
必須 |
- |
||||||||
|
model_name: |
Azure OpenAIのモデル名を記載します。 指定可能な値
|
必須 |
- |
||||||||
|
aws |
Amazon Bedrockの接続先を記載します。02-20以前はgenerative_ai.azureとどちらか片方のみ設定できます。 |
任意 |
- |
||||||||
|
- |
role_arn: |
Amazon Bedrockを実行するIAMロールのAmazonリソースネーム(ARN)を指定します。 指定可能な値 半角英数字とコロン,スラッシュ,ハイフン,アンダースコア 1〜255文字 |
必須 |
- |
|||||||
|
external_id: |
Amazon Bedrockを実行するIAMロールのAssumeRoleの条件に外部IDを指定している場合は,その外部IDを指定します。 指定可能な値 半角英数字と以下の記号 「+」,「=」,「,」,「.」,「@」,「:」,「/」,「-」 2〜1224文字 |
任意 |
- |
||||||||
|
endpoint_url: |
Amazon Bedrockとプライベート接続する場合に,プライベート接続用のエンドポイントURLを指定します。 指定可能な値 1〜256文字の下記形式 https?://vpce-[a-zA-Z0-9_/:%#\$&\?()~.=+-] |
任意 |
- |
||||||||
|
models: |
生成AIモデルの情報を記載します。02-20以前は1つのみ指定可能です。 |
必須 |
- |
||||||||
|
- |
name: |
02-30以降で定義可能。使用するLLMに生成AI連携機能内で利用する名前を指定します。重複した値が存在する場合,いずれか一つが利用されます。 指定可能な値 "aws_"で始まる,半角英数字とハイフン,アンダースコア 1〜128文字 |
必須 |
||||||||
|
type: |
使用するAPIの種類を指定します。AnthropicClaudeメッセージAPIのみ使用することができ,chatを指定します。各モデルで利用可能なAPIの種類はAWS公式ドキュメントを参照してください。 指定可能な値 chat |
必須 |
- |
||||||||
|
model_id: |
Amazon BedrockのモデルIDまたはクロスリージョン推論のプロファイルIDを記載します。 指定可能な値
|
必須 |
- |
||||||||
|
region_name: |
Amazon Bedrockのリージョンを指定します。クロスリージョン推論を利用する場合は,ソースリージョンを指定します。指定可能な値はリージョン一覧を参照してください。 |
必須 |
- |
||||||||
|
role_session_name: |
AssumeRoleの際に指定するセッション名を指定します。 指定可能な値 以下の正規表現に当てはまる値 [a-zA-Z0-9_+=,.@-]* 2〜64文字 |
任意 |
"jp1cs-genai-bedrock-session-name" |
||||||||
|
custom_request_param |
本設定値は02-30以降で定義可能。 |
任意 |
|||||||||
|
- |
key |
リクエストパラメータのキー。Anthropic Claude系の以下が指定できます。 指定可能な値
|
必須 |
||||||||
|
value |
リクエストパラメータの値。keyに対応するAnthropic Claude系のパラメータを指定します。 指定可能な値
|
必須 |
max_tokens: 2048 temperature: 1.0 |
||||||||
|
service: |
必須 |
- |
|||||||||
|
langchain: |
任意 |
- |
|||||||||
|
prompts: |
任意 |
- |
|||||||||
|
- |
name: |
プロンプト定義ファイルで定義したプロンプト名を英語小文字にて指定します。prompts内で一意となる値を指定します。 指定可能な値 "_"で始まらない半角英数字(小文字)とアンダースコア 1〜128文字 |
必須 |
||||||||
|
type: |
プロンプトのtypeを指定します。生成AIのAPIの種類に合わせて指定する必要があり,chatのみ指定できます。 指定可能な値 chat |
必須 |
|||||||||
|
tools: |
使用するツールの名前(tools.nameの値)をカンマ区切りで記載します。ツールを使用しない場合は空文字を指定します。 指定可能な値 半角英数字(小文字)とアンダースコア,カンマ 0〜4096文字 |
必須 |
|||||||||
|
applied_node: |
本設定値は02-30以降で定義可能。 |
必須 |
|||||||||
|
workflows: |
プロンプトを適用するノードが所属するワークフローの名前。 指定可能な値 半角英数字(小文字)とアンダースコア 1〜128文字のリスト |
必須 |
|||||||||
|
node: |
プロンプトを適用するノードの識別子。 指定可能な値 knowledge_search_agent, event_analysis_agent, secretary, supervisorまたは半角英数字(小文字)とアンダースコア 1〜64文字 |
必須 |
|||||||||
|
tools: |
任意 |
- |
|||||||||
|
- |
name: |
ツールの名前です。tools内で一意となる値を指定します。変更できません。 指定可能な値 "_"で始まらない半角英数字(小文字)とアンダースコア 1〜128文字 |
必須 |
- |
|||||||
|
azure_ai_search: |
Azure AI Searchの接続先を記載します。Azure AI Search検索ツールを利用する場合は本項目を指定します。 |
任意 |
- |
||||||||
|
endpoint: |
Azure AI SearchのAPIのエンドポイントを記載します。 指定可能な値 1〜256文字の下記形式 https?://[a-zA-Z0-9_/:%#\$&\?()~.=+-]+|endpoint |
必須 |
- |
||||||||
|
index_name: |
Azure AI Searchのインデックス名を記載します。 指定可能な値 半角英数字とハイフン 1〜128文字 |
必須 |
- |
||||||||
|
aws_knowledge_bases: |
Knowledge Bases for Amazon Bedrockの接続先を記載します。配列の同じ要素にazure_ai_searchが設定されている場合は無効になります。Knowlede Bases for Amazon Bedrock検索ツールを利用する場合は本項目を指定します。 |
任意 |
- |
||||||||
|
knowledge_base_id: |
Knowledge Bases for Amazon BedrockのIDを指定します。 指定可能な値 半角英数字 1〜10文字 |
必須 |
- |
||||||||
|
role_arn: |
Knowledge Bases for Amazon Bedrockを実行するIAMロールのAmazonリソースネーム(ARN)指定します。 指定可能な値 半角英数字とコロン,スラッシュ,ハイフン,アンダースコア 1〜255文字 |
必須 |
- |
||||||||
|
external_id: |
Knowledge Bases for Amazon Bedrockを実行するIAMロールのAssumeRoleの条件に外部IDを指定している場合は,その外部IDを指定します。 指定可能な値 半角英数字と以下の記号 「+」,「=」,「,」,「.」,「@」,「:」,「/」,「-」 2〜1224文字 |
任意 |
- |
||||||||
|
endpoint_url: |
Knowledge Bases for Amazon Bedrockとプライベート接続する場合に,プライベート接続用のエンドポイントURLを指定します。 指定可能な値 1〜256文字の下記形式 https?://vpce-[a-zA-Z0-9_/:%#\$&\?()~.=+-]+ |
任意 |
- |
||||||||
|
region_name: |
Knowledge Base for Amazon Bedrockのリージョンを指定します。指定可能な値はリージョン一覧を参照してください。 |
必須 |
- |
||||||||
|
role_session_name: |
AssumeRoleの際に指定するセッション名を指定します。 指定可能な値 以下の正規表現に当てはまる値 [a-zA-Z0-9_+=,.@-]* 2〜64文字 |
任意 |
"jp1cs-genai-aws-kb-session-name" |
||||||||
|
aws_lambda_function: |
AWS Lambdaの接続情報を指定します。ユーザープログラム呼び出しツールを利用する場合は本項目を指定します。 |
任意 |
|||||||||
|
function_name: |
実行対象のLambda関数の完全修飾されたARNを指定します。関数のバージョンは任意項目です。省略した場合,最新版が指定されます。 指定可能な値 `arn:<パーティション>:lambda:<リージョン名>:<AWSアカウントID>:function:<関数名>:<バージョン ※任意>`の形式の文字列。 半角英数字とコロン,スラッシュ,ハイフン,アンダースコア 1〜140文字 |
必須 |
|||||||||
|
role_arn: |
AWS Lambda関数を実行するIAMロールのAmazonリソースネーム(ARN)指定します。 指定可能な値 半角英数字とコロン,スラッシュ,ハイフン,アンダースコア 1〜255文字 |
必須 |
|||||||||
|
external_id: |
AWS Lambda関数を実行するIAMロールのAssumeRoleの条件に外部IDを指定している場合は,その外部IDを指定します。 指定可能な値 半角英数字と以下の記号 「+」,「=」,「,」,「.」,「@」,「:」,「/」,「-」 2〜1224文字 |
任意 |
|||||||||
|
endpoint_url: |
AWS Lambda関数とプライベート接続する場合に,プライベート接続用のエンドポイントURLを指定します。 指定可能な値 1〜256文字の下記形式 https?://vpce-[a-zA-Z0-9_/:%#\$&\?()~.=+-]+ |
任意 |
|||||||||
|
region_name: |
AWS Lambda関数のリージョンを指定します。指定可能な値はリージョン一覧を参照してください。 |
必須 |
|||||||||
|
role_session_name: |
AssumeRoleの際に指定するセッション名を指定します。 指定可能な値 以下の正規表現に当てはまる値 [a-zA-Z0-9_+=,.@-]* 2〜64文字 |
任意 |
jp1cs-genai-aws-lambda-session-name |
||||||||
|
handle: |
AWS Lambda関数実行時の挙動を指定できます。 |
任意 |
|||||||||
|
raise_function_processing_error: |
AWS Lambda関数の処理中に発生したエラーを異常系として扱うかの設定。 指定可能な値 true(異常系として扱う),false(正常系として扱う) |
任意 |
true |
||||||||
|
logging_start_info: |
AWS Lambda関数の実行時の問い合わせ実行識別子とツール識別子をログに出力するかの設定 指定可能な値 true(出力する),false(出力しない) |
任意 |
true |
||||||||
|
logging_args_schema: |
AWS Lambda関数の実行変数作成時にJSONスキーマをログに出力するかの設定 指定可能な値 true(出力する),false(出力しない) |
任意 |
false |
||||||||
|
langgraph: |
本設定値は02-30以降で定義可能。 |
必須 |
|||||||||
|
agents: |
エージェントノードに関する設定 |
任意 |
|||||||||
|
knowledge_search_agent: |
ナレッジ検索エージェントの共通設定 |
任意 |
|||||||||
|
llm_name |
ナレッジ検索エージェントに利用するLLMの名前 指定可能な値 半角英数字とアンダースコア 1〜128文字 |
必須 |
|||||||||
|
event_analysis_agent |
運用管理データ取得エージェントの共通設定 |
任意 |
|||||||||
|
llm_name |
運用管理データ取得エージェントに利用するLLMの名前 指定可能な値 半角英数字とアンダースコア 1〜128文字 |
必須 |
|||||||||
|
custom_agent: |
カスタムエージェントの共通設定 |
任意 |
|||||||||
|
llm_name: |
カスタムエージェントに利用するLLMの名前 指定可能な値 半角英数字とアンダースコア 1〜128文字 |
必須 |
|||||||||
|
workflows: |
必須 |
||||||||||
|
- |
name: |
ワークフローの名称 指定可能な値 "_"で始まらない半角英数字(小文字)とアンダースコア 1〜128文字 |
必須 |
||||||||
|
label: |
ワークフローの表示名 指定可能な値 1〜128文字 |
必須 |
|||||||||
|
description: |
ワークフローの説明 指定可能な値 1〜512文字 |
必須 |
|||||||||
|
nodes: |
必須 |
||||||||||
|
secretary |
必須 |
||||||||||
|
llm_name: |
Secretaryノードに利用するLLMの名前 指定可能な値 半角英数字とアンダースコア 1〜128文字 |
必須 |
|||||||||
|
supervisor: |
任意 |
||||||||||
|
llm_name: |
Supervisorノードに利用するLLMの名前 指定可能な値 半角英数字とアンダースコア 1〜128文字 |
必須 |
|||||||||
|
child_agents: |
Supervisorが利用できるエージェントノード。02-30ではリストで指定します。02-40以降は以降のパラメータで指定します。 02-30で指定可能な値 knowledge_search_agent, event_analysis_agent |
必須 |
|||||||||
|
knowledge_search_agent: |
Supervisorが利用できるナレッジ検索エージェントを指定します。 |
任意 |
|||||||||
|
- |
name: |
ナレッジ検索エージェントの名前を指定します。 指定できる値 knowledge_search_agent |
必須 |
||||||||
|
event_analysis_agent: |
Supervisorが利用できる運用管理データ取得エージェントを指定します。 |
任意 |
|||||||||
|
- |
name: |
運用管理データ取得エージェントの名前を指定します。 指定できる値 event_analysis_agent |
必須 |
||||||||
|
custom_agent: |
Supervisorが利用できるカスタムエージェントを指定します。 |
任意 |
|||||||||
|
- |
name: |
カスタムエージェントの名前を指定します。 指定できる値 secretary, supervisor, knowledge_search_agent, event_analysis_agent以外の,"_"で始まらない半角英数字(小文字)とアンダースコア 1〜64文字 |
必須 |
||||||||
|
override_agent_parameter: |
上書きするカスタムエージェントのパラメータ |
任意 |
|||||||||
|
- |
key: |
カスタムエージェントの上書きするパラメータ名 指定可能な値 llm_name |
必須 |
||||||||
|
value: |
カスタムエージェントの上書きするパラメータの値 指定可能な値 半角英数字とアンダースコア 1〜128文字 |
必須 |
|||||||||
|
ui: |
UIに関する設定を定義します。 |
任意 |
- |
||||||||
|
template: |
チャット画面の質問エリアに自動的に生成される質問文のテンプレートを定義します。変数({jp1events})と制御文字(\n)を使用可能です。展開に失敗した場合は,変数が文字列("{jp1events}"など)"として展開されます。 {jp1events}にはjp1event_templateで指定した内容が入り,イベントが複数存在する場合は改行で結合します。 設定値に空文字を指定した場合は質問文を生成しません。 指定可能な値 0〜4096文字 |
任意 |
"{jp1events}\n状況を教えてください。" |
||||||||
|
jp1event_template |
チャット画面の質問エリアに自動的に生成される質問文のテンプレート(ui.template)で{jp1events}を指定した場合に挿入する内容のテンプレートを指定します。 変数と制御文字(¥n)が使用可能です。変数を指定する場合は{}で囲む必要があります。 変数には以下のJP1イベントの属性が指定可能です。 B.ID, B.MESSAGE, B.SEQNO, B.TIME, E.JP1_SOURCEHOST, E.OBJECT_TYPE, E.SEVERITY, E.USER_NAME |
任意 |
"{B.MESSAGE}" |
||||||||
|
chat: |
任意 |
- |
|||||||||
|
max_size: |
生成AIへ投げる質問の文字数です。 指定可能な値 1〜8192 |
任意 |
2048 |
||||||||
|
hyperlink: |
ハイパーリンク化に関する情報を定義します。最大10件まで指定可能です。 |
任意 |
- |
||||||||
|
- |
regexp: |
ハイパーリンク化する文字列を指定します。 指定可能な値 1〜128文字 |
必須 |
0: "\\[document_url:\\s*(https?:\\/\\/[^\\[\\]]*)\\] " |
|||||||
|
- |
replace: |
ハイパーリンク化する文字列の置換後の表示名を指定します。 指定可能な値 1〜128文字 |
必須 |
0: " [document_url: URL] " |
|||||||
|
logs: |
ログに関する設定を定義します。 |
任意 |
- |
||||||||
|
filter: |
ログの出力抑止の有効化(true)/無効化(false)の設定です。 指定可能な値 trueまたはfalse |
任意 |
true |
||||||||
注※ 設定ファイルのデフォルト値ではなく,指定がない場合に利用されるデフォルト値です。
リージョン一覧
us-east-1, us-east-2, us-west-1, us-west-2, af-south-1, ap-east-1, ap-south-2, ap-southeast-3, ap-southeast-5, ap-southeast-4, ap-south-1, ap-northeast-3, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-east-2, ap-southeast-7, ap-northeast-1, ca-central-1, ca-west-1, eu-central-1, eu-west-1, eu-west-2, eu-south-1, eu-west-3, eu-south-2, eu-north-1, eu-central-2, il-central-1, mx-central-1, me-south-1, me-central-1, sa-east-1