5. 組み込みブロッククラスの仕様

組み込みブロッククラスとは，DialBBにあらかじめ含まれているブロッククラスです．

5.1. Japanese Canonicalizer （日本語文字列正規化ブロック）

(dialbb.builtin_blocks.preprocess.japanese_canonicalizer.JapaneseCanonicalizer)

入力文字列の正規化を行います．

5.1.1. 入出力

入力
- input_text: 入力文字列（文字列）
  - 例："ＣＵＰ Noodle 好き"
出力
- output_text: 正規化後の文字列（文字列）
  - 例："cupnoodle好き"

5.1.2. 処理内容

入力文字列に対して以下の処理を行います．

前後のスペースの削除
英大文字→英小文字
改行の削除
全角→半角の変換（カタカナを除く）
スペースの削除
Unicode正規化（NFKC）

5.2. Simple Canonicalizer （単純文字列正規化ブロック）

(dialbb.builtin_blocks.preprocess.simple_canonicalizer.SimpleCanonicalizer)

ユーザ入力文の正規化を行います．主に英語が対象です．

5.2.1. 入出力

入力
- input_text: 入力文字列（文字列）
  - 例：" I like ramen"
出力
- output_text: 正規化後の文字列（文字列）
  - 例："i like ramen"

5.2.2. 処理内容

入力文字列に対して以下の処理を行います．

前後のスペースの削除
英大文字→英小文字
改行の削除
スペースの連続を一つのスペースに変換

5.3. LR-CRF Understander （ロジスティック回帰と条件付き確率場を用いた言語理解ブロック）

