6.1.2 プロンプト定義ファイル（prompts.chat.ja.yml）
- 〈この項の構成〉
(1) 02-30以降
形式と記述内容が02-20以前と異なります。それ以外は02-20を参照してください。
形式
YAML形式で記述します。
agents:
knowledge_search_agent:
- name: プロンプト名
prefix:
- name: valueを識別するための任意の文字列
value: プロンプトに定義する文字列
format_instructions: AIの応答の型を支持する文字列
description: エージェントノードの説明
example: Supervisorが遷移先を決める際に利用するエージェントノードの利用例
custom_agent:
- name: プロンプト名
prefix:
- name: valueを識別するための任意の文字列
value: プロンプトに定義する文字列
format_instructions: AIの応答の型を支持する文字列
description: エージェントノードの説明
example: Supervisorが遷移先を決める際に利用するエージェントノードの利用例
operators:
secretary:
- name: プロンプト名
instruction: 動作指示記述内容
|
項目名 |
説明 |
必須／任意 |
||||
|---|---|---|---|---|---|---|
|
agents: |
エージェントノードに利用するプロンプト |
必須 |
||||
|
knowledge_search_agent: |
ナレッジ検索エージェントに利用するプロンプト |
必須 |
||||
|
- |
name: |
プロンプトの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.prompts.nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
|||
|
prefix: |
プロンプトの最初に記載する文字列です。配列を順番に結合し，文字列を作成します。 |
必須 |
||||
|
- |
name: |
項目prefix.valueを識別するための任意の文字列を指定します。 指定可能な値 半角英数字（小文字）とアンダースコア 1〜64文字 |
必須 |
|||
|
value: |
プロンプトに定義する文字列を指定します。 指定可能な値 半角英数字（小文字）とアンダースコア 1〜8192文字 |
必須 |
||||
|
format_instructions: |
AIの応答の型を指示する文字列を指定します。プレースホルダ"{tools_names}"を含む必要があります。"{tools_names}"には設定ファイル（ai_assistant.yml）で指定したservice.langchain.prompts.toolsで指定した値が展開されます。 指定可能な値 プレースホルダ"{tools_names}"を含む1〜8192文字 |
必須 |
||||
|
description: |
Supervisorが参照するエージェントノードの説明を指定します。Supervisorはこの説明を見て，エージェントノードを利用すべきか判断します。 指定可能な値 1〜1024文字 |
必須 |
||||
|
example: |
Supervisorが遷移先を決める際に利用するエージェントノードの利用例を指定します。Supervisorが遷移先を決める際の補足となる利用例を記載します。 指定可能な値 0〜1024文字 |
必須 |
||||
|
custom_agent: |
カスタムエージェントに利用するプロンプト |
必須 |
||||
|
- |
name: |
プロンプトの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.prompts.nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
|||
|
prefix: |
プロンプトの最初に記載する文字列です。配列を順番に結合し，文字列を作成します。 |
必須 |
||||
|
- |
name: |
項目prefix.valueを識別するための任意の文字列を指定します。 指定可能な値 半角英数字（小文字）とアンダースコア 1〜64文字 |
必須 |
|||
|
value: |
プロンプトに定義する文字列を指定します。 指定可能な値 1〜8192文字 |
必須 |
||||
|
format_instructions: |
AIの応答の型を指示する文字列を指定します。プレースホルダ"{tools_names}"の指定は任意です。展開される値は"knowledge_search_agent"と同様です。 指定可能な値 1〜8192文字 |
必須 |
||||
|
description: |
Supervisorが参照するエージェントノードの説明を指定します。Supervisorはこの説明を見て，エージェントノードを利用すべきか判断します。 指定可能な値 1〜1024文字 |
必須 |
||||
|
example: |
Supervisorが遷移先を決める際に利用するエージェントノードの利用例を指定します。Supervisorが遷移先を決める際の補足となる利用例を記載します。 指定可能な値 0〜1024文字 |
必須 |
||||
|
operators: |
オペレーターノードに利用するプロンプト |
任意 |
||||
|
secretary: |
Secretaryノードに利用するプロンプト |
任意 |
||||
|
- |
name: |
プロンプトの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.prompts.nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
|||
|
instruction |
各ノードに対する動作指示を記載します。ワークフローの構成やノードの活用方法に応じて適切な内容を記載する必要があります。 指定可能な値 1〜8192文字 |
必須 |
||||
デフォルト値は「付録B.2 02-30以降のプロンプトのデフォルト」を参照してください。
(2) 02-20以前
形式
YAML形式で記述します。
- name: プロンプト名
prefix:
- name: valueを識別するための任意の文字列
value: プロンプトに定義する文字列
format_instructions: AIの応答の型を指示する文字列ファイル
prompts.chat.ja.yml
定義ファイル編集機能画面のタブ名
aiassistant
説明
生成AI連携で使用するプロンプトを定義するファイルです。
文字コード
UTF-8（BOMなし）
改行コード
LF
定義の反映時期
JP1/IM3の定義ファイル操作機能を使ってアップロードした際に，プログラムが再起動して定義が反映されます。
記述内容
|
項目名 |
説明 |
必須／任意 |
||
|---|---|---|---|---|
|
- |
name: |
プロンプトの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.prompts.nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
|
|
prefix: |
プロンプトの最初に記載する文字列です。配列を順番に結合し，文字列を作成します。 |
必須 |
||
|
- |
name: |
項目prefix.valueを識別するための任意の文字列を指定します。 指定可能な値 半角英数字（小文字）とアンダースコア 1〜64文字 |
必須 |
|
|
value: |
プロンプトに定義する文字列を指定します。 指定可能な値 1〜8192文字 |
必須 |
||
|
format_instructions: |
AIの応答の型を指示する文字列を指定します。プレースホルダ"{tools_names}"を含む必要があります。"{tools_names}"には設定ファイル（ai_assistant.yml）で指定したservice.langchain.prompts.toolsで指定した値が展開されます。 指定可能な値 プレースホルダ"{tools_names}"を含む1〜8192文字 |
必須 |
||
デフォルト値は「付録B.3 02-20以前のプロンプトのデフォルト」を参照してください。