6.1.3 ツールプロンプト定義ファイル（tools.ja.yml）（02-40以降）
形式
YAML形式で記述します。
azure_ai_search: Azure AI Search検索ツールのツールプロンプト定義
- name: ツールの名前
description: ツールの説明
aws_knowledge_bases: Knowledge Bases for Amazon Bedrock検索ツールのツールプロンプト定義
- name: ツールの名前
description: ツールの説明
aws_lambda_fucntions: ユーザープログラム呼び出しツールのツールプロンプト定義
- name: ツールの名前
description: ツールの説明
args: ツールの引数
- field_name: 引数の名前
schema: 引数のJSONスキーマ
title: 引数のタイトル
description: 引数の説明
annotation: 引数の型情報
{型に依存した設定}
nest: オブジェクト型引数の型情報
- field_name: 引数の名前
schema: 引数のJSONスキーマ
title: 引数のタイトル
description: 引数の説明
annotation: 引数の型情報
{型に依存した設定}ファイル
tools.chat.ja.yml
定義ファイル編集機能画面のタブ名
aiassistant
説明
生成AI連携で使用するプロンプトを定義するファイルです。
文字コード
UTF-8（BOMなし）
改行コード
LF
定義の反映時期
JP1/IM3の定義ファイル操作機能を使ってアップロードした際に，プログラムが再起動して定義が反映されます。
記述内容
|
項目名 |
説明 |
必須／任意 |
|||||
|---|---|---|---|---|---|---|---|
|
azure_ai_search: |
Azure AI Search検索ツールのプロンプト群 |
任意 |
|||||
|
- |
name: |
ツールの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.tools[].nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
||||
|
description: |
ツールの説明を指定します。 指定可能な値 1〜4096文字 |
必須 |
|||||
|
aws_knowledge_bases: |
Knowledge Bases for Amazon Bedrock検索ツールのプロンプト群 |
任意 |
|||||
|
- |
name: |
ツールの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.tools[].nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
||||
|
description: |
ツールの説明を指定します。 指定可能な値 1〜4096文字 |
必須 |
|||||
|
aws_lambda_function: |
ユーザープログラム呼び出しツールのプロンプト群 |
任意 |
|||||
|
- |
name: |
ツールの識別名を指定します。設定ファイル（ai_assistant.yml）のservice.langchain.tools[].nameで指定した値を指定します。 指定可能な値 "_"で始まらない半角英数字（小文字）とアンダースコア 1〜128文字 |
必須 |
||||
|
description: |
ツールの説明を指定します。 指定可能な値 1〜4096文字 |
必須 |
|||||
|
args: |
ツールの引数設定。引数は16個まで定義できます。 |
必須 |
|||||
|
- |
field_name: |
引数の名前 指定可能な値 先頭と末尾が"_"になっておらず，かつ，"model_config"という名前ではない半角英字とアンダースコア。 1〜32文字 |
必須 |
||||
|
schema: |
引数のJSONスキーマ設定 |
必須 |
|||||
|
- |
title: |
JSONスキーマのtitle情報。引数を端的に表す文字列を指定する。任意であり，JSONスキーマをログ出力した際にわかりやすくするために利用できる。 |
任意 |
||||
|
description: |
JSONスキーマのdescription情報。引数の説明を指定する。 |
必須 |
|||||
|
annotation: |
引数の型アノテーション定義 |
必須 |
|||||
|
specify_type: |
引数の型を指定します。specify_typeに指定できる内容は指定できる型情報を参照してください。 |
必須 |
|||||
|
specify_opt: |
引数に対するオプションを指定します。 |
||||||
|
required: |
引数の必須か指定します。 指定できる値 true（必須），false（任意） |
必須 |
|||||
|
nullable: |
引数にnullを許可するか指定します。 指定できる値 true（nullを許可），false（nullを許可しない） |
必須 |
|||||
|
nest: |
object型の引数の要素を設定します。specify_typeにobject型またはobject_array型を指定した場合のみ指定可能です。 |
任意 |
|||||
|
- |
field_name: |
argsのfield_nameと同じです。 |
同左 |
||||
|
schema: |
argsのschemaと同じです。 |
同左 |
|||||
|
title |
argsのschema.titleと同じです。 |
同左 |
|||||
|
description |
argsのschema.descriptionと同じです。 |
同左 |
|||||
|
annotation: |
argsのannotationと同じです。 |
同左 |
|||||
|
specify_type: |
argsのannotation.specify_typeと同じです。ただし指定できる型はstring型，integer型，number型，boolean型，enum型，array型です。 |
同左 |
|||||
|
specify_opt: |
argsのannotation.specify_optと同じです。 |
同左 |
|||||
|
required: |
argsのannotation.specify_opt.requiredと同じです。 |
同左 |
|||||
|
nullable: |
argsのannotation.specify_opt.nullableと同じです。 |
同左 |
|||||
デフォルト値は「付録B.3 02-20以前のプロンプトのデフォルト」を参照してください。
指定できる型情報
annotation.specify_typeに指定可能な型と，指定できる情報を以下に示します。
引数の型としてstring型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。 指定可能な値 string |
必須 |
|
|
max: |
最大文字数を指定します。 指定可能な値 1〜102400 |
任意 |
|
|
min: |
最小文字数を指定します。 指定可能な値 1〜102400 |
任意 |
|
引数の型としてinteger型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。 指定可能な値 integer |
必須 |
|
|
max: |
最大値を指定します。 指定可能な値 -9223372036854775808〜9223372036854775807 |
任意 |
|
|
min: |
最小値を指定します。 指定可能な値 -9223372036854775808〜9223372036854775807 |
任意 |
|
引数の型としてnumber型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。 指定可能な値 number |
必須 |
|
|
max: |
最大値を指定します。整数部分と小数部分が合計で15桁以内になるように指定します。 指定可能な値 - 999999999999999〜999999999999999 |
任意 |
|
|
min: |
最小値を指定します。整数部分と小数部分が合計で15桁以内になるように指定します。 指定可能な値 -999999999999999〜999999999999999 |
任意 |
|
引数の型としてboolean型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。 指定可能な値 boolean |
必須 |
|
引数の型としてenum型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。 指定可能な値 enum |
必須 |
|
|
enum_value |
enumとして指定可能な値のリスト。文字列または整数どちらか一方の要素を指定できます。 指定可能な値 文字列のenumの場合は1〜32文字 整数のenumの場合は-9223372036854775808〜9223372036854775807 配列の要素数は1〜32個 |
必須 |
|
引数の型としてarray型を指定
|
項目名 |
説明 |
必須／任意 |
||
|---|---|---|---|---|
|
specify_type: |
必須 |
|||
|
field_type: |
型を指定します。 指定可能な値 array |
必須 |
||
|
content_annotation: |
配列の要素の型を指定します。指定しない場合，任意の型を許容します。 |
任意 |
||
|
field_type: |
要素の型を指定します。 指定できる値 string, integer, number, enum |
必須 |
||
|
max: |
string, integer, numberを指定した場合は指定します。指定できる値は指定できる型情報と同じです。 |
必須 |
||
|
min: |
string, integer, numberを指定した場合は指定します。指定できる値は指定できる型情報と同じです。 |
必須 |
||
|
enum_value: |
enumを指定した場合は指定します。指定できる値は指定できる型情報と同じです。 |
必須 |
||
|
max: |
配列の要素数の最大を指定します。 指定可能な値 1〜1024 |
任意 |
||
|
min: |
配列の要素数の最小を指定します。 指定可能な値 1〜1024 |
任意 |
||
引数の型としてobject型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。object型変数の中身はnestに指定します。 指定可能な値 object |
必須 |
|
引数の型としてobject_array型を指定
|
項目名 |
説明 |
必須／任意 |
|
|---|---|---|---|
|
specify_type: |
必須 |
||
|
field_type: |
型を指定します。object型変数の中身はnestに指定します。 指定可能な値 object_array |
必須 |
|
|
max: |
配列の要素数の最大を指定します。 指定可能な値 1〜1024 |
任意 |
|
|
min: |
配列の要素数の最小を指定します。 指定可能な値 1〜1024 |
任意 |
|