(dialbb.builtin_blocks.understanding_with_lr_crf.lr_crf_understander.Understander）

ロジスティック回帰と条件付き確率場を用いて，ユーザ発話タイプ（インテントとも呼びます）の決定とスロットの抽出を行います．

コンフィギュレーションのlanguage要素がjaの場合は日本語，enの場合は英語の言語理解を行います．

本ブロックは，起動時にExcelで記述した言語理解用知識を読み込み，ロジスティック回帰と条件付き確率場のモデルを学習します．

実行時は，学習したモデルを用いて言語理解を行います．

5.3.1. 入出力

入力
- input_text: 入力文字列
入力文字列は正規化されていると仮定します．

例："好きなのは醤油"

出力

nlu_result: 言語理解結果（辞書型または辞書型のリスト）

後述のブロックコンフィギュレーションのパラメータnum_candidatesが1の場合，言語理解結果は辞書型で以下のような形式です．

 {
 "type": <ユーザ発話タイプ（インテント）>, 
   "slots": {
    <スロット名>: <スロット値>, 
  ..., 
  <スロット名>: <スロット値>
 }
}

以下が例です．

 {
 "type": "特定のラーメンが好き", 
 "slots": {
    "favorite_ramen": "醤油ラーメン"
 }
 }

num_candidatesが2以上の場合，複数の理解結果候補のリストになります．

 [
 {
   "type": <ユーザ発話タイプ（インテント）>, 
     "slots": {
     <スロット名>: <スロット値>, 
	 ..., 
	 <スロット名>: <スロット値>
 }
},
  {
  "type": <ユーザ発話タイプ（インテント）>, 
    "slots": {
  <スロット名>: <スロット値>, 
  ..., 
  <スロット名>: <スロット値>
  }
},
  ....
]

5.3.2. ブロックコンフィギュレーションのパラメータ

knowledge_file（文字列）

知識を記述したExcelファイルを指定します．コンフィギュレーションファイルのあるディレクトリからの相対パスで記述します．
flags_to_use（文字列のリスト）

各シートのflagカラムにこの値のうちのどれかが書かれていた場合に読み込みます．このパラメータがセットされていない場合はすべての行が読み込まれます．
num_candidates（整数．デフォルト値1）

言語理解結果の最大数（n-bestのn）を指定します．
canonicalizer

辞書記述を正規化する際に使うプログラムを指定します．
- class （文字列）
  
  正規化のブロックのクラスを指定します．基本的にアプリケーションで用いる正規化のブロックと同じものを指定します．
knowledge_google_sheet (ハッシュ)
- Excelの代わりにGoogle Sheetsを用いる場合の情報を記述します．（Google Sheetsを利用する際の設定はこはたさんの記事が参考になりますが，Google Cloud Platformの設定画面のUIがこの記事とは多少変わっています．）
  - sheet_id （文字列）
    
    Google SheetのIDです．
  - key_file（文字列）
    
    Goole Sheet APIにアクセスするためのキーファイルをコンフィギュレーションファイルのディレクトリからの相対パスで指定します．

5.3.3. 言語理解知識

言語理解知識は，以下の2つのシートからなります．

シート名	内容
utterances	タイプ毎の発話例
slots	スロットとエンティティの関係および同義語のリスト

シート名はブロックコンフィギュレーションで変更可能ですが，変更することはほとんどないと思いますので，詳細な説明は割愛します．

5.3.3.1. utterancesシート

各行は次のカラムからなります．

flag

利用するかどうかを決めるフラグ．Y (yes), T (test)などを書くことが多いです．どのフラグの行を利用するかはコンフィギュレーションに記述します．サンプルアプリのコンフィギュレーションでは，すべての行を使う設定になっています．
type

発話のタイプ（インテント）
utterance

発話例．
slots

発話に含まれるスロット．スロットを以下の形で記述します．
```
<スロット名>=<スロット値>, <スロット名>=<スロット値>, ... <スロット名>=<スロット値> 
```
以下が例です．
```
地方=札幌, 好きなラーメン=味噌ラーメン
```
utterancesシートのみならずこのブロックで使うシートにこれ以外のカラムがあっても構いません．

5.3.3.2. slotsシート

各行は次のカラムからなります．

flag

utterancesシートと同じ
slot name

スロット名．utterancesシートの発話例で使うもの．言語理解結果でも用います．
entity

辞書エントリー名．言語理解結果に含まれます．
synonyms

同義語を','で連結したものです．

5.4. ChatGPT Understander （ChatGPTを用いた言語理解ブロック）

(dialbb.builtin_blocks.understanding_with_chatgpt.chatgpt_understander.Understander）

OpenAI社のChatGPTを用いて，ユーザ発話タイプ（インテントとも呼びます）の決定とスロットの抽出を行います．

コンフィギュレーションのlanguage要素がjaの場合は日本語，enの場合は英語の言語理解を行います．

本ブロックは，起動時にExcelで記述した言語理解用知識を読み込み，プロンプトのユーザ発話タイプのリスト，スロットのリスト，Few shot exampleに変換します．

実行時は，プロンプトに入力発話を付加してChatGPTに言語理解を行わせます．

5.4.1. 入出力

入力
- input_text: 入力文字列
入力文字列は正規化されていると仮定します．

例："好きなのは醤油"

出力

nlu_result: 言語理解結果（辞書型）

以下の形式

{
  "type": <ユーザ発話タイプ（インテント）>, 
  "slots": {
     <スロット名>: <スロット値>, 
     ..., 
     <スロット名>: <スロット値>
    }
}

以下が例です．

{
  "type": "特定のラーメンが好き", 
  "slots": {
     "favorite_ramen": "醤油ラーメン"
  }
}

5.4.2. ブロックコンフィギュレーションのパラメータ

knowledge_file（文字列）

知識を記述したExcelファイルを指定します．コンフィギュレーションファイルのあるディレクトリからの相対パスで記述します．
flags_to_use（文字列のリスト）

各シートのflagカラムにこの値のうちのどれかが書かれていた場合に読み込みます．このパラメータがセットされていない場合はすべての行が読み込まれます．
canonicalizer

辞書記述を正規化する際に使うプログラムを指定します．
- class （文字列）
  
  正規化のブロックのクラスを指定します．基本的にアプリケーションで用いる正規化のブロックと同じものを指定します．
knowledge_google_sheet (ハッシュ)
- Excelの代わりにGoogle Sheetを用いる場合の情報を記述します．（Google Sheetを利用する際の設定はこはたさんの記事が参考になりますが，Google Cloud Platformの設定画面のUIがこの記事とは多少変わっています．）
  - sheet_id （文字列）
    
    Google SheetのIDです．
  - key_file（文字列）
    
    Goole Sheet APIにアクセスするためのキーファイルをコンフィギュレーションファイルのディレクトリからの相対パスで指定します．
gpt_model (文字列．デフォルト値はgpt-4o-mini）

ChatGPTのモデルを指定します．gpt-4oなどが指定できます．
prompt_template

プロンプトテンプレートを書いたファイルをコンフィギュレーションファイルのディレクトリからの相対パスで指定します．

これが指定されていない場合は，dialbb.builtin_blocks.understanding_with_chatgpt.prompt_template_ja.PROMPT_TEMPLATE_JA （日本語）または，dialbb.builtin_blocks.understanding_with_chatgpt.prompt_template_en.PROMPT_TEMPLATE_EN （英語）が使われます．

プロンプトテンプレートは，言語理解をChatGPTに行わせるプロンプトのテンプレートで，@で始まる以下の変数を含みます．
- @types 発話タイプの種類を列挙したものです．
- @slot_definitions スロットの種類を列挙したものです．
- @examples 発話例と，タイプ，スロットの正解を書いた，いわゆるfew shot exampleです．
- @input 入力発話です．
これらの変数には，実行時に値が代入されます．

5.4.3. 言語理解知識

本ブロックの言語理解知識の記述形式は，LR-CRF Understanderの言語理解知識の記述形式と全く同じです．詳細はLR-CRF Understanderの説明の5.3.3 章を参照してください．

5.5. STN manager （状態遷移ネットワークベースの対話管理ブロック）

(dialbb.builtin_blocks.stn_manager.stn_management)

状態遷移ネットワーク(State-Transition Network)を用いて対話管理を行います．

入力
- sentence: 正規化後のユーザ発話（文字列）
- nlu_result:言語理解結果（辞書型または辞書型のリスト）
- user_id: ユーザID（文字列）
- aux_data: 補助データ（辞書型）（必須ではありませんが指定することが推奨されます）
出力
- output_text: システム発話（文字列）例：
```
"醤油ラーメン好きなんですね"
```
- final: 対話終了かどうかのフラグ（ブール値）
- aux_data: 補助データ（辞書型）(ver. 0.4.0で変更）入力の補助データを，後述のアクション関数の中でアップデートしたものに，遷移した状態のIDを含めたもの．アクション関数の中でのアップデートは必ずしも行われるわけではない．遷移した状態は，以下の形式で付加される．
```
   {"state": "特定のラーメンが好き"}
```

5.5.1. ブロックコンフィギュレーションのパラメータ

knowledge_file（文字列）

シナリオを記述したExcelファイルを指定します．コンフィギュレーションファイルのあるディレクトリからの相対パスで記述します．
function_definitions（文字列）

シナリオ関数（dictionary_functionを参照）を定義したモジュールの名前です．複数ある場合は':'でつなぎます．モジュール検索パスにある必要があります．（コンフィギュレーションファイルのあるディレクトリはモジュール検索パスに入っています．）
flags_to_use（文字列のリスト）

各シートのflagカラムにこの値のうちのどれかが書かれていた場合に読み込みます．
knowledge_google_sheet (ハッシュ)

LR-CRF Understanderと同じです．
scenario_graph: (ブール値．デフォルト値False）

この値がtrueの場合，シナリオシートのsystem utteranceカラムとuser utterance exampleカラムの値を使って，グラフを作成します．これにより，シナリオ作成者が直感的に状態遷移ネットワークを確認できます．
repeat_when_no_available_transitions （ブール値．デフォルト値False．ver. 0.4.0で追加）

この値がTrueのとき，条件に合う遷移がないとき，遷移せず同じ発話を繰り返します．
multi_party （ブール値．デフォルト値False．ver. 0.10.0で追加）

この値がtrueのとき，5.5.4.1 章の対話履歴の内容，および，5.5.6.2 章の大規模言語モデルを用いる組み込み関数のプロンプトに入る対話履歴で，user_idの値が用いられます．

5.5.2. 対話管理の知識記述

対話管理知識（シナリオ）は，Excelファイルのscenarioシートです．

このシートの各行が，一つの遷移を表します．各行は次のカラムからなります．

flag

utteranceシートと同じ
state

遷移元の状態名
system utterance

stateの状態で生成されるシステム発話の候補．

システム発話文字列に含まれる{<変数>}または{<関数呼び出し>}は，対話中にその変数に代入された値や関数呼び出しの結果で置き換えられます．これについては，以下の{numref}realization_in_system_utterance`で詳しく説明します．

stateが同じ行は複数あり得ますが，同じstateの行のsystem utteranceすべてが発話の候補となり，ランダムに生成されます．
user utterance example

ユーザ発話の例．対話の流れを理解するために書くだけで，システムでは用いられません．
user utterance type

ユーザ発話を言語理解した結果得られるユーザ発話のタイプ．遷移の条件となります．
conditions

条件（の並び）．遷移の条件を表す関数呼び出し．複数あっても構いません．複数ある場合は，';'で連結します．各条件は<関数名>(<引数1>, <引数2>, ..., <引数n>)の形をしています．引数は0個でも構いません．各条件で使える引数については，5.5.4.2 章を参照してください．
actions

アクション（の並び）．遷移した際に実行する関数呼び出し．複数あっても構いません．複数ある場合は，;で連結します．各条件は<関数名>(<引数1>, <引数2>, ..., <引数n>)の形をしています．引数は0個でも構いません．各条件で使える引数については，5.5.4.2 章を参照してください．
next state

遷移先の状態名

（メモとして利用するために）シートにこれ以外のカラムがあっても構いません．

各行が表す遷移のuser utterance typeが空かもしくは言語理解結果と一致し，conditionsが空か全部満たされた場合，遷移の条件を満たし，next stateの状態に遷移します．その際，actionsに書いてあるアクションが実行されます．

stateカラムが同じ行（遷移元の状態が同じ遷移）は，上に書いてあるものから順に遷移の条件を満たしているかどうかをチェックします．

デフォルト遷移（user utterance typeカラムもconditionsカラムも空の行）は，stateカラムが同じ行の中で一番下に書かれていなくてはなりません．

repeat_when_no_available_transitionsがTrueの場合以外は，デフォルト遷移が必要です．

5.5.3. 特別な状態

以下の状態名はあらかじめ定義されています．

#prep

準備状態．この状態がある場合，対話が始まった時（クライアントから最初にアクセスがあった時）に，この状態からの遷移が試みられます．stateカラムの値が#prepの行のconditionsにある条件がすべて満たされるかどうかを調べ，満たされた場合に，その行のactionsのアクションを実行してから，next stateの状態に遷移し，その状態のシステム発話が出力されます．

最初のシステム発話や状態を状況に応じて変更するときに使います．日本語サンプルアプリは，対話が行われる時間に応じて挨拶の内容を変更します．

この準備状態はなくても構いません．

#prepからの遷移先は#initialでなくてもよくなりました．(ver. 0.4.0)
#initial

初期状態．#prep状態がない場合，対話が始まった時（クライアントから最初にアクセスがあった時）この状態から始まり，この状態のシステム発話がoutput_textに入れられてメインプロセスに返されます．

#prep状態または#initial状態のどちらかがなくてはなりません．

#error

内部エラーが起きたときこの状態に移動します．システム発話を生成して終了します．

また，#final_say_bye のように，#finalではじまるstate IDは最終状態を表します．最終状態ではシステム発話を生成して対話を終了します．

5.5.4. 条件とアクション

5.5.4.1. 文脈情報

STN Managerは，対話のセッションごとに文脈情報を保持しています．文脈情報は変数とその値の組の集合（pythonの辞書型データ）で，値はどのようなデータ構造でも構いません．

条件やアクションの関数は文脈情報にアクセスします．

文脈情報にはあらかじめ以下のキーと値のペアがセットされています．

キー	値
_current_state_name	遷移前状態の名前（文字列）
_config	configファイルを読み込んでできた辞書型のデータ
_block_config	configファイルのうち対話管理ブロックの設定部分（辞書型のデータ）
_aux_data	メインプロセスから受け取ったaux_data（辞書型のデータ）
_previous_system_utterance	直前のシステム発話（文字列）
_dialogue_history	対話履歴（リスト）
_turns_in_state	今の状態でのターン数（ユーザの発話回数）（整数）

対話履歴は，以下の形です．

[
  {
    "speaker": "user",
    "utterance": <正規化後のユーザ発話(文字列)>
  },
  {
    "speaker": "system",
    "utterance": <システム発話>
  },
  {
    "speaker": "user",
    "utterance": <正規化後のユーザ発話(文字列)>
  },
  {
    "speaker": "system",
    "utterance": <システム発話>
  },
  ...
]

ブロックコンフィギュレーションのmulti_partyの値がtrueの時，"user"の代わりに，user_idの値を用います．

これらに加えて新しいキーと値のペアをアクション関数内で追加することができます．

5.5.4.2. 関数の引数

条件やアクションで用いる関数の引数には次のタイプがあります．

特殊変数（#で始まる文字列）

以下の種類があります．
- #<スロット名>
  
  直前のユーザ発話の言語理解結果（入力のnlu_resultの値）のスロット値．スロット値が空の場合は空文字列になります．
- #<補助データのキー>
  
  入力のaux_dataの中のこのキーの値．例えば#emotionの場合，aux_data['emotion']の値．このキーがない場合は，空文字列になります．
- #sentence
  
  直前のユーザ発話（正規化したもの）
- #user_id
  
  ユーザID（文字列）
変数（*で始まる文字列）

文脈情報における変数の値です．*<変数名>の形．変数の値は文字列でないといけません．文脈情報にその変数がない場合は空文字列になります．
変数参照（&で始まる文字列）

&<文脈情報での変数の名前> の形で，関数定義内で文脈情報の変数名を利用するときに用います．
定数（""で囲んだ文字列）

文字列そのままを意味します．

5.5.5. システム発話中の変数や関数呼び出しの扱い

システム発話中の{と}に囲まれた部分の変数や関数呼び出しは，その変数の値や，関数呼び出しの返り値で置き換えられます．

変数は#で始まるものは上記の特殊変数です．それ以外のものは通常の変数で，文脈情報にあるはずのものです．それらの変数が存在しない場合は，置換されず変数名がそのまま使われます．

関数呼び出しの場合，関数は条件やアクションで用いる関数と同じように上記の引数を取ることができます．返り値は文字列でないといけません．

5.5.6. 関数定義

条件やアクションで用いる関数は，DialBB組み込みのものと，開発者が定義するものがあります．条件で使う関数はbool値を返し，アクションで使う関数は何も返しません．

5.5.6.1. 組み込み関数

組み込み関数には以下があります．

条件で用いる関数
- _eq(x, y)
  
  xとyが同じならTrueを返します．例：_eq(*a, "b"): 変数aの値が"b"ならTrueを返します． _eq(#food, "ラーメン"): #foodスロットが"ラーメン"ならTrueを返します．
- _ne(x, y)
  
  xとyが同じでなければTrueを返します．
  
  例：_ne(*a, *b): 変数aの値と変数bの値が異なればTrueを返します． _ne(#food, "ラーメン"): #foodスロットが"ラーメン"ならFalseを返します．
- _contains(x, y)
  
  xが文字列としてyを含む場合Trueを返します．
  例：_contains(#sentence, "はい") : ユーザ発話が「はい」を含めばTrueを返します．
- _not_contains(x, y)
  
  xが文字列としてyを含まない場合Trueを返します．
  
  例： _not_contains(#sentence, "はい") : ユーザ発話が"はい"を含めばTrueを返します．
- _member_of(x, y)
  
  文字列yを':'で分割してできたリストに文字列xが含まれていればTrueを返します．
  
  例：_member_of(#food, "ラーメン:チャーハン:餃子")
- _not_member_of(x, y)
  
  文字列yを':'で分割してできたリストに文字列xが含まれていなければTrueを返します．
  
  例：_not_member_of(*favorite_food, "ラーメン:チャーハン:餃子")
- _num_turns_exceeds(n)
  
  文字列nが表す整数よりも対話の最初からのターン数（ユーザの発話回数）が多いとき，Trueを返します．
  
  例：_num_turns_exceeds("10")
- _num_turns_in_state_exceeds(n)
  
  文字列nが表す整数よりもその状態でのターン数（ユーザの発話回数）が多いとき，Trueを返します．
  
  例：_num_turns_in_state_exceeds("5")
- _check_with_llm(task), _check_with_prompt_template(prompt_template)
  
  大規模言語モデル（現在はOpenAIのChatGPTのみ）を用いて判定をします．後述します．
アクションで用いる関数
- _set(x, y)
  
  変数xにyをセットします．
  
  例：_set(&a, b): bの値をaにセットします． _set(&a, "hello")： aに"hello"をセットします．
- _set(x, y)
  
  変数xにyをセットします．
  
  例：_set(&a, b): bの値をaにセットします． _set(&a, "hello")： aに"hello"をセットします．
システム発話内で用いる関数
- _generate_with_llm(task), _generate_with_prompt_template(task)
  
  大規模言語モデル（現在はOpenAIのChatGPTのみ）を用いて文字列を生成します．後述します．

5.5.6.2. 大規模言語モデルを用いた組み込み関数

_check_with_llm(task)および_generate_with_llm(task)は，大規模言語モデル（現在はOpenAIのChatGPTのみ）と，対話履歴を用いて，条件の判定および文字列の生成を行います．

以下が例です．

条件判定の例

_check_with_llm("ユーザが理由を言ったかどうか判断してください．")

文字列生成の例

_generate_with_llm("それまでの会話につづけて，対話を終わらせる発話を50文字以内で生成してください")

これらの関数を使うためには，以下の設定が必要です．

環境変数OPENAI_API_KEYにOpenAIのAPIキーをセットする

OpenAIのAPIキーの取得の仕方はWebサイトなどで調べてください．
ブロックコンフィギュレーションのchatgpt要素に以下の要素を加える
- gpt_model （文字列）
  
  GPTのモデル名です．gpt-4o-mini, gpt-4o等を指定できます．デフォルト値はgpt-4o-miniです．gpt-5は利用できません．
- instruction (文字列)
  
  ChatGPT APIを呼び出す際に，システムロールのメッセージとして用いられます．文字列生成の時だけ用いられます．デフォルト値はこのファイルを参照．
- temperature (float)
  
  GPTの温度パラメータです．デフォルト値は0.7です．
- temperature_for_checking (float)
  
  条件判定の際に用いるGPTの温度パラメータです．これが指定されていない場合は，temperatureの値が用いられます．
- situation （文字列のリスト）
  
  GPTのプロンプトに書く状況を列挙したものです．
  
  この要素がない場合，状況は指定されません．
- persona （文字列のリスト）
  
  GPTのプロンプトに書くシステムのペルソナを列挙したものです．
  
  この要素がない場合，ペルソナは指定されません．
例：
```
chatgpt:
  gpt_model: gpt-4o-mini
  temperature: 0.7
  situation:
    - あなたは対話システムで，ユーザと食べ物に関して雑談をしています．
    - ユーザとは初対面です
    - ユーザとは同年代です
    - ユーザとは親しい感じで話します
  persona:
    - 名前は由衣
    - 28歳
    - 女性
    - ラーメン全般が好き
    - お酒は飲まない
    - IT会社のwebデザイナー
    - 独身
    - 非常にフレンドリーに話す
    - 外交的で陽気
```

_check_with_prompt_template(prompt_template)および_generate_with_llm(prompt_template)は，大規模言語モデルにプロンプトを与えて条件の判定および文字列の生成を行います．プロンプトは，引数に指定したプロンプトテンプレートのプレースホルダを値に置き換えることで作られます．

これらの関数を使うには上記の環境変数OPENAI_API_KEYの設定と，ブロックコンフィギュレーションのchatgpt要素の設定が必要です．

以下が例です．

条件判定の例

_check_with_llm("ユーザが理由を言ったかどうか判断してください．")

条件判定の例

_generate_with_prompt_template("

# 状況

{situation}

# あなたのペルソナ

{persona}

# 現在までの対話

{dialogue_history}

# タスク

ユーザが理由を言ったかどうか判断し，yesかnoで答えてください．")

文字列生成の例

_generate_with_prompt_template("

# 状況

{situation}

# あなたのペルソナ

{persona}

# 現在までの対話

{dialogue_history}

# タスク

それまでの会話につづけて，対話を終わらせる発話を50文字以内で生成してください．")

{と}で囲まれている部分はプレースホルダです．

利用できるプレースホルダ
- {dialogue_history}
  
  その時点までの対話（最新のユーザ発話を含む）で置き換えられる
- {situation}
  
  ブロックコンフィギュレーションのchatgpt要素のsituationの値で置き換えられる
- {persona}
  
  ブロックコンフィギュレーションchatgpt要素のpersonaの値で置き換えられる
- {current_time}
  
  対話の行われている時点の年月日，曜日，時分秒を表す文字列で置き換えられる
- {<アルファベット，数字，アンダースコアのみからなる任意の文字列>}
  
  文字列がaux_dataのキーにあれば，その値を文字列に変換したもので置き換えらる．この文字列は，
プレースホルダの削除

もし置き換えられないプレースホルダが残っていて，それが[[[と]]]で囲まれていれば，その部分は消去されます．

5.5.6.3. 組み込み関数の簡略記法

組み込み関数の記述を簡単にするために以下の簡略記法（Syntax Sugar)が用意されています．

<変数名>==<値>

_eq(<変数名>, <値>)の意味です．

例：
```
#好きなラーメン=="豚骨ラーメン"
```
<変数名>!=<値>

_ne(<変数名>, <値>)の意味です．

例：
```
#NE_Person!=""
```
<変数名>=<値>

_set(&<変数名>, <値>)の意味です．

例：
```
user_name=#NE_Person
```
TT > <整数>

_num_turns_exceeds("<整数>")の意味です．

例：
```
TT>10
```
TS > <整数>

_num_turns_in_state_exceeds("<整数>")の意味です．

例：
```
TS>5
```
$<タスク文字列>$

条件として使われた時は，_check_with_llm("<タスク文字列>")の意味で，システム発話中で使われた時は，{_generate_with_llm("<タスク文字列>")}の意味です．

条件の例：
```
$"ユーザが理由を言ったかどうか判断してください．"
```
文字列生成を含むシステム発話の例：
```
わかりました．{$"それまでの会話につづけて，対話を終わらせる発話を50文字以内で生成してください．"}今日はお時間ありがとうございました．
```
以前は$"<タスク文字列>"の形でしたが推奨されません．
$$$<プロンプトテンプレート>$$$

条件として使われた時は，_check_with_prompt_template("<プロンプトテンプレート>")の意味で，システム発話中で使われた時は，{_generate_with_prompt_template("<プロンプトテンプレート>")}の意味です．

5.5.6.4. 開発者による関数定義

開発者が関数定義を行うときには，コンフィギュレーションファイルのブロックコンフィギュレーションのfunction_definitionで指定されているモジュールのファイル（Simpleアプリケーションではscenario_functions.py）を編集します．

def get_ramen_location(ramen: str, variable: str, context: Dict[str, Any]) -> None:
    location:str = ramen_map.get(ramen, "日本")
    context[variable] = location

上記のように，シナリオで使われている引数にプラスして，文脈情報を受け取る辞書型の変数を必ず加える必要があります．

シナリオで使われている引数はすべて文字列でなくてはなりません．

引数には，特殊変数・変数の場合，その値が渡されます．

また，変数参照の場合は'&'を除いた変数名が，定数の場合は，""の中の文字列が渡されます．

5.5.7. 連続遷移

システム発話（の1番目）が$skipである状態に遷移した場合，システム応答を返さず，即座に次の遷移を行います．これは，最初の遷移のアクションの結果に応じて二つ目の遷移を選択するような場合に用います．

5.5.8. 言語理解結果候補が複数ある場合の処理

入力のnlu_resultがリスト型のデータで，複数の言語理解結果候補を含んでいる場合，処理は次のようになります．

リストの先頭から順に，言語理解結果候補のtypeの値が，現在の状態から可能な遷移のうちのどれかのuser utterance typeの値に等しいかどうかを調べ，等しい遷移があれば，その言語理解結果候補を用います．

どの言語理解結果候補も上記の条件に合わない場合，リストの先頭の言語理解結果候補を用います．

5.5.9. リアクション

アクション関数の中で，文脈情報の_reactionに文字列をセットすると，状態遷移後のシステム発話の先頭に，その文字列を付加します．

例えば，_set(&_reaction, "そうですね")というアクション関数を実行した後に遷移した状態のシステム発話が"ところで今日はいい天気ですね"であれば，"そうですねところで今日はいい天気ですね"という発話をシステム発話として返します．

5.5.10. Subdialogue

遷移先の状態名が#gosub:<状態名1>:<状態名2>の形の場合，<状態名1>の状態に遷移して，そこから始まるsubdialogueを実行します．そして，その後の対話で，遷移先が:exitになったら，<状態名2>の状態に移ります．

例えば，遷移先の状態名が#gosub:request_confirmation:confirmedの形の場合，request_confirmatinから始まるsubdialogueを実行し，遷移先が:exitになったら，confirmedに戻ります．

subdialogueの中でsubdialogueに遷移することも可能です．

5.5.11. 外部データベースへの文脈情報の保存

DialBBアプリケーションをWebサーバとして動作させる場合，リクエストが集中した際にロードバランサを使って複数インスタンスでに処理を分散させる場合，文脈情報を外部DB（MongoDB)に保存することで，一つのセッションを異なるインスタンスで処理することが可能です．(ver. 0.10.0で追加)

外部DBを使うには，ブロックコンフィギュレーションに以下のようにcontext_db要素を指定します．

context_db:
  host: localhost
  port: 27017
  user: admin
  password: password

各キーは以下です．

host （str)

MongoDBが動作しているホスト名
port (int. デフォルト値27017)

MongoDBのアクセスのためのポート番号
user （str)

MongoDBのアクセスのためのユーザ名
password （str)

MongoDBのアクセスのためのパスワード

5.5.12. 音声入力を扱うための仕組み

ver. 0.4.0で，音声認識結果を入力として扱うときに生じる問題に対処するため，以下の変更が行われました．

5.5.12.1. ブロックコンフィギュレーションパラメータの追加

input_confidence_threshold （float．デフォルト値0.0）

入力が音声認識結果の時，その確信度がこの値未満の場合に，確信度が低いとみなします．入力の確信度は，aux_dataのconfidenceの値です．aux_dataにconfidenceキーがないときは，確信度が高いとみなします．確信度が低い場合は，以下に述べるパラメータの値に応じて処理が変わります．
confirmation_request（オブジェクト）

これは以下の形で指定します．
```
confirmation_request:
  function_to_generate_utterance: <関数名（文字列）>
  acknowledgement_utterance_type: <肯定のユーザ発話タイプ名（文字列）>
  denial_utterance_type: <否定のユーザ発話タイプ名（文字列）>
```
これが指定されている場合，入力の確信度が低いときは，状態遷移をおこなわず，function_to_generate_utteranceで指定された関数を実行し，その返り値を発話します（確認要求発話と呼びます）．

そして，それに対するユーザ発話に応じて次の処理を行います．
- ユーザ発話の確信度が低い時は，遷移を行わず，前の状態の発話を繰り返します．
- ユーザ発話のタイプがacknowledgement_utterance_typeで指定されているものの場合，確認要求発話の前のユーザ発話に応じた遷移を行います．
- ユーザ発話のタイプがdenial_utterance_typeで指定されているものの場合，遷移を行わず，元の状態の発話を繰り返します．
- ユーザ発話のタイプがそれ以外の場合は，通常の遷移を行います．
ただし，入力がバージイン発話の場合（aux_dataにbarge_in要素があり，その値がTrueの場合）はこの処理を行いません．

function_to_generate_utteranceで指定する関数は，ブロックコンフィギュレーションのfunction_definitionsで指定したモジュールで定義します．この関数の引数は，このブロックの入力のnlu_resultと文脈情報です．返り値はシステム発話の文字列です．
utterance_to_ask_repetition（文字列）

これが指定されている場合，入力の確信度が低いときは，状態遷移をおこなわず，この要素の値をシステム発話とします．ただし，バージインの場合（aux_dataにbarge_in要素があり，その値がTrueの場合）はこの処理を行いません．

confirmation_requestとutterance_to_ask_repetitionは同時に指定できません．
ignore_out_of_context_barge_in （ブール値．デフォルト値False）

この値がTrueの場合，入力がバージイン発話(リクエストのaux_dataのbarge_inの値がTrue)の場合，デフォルト遷移以外の遷移の条件を満たさなかった場合（すなわちシナリオで予想された入力ではない）か，または，入力の確信度が低い場合，遷移しません．この時に，レスポンスのaux_dataのbarge_in_ignoredをTrueとします．
reaction_to_silence （オブジェクト）

action要素を必ず持ちます．action 要素の値は文字列で"repeat"か"transition"です．action 要素の値がtransitionの場合，destination 要素が必須です．その値は状態名（文字列）です．

入力のaux_dataがlong_silenceキーを持ちその値がTrueの場合で，かつ，デフォルト遷移以外の遷移の条件を満たさなかった場合，このパラメータに応じて以下のように動作します．
- このパラメータが指定されていない場合，通常の状態遷移を行います．
- actionの値が"repeat"の場合，状態遷移を行わず直前のシステム発話を繰り返します．
- actionの値がtransitionの場合，destinationで指定されている状態に遷移します．

5.5.12.2. 組み込み条件関数の追加

以下の組み込み条件関数が追加されています．

_confidence_is_low()

入力のaux_dataのconfidenceの値がコンフィギュレーションのinput_confidence_thresholdの値以下の場合にTrueを返します．
_is_long_silence()

入力のaux_dataのlong_silenceの値がTrueの場合にTrueを返します．

5.5.12.3. 直前の誤った入力を無視する

入力のaux_dataのrewindの値がTrueの場合，直前のレスポンスを行う前の状態から遷移を行います．直前のレスポンスを行った際に実行したアクションによる文脈情報の変更も元に戻されます．

音声認識の際に，ユーザ発話を間違って途中で分割してしまい，前半だけに対する応答を行ってしまった場合に用います．

文脈情報は元に戻りますが，アクション関数の中でグローバル変数の値を変更していたり，外部データベースの内容を変更していた場合にはもとに戻らないことに注意してください．

5.6. ChatGPT Dialogue （ChatGPTベースの対話ブロック）

(ver0.6で追加，ver0.7で大幅に変更）

(dialbb.builtin_blocks.chatgpt.chatgpt.ChatGPT)

OpenAI社のChatGPTを用いて対話を行います．

5.6.1. 入出力

入力
- user_utterance: 入力文字列（文字列）
- aux_data: 補助データ（辞書型）
- user_id: 補助データ（辞書型）
出力
- system_utterance: 入力文字列（文字列）
- aux_data: 補助データ（辞書型）
- final: 対話終了かどうかのフラグ（ブール値）

入力のuser_idは利用せしません．出力のaux_dataは入力のaux_dataと同じもので，finalは常にFalseです．

これらのブロックを使う時には，環境変数OPENAI_API_KEYにOpenAIのライセンスキーを設定する必要があります．

5.6.2. ブロックコンフィギュレーションのパラメータ

first_system_utterance （文字列，デフォルト値は""）

対話の最初のシステム発話です．
user_name （文字列，デフォルト値は日本語の場合"ユーザ", その他は"User"）

ChatGPTのプロンプトに対話履歴を与えるときに使う文字列です．

ver 1.1.0 で廃止されましたが，ver.1.1.1で復活しました．
system_name （文字列，デフォルト値は日本語の場合"システム", その他は"System"）

ChatGPTのプロンプトに対話履歴を与えるときに使う文字列です．

ver 1.1.0 で廃止されましたが，ver.1.1.1で復活しました．
prompt_template （文字列）

システム発話の生成をChatGPTに行わせるプロンプトを記述したファイル名です．アプリケーションディレクトリからの相対で記述します．
gpt_model （文字列，デフォルト値はgpt-4o-mii）

Open AI GPTのモデルです．gpt-4o, gpt-4o-miniなどが指定できます．
temperature （float，デフォルト値は0.7）

ChatGPT呼び出しの際の温度パラメータです．
instruction (文字列, デフォルト値はこのファイルを参照．)

システムロールのメッセージとしてChatGPTに送られる指示です．

5.6.3. プロンプトテンプレート内のプレースホルダ

プロンプトテンプレート内では，以下のプレースホルダが利用できます．
- {current_time}
  
  対話の行われている時点の年月日，曜日，時分秒を表す文字列で置き換えられる
- {<アルファベット，数字，アンダースコアのみからなる任意の文字列>}
  
  文字列がaux_dataのキーにあれば，その値を文字列に変換したもので置き換えらる．
プレースホルダの削除

もし置き換えられないプレースホルダが残っていて，それが[[[と]]]で囲まれていれば，その部分は消去されます．

5.6.4. 処理内容

対話の最初はブロックコンフィギュレーションのfirst_system_utteranceの値をシステム発話として返します．
2回目以降のターンでは，プロンプトテンプレートを与えてChatGPTに発話を生成させ，返ってきた文字列をシステム発話として返します．

5.7. ChatGPT NER （ChatGPTを用いた固有表現抽出ブロック）

(dialbb.builtin_blocks.ner_with_chatgpt.chatgpt_ner.NER）

OpenAI社のChatGPTを用いて，固有表現の抽出を行います．

コンフィギュレーションのlanguage要素がjaの場合は日本語，enの場合は英語の固有表現抽出を行います．

本ブロックは，起動時にExcelで記述した固有表現用知識を読み込み，固有表現のクラスのリスト，各固有表現クラスの説明，各クラスの固有表現の例，抽出例（Few shot example）に変換し，プロンプトに埋め込みます．

実行時は，プロンプトに入力発話を付加してChatGPTに固有表現抽出を行わせます．

5.7.1. 入出力

入力
- input_text: 入力文字列
- aux_data: 補助データ（辞書型)
出力
- aux_data: 補助データ（辞書型）
  
  入力されたaux_dataに固有表現抽出結果を加えたものです．
  
  固有表現抽出結果は，以下の形です．
```
{"NE_<ラベル>": "<固有表現>", "NE_<ラベル>": "<固有表現>", ...}
```
  <ラベル>は固有表現のクラスです．固有表現は見つかった固有表現で，input_textの部分文字列です．同じクラスの固有表現が複数見つかった場合，:で連結します．
  
  例
```
{"NE_人名": "田中:鈴木", "NE_料理": "味噌ラーメン"}
```

5.7.2. ブロックコンフィギュレーションのパラメータ

knowledge_file（文字列）

固有表現知識を記述したExcelファイルを指定します．コンフィギュレーションファイルのあるディレクトリからの相対パスで記述します．
flags_to_use（文字列のリスト）

各シートのflagカラムにこの値のうちのどれかが書かれていた場合に読み込みます．このパラメータがセットされていない場合はすべての行が読み込まれます．
knowledge_google_sheet (ハッシュ)
- Excelの代わりにGoogle Sheetを用いる場合の情報を記述します．（Google Sheetを利用する際の設定はこはたさんの記事が参考になりますが，Google Cloud Platformの設定画面のUIがこの記事とは多少変わっています．）
  - sheet_id （文字列）
    
    Google SheetのIDです．
  - key_file（文字列）
    
    Goole Sheet APIにアクセスするためのキーファイルをコンフィギュレーションファイルのディレクトリからの相対パスで指定します．
gpt_model (文字列．デフォルト値はgpt-4o-mini）

ChatGPTのモデルを指定します．gpt-4oなどが指定できます．
prompt_template

プロンプトテンプレートを書いたファイルをコンフィギュレーションファイルのディレクトリからの相対パスで指定します．

これが指定されていない場合は，dialbb.builtin_blocks.ner_with_chatgpt.chatgpt_ner.prompt_template_ja .PROMPT_TEMPLATE_JA （日本語）または，dialbb.builtin_blocks.ner_with_chatgpt.chatgpt_ner.prompt_template_en .PROMPT_TEMPLATE_EN （英語）が使われます．

プロンプトテンプレートは，言語理解をChatGPTに行わせるプロンプトのテンプレートで，@で始まる以下の変数を含みます．
- @classes 固有表現のクラスを列挙したものです．
- @class_explanations 各固有表現クラスの説明を列挙したものです．
- @ne_examples 各固有表現クラスの固有表現の例を列挙したものです．
- @ner_examples 発話例と，固有表現抽出結果の正解を書いた，いわゆるfew shot exampleです．
- @input 入力発話です．
これらの変数には，実行時に値が代入されます．

5.7.3. 固有表現抽出知識

固有表現抽出知識は，以下の2つのシートからなります．

シート名	内容
utterances	発話と固有表現抽出結果の例
classes	スロットとエンティティの関係および同義語のリスト

シート名はブロックコンフィギュレーションで変更可能ですが，変更することはほとんどないと思いますので，詳細な説明は割愛します．

5.7.3.1. utterancesシート

各行は次のカラムからなります．

flag

利用するかどうかを決めるフラグ．Y (yes), T (test)などを書くことが多いです．どのフラグの行を利用するかはコンフィギュレーションに記述します．
utterance

発話例．
entities

発話に含まれる固有表現．固有表現を以下の形で記述します．
```
<固有表現クラス>=<固有表現>, <固有表現クラス>=<固有表現>, ... <固有表現クラス>=<固有表現> 
```
以下が例です．
```
人名=太郎, 地名=東京
```
utterancesシートのみならずこのブロックで使うシートにこれ以外のカラムがあっても構いません．

5.7.3.2. classesシート

各行は次のカラムからなります．

flag

utterancesシートと同じ
class

固有表現クラス名．
explanation

固有表現クラスの説明
examples

固有表現の例を','で連結したものです．

5.8. spaCy-Based Named Entity Recognizer （spaCyを用いた固有表現抽出ブロック）

(dialbb.builtin_blocks.ner_with_spacy.ne_recognizer.SpaCyNER)

(ver0.6で追加）

spaCyおよびGiNZAを用いて固有表現抽出を行います．

5.8.1. 入出力

入力
- input_text: 入力文字列（文字列）
- aux_data: 補助データ（辞書型）
出力
- aux_data: 補助データ（辞書型）
  
  入力されたaux_dataに固有表現抽出結果を加えたものです．
  
  固有表現抽出結果は，以下の形です．
```
{"NE_<ラベル>": "<固有表現>", "NE_<ラベル>": "<固有表現>", ...}
```
  <ラベル>は固有表現のクラスです．固有表現は見つかった固有表現で，input_textの部分文字列です．同じクラスの固有表現が複数見つかった場合，:で連結します．
  
  例
```
{"NE_Person": "田中:鈴木", "NE_Dish": "味噌ラーメン"}
```
  固有表現のクラスについては，spaCy/GiNZAのモデルのサイトを参照してください．
  - ja-ginza-electra (5.1.2):，https://pypi.org/project/ja-ginza-electra/
  - en_core_web_trf (3.5.0):，https://spacy.io/models/en#en_core_web_trf-labels

5.8.2. ブロックコンフィギュレーションのパラメータ

model (文字列．必須）

spaCy/GiNZAのモデルの名前です．ja_ginza_electra (日本語），en_core_web_trf (英語）などを指定できます．
patterns (オブジェクト．任意）

ルールベースの固有表現抽出パターンを記述します．パターンは，spaCyのパターンの説明に書いてあるものをYAML形式にしたものです．

以下が日本語の例です．
```
patterns: 
  - label: Date
    pattern: 昨日
  - label: Date
    pattern: きのう
```

5.8.3. 処理内容

spaCy/GiNZAを用いてinput_text中の固有表現を抽出し，aux_dataにその結果を入力して返します．