DialBBノーコードツール（DialBB-NC）ドキュメント

はじめに

本ドキュメントはDialBBのノーコードツール（DialBB-NC）のドキュメントです．

動作環境

Windows11，MacOSで動作します．

インストール・起動（Windows）

Pythonのインストール

• もし，すでにPythonがインストールされていれば，バージョンを確かめてください．インストールされているかどうかの確かめ方やバージョンの確かめ方はそのうち記述します．インストールされていても，バージョンが3.10-3.12であれば，新しくインストールする必要はありません．3.9以前のPythonがインストールされている場合，使っていないならアンインストールしてください．使っている場合，DialBBの開発者に相談してください．

• Windows 11

  • Pythonがインストールされていない場合，以下の手順でPythonをインストールします．

    • ブラウザのアドレスバーに https://www.python.org/downloads/windows/ を打ち込んでEnterキーを押します．

    • 表示されている中から以下の部分を探します．以下は3.10.11ですが，3.10.x-3.12.xであれば，別のバージョンでも構いません．

    

    • 64bit OSの場合は，Windows installer (64-bit)を，32bit OSの場合はWindows installer (32 -bit)をクリックします．

    • 「ダウンロード」フォルダに python-3.10.11-amd64.exeまたはpython-3.10.11-amd32.exeというファイルができるので，ダブルクリックします．

    • 以下の画面が現れます．

      

      • Add python.exe to PATHにチェックを入れてからInstall Nowをクリックします．

        

      • Pythonがインストールされます．

DialBBのインストール

• 必要なファイルを以下の要領でダウンロードします．

  • ブラウザから https://c4a-ri.github.io/dialbb/files/dialbb-setup.zip にアクセスします．

  • ダウンロードフォルダにdialbbファイルがダウンロードされます．エクスプローラでダウンロードフォルダを開いて確認してください．以下のようなファイルができているはずです．

    

    • このようにチャックの模様があるものをzipファイルと呼びます．環境によっては，dialbb-setup.zipという名前で表示されます．

    • 複数回ダウンロードすると，新しくダウンロードしたものはdialbb-setup(1)のような名前になるので，その場合，ダウンロードフォルダのdialbb-setupを削除してからもう一度ダウンロードしてください．

• エクスプローラでdialbb-setupアイコンの上にカーソルを持っていき右クリックし，「すべて展開」を選びます．出てきた画面で，「展開」を押してください．dialbb-setupフォルダができるので，それを開いてください．

• install（環境によってはinstall.bat）をダブルクリックします．DialBBがインストールされます．

  • 「WindowsによってPCが保護されました」と出るかもしれません．その場合，「詳細情報」をクリックすると，「実行」ボタンが出てくるので，それを押してください．

  • Press any key to continue . . .と表示されたらインストールは完了なので，何かキーを押して終了してください．

シナリオエディタのインストール

• 以下の手順でシナリオエディタ（のGUIプログラム）をインストールします．このプログラムのライセンスなどの情報は，https://c4a-ri.github.io/dialbb-scenario-editor/ に書いてあります．

• ブラウザから https://c4a-ri.github.io/dialbb-scenario-editor/files/editor-gui.zip にアクセスします．

• ダウンロードフォルダにeditor_guiという名前のzipファイル（またはeditor_gui.zip）がダウンロードされます．

• このファイルを先ほどのdialbb-setupフォルダ（展開してできたフォルダ）に移動します．

• dialbb-setupフォルダにある，install-scenario-editorアイコンをダブルクリックします．

  • 「WindowsによってPCが保護されました」と出るかもしれません．その場合，「詳細情報」をクリックすると，「実行」ボタンが出てくるので，それを押してください．

  • Press any key to continue . . .と表示されたらインストールは完了なので，何かキーを押して終了してください．

起動

dialbb-setupフォルダ内でstart-dialbb-nc（またはstart-dialbb-nc.bat）をダブルクリックします．

正常に起動するとメイン画面が表示されます．（少し時間がかかることがあります．）

インストールと起動（Mac）

Pythonのインストール

Windowsの場合と同様，Python3.10-3.12がインストールされていれば，新たにインストールする必要はありません．

Pythonがインストールされていない場合，以下の手順でインストールしてください．

• Pythonの公式ダウンロードサイトにアクセスしてください．

• 適当なバージョン（例:3.10.11）の下の，macOS 64-bit universal2 installerをクリックし，ファイルをダウンロードします．

• ダウンロードした .pkg ファイルを開いて，画面に表示される指示に従いインストールを進めてください．

DialBBのインストール

https://github.com/c4a-ri/dialbb/blob/dev-v1.0/docs/files/dialbb.zip からdialbb.zipファイルをダウンロードします．Downloadフォルダにダウンロードされます．ダウンロードフォルダにすでにdialbb.zipがある場合，dialbb(1).zipのような名前になっている場合があるのでその場合，古いdialbb.zipを消してからもう一度ダウンロードしてください．

ターミナルを開きます．適当なディレクトリ（DialBBディレクトリと呼びます）を作って移動してください．

そこで，

unzip ~/Downloads/dialbb-setup.zip
pip install --force-reinstall *.whl

としてください．DialBBがインストールされます．

シナリオエディタのインストール

https://github.com/c4a-ri/dialbb-scenario-editor/blob/main/docs/files/editor-gui.zipからeditor-gui.zipををダウンロードします．Downloadファイルにダウンロードされます．

ターミナルで以下を実行します．（ディレクトリはどこでも構いません）

xxxxxxxxxx
dialbb-install-scenario-editor ~/Downloads/editor-gui.zip

起動

ターミナルで以下を実行します．（ディレクトリはどこでも構いません）

xxxxxxxxxx
dialbb-nc

Macの場合少し画面が乱れます。（修正予定）

アプリケーションの読み込み・作成・書き出し

アプリケーションの読み込み/新規作成

• すでにあるアプリケーションを読み込む場合は，選択ボタンをクリックし，読み込むアプリケーションのzipファイルを選択し，読み込みを押します．

  

• アプリケーションを新たに作成する場合は，新規作成ボタンをクリックし，言語を選択します．テンプレートアプリケーションファイルが読み込まれます．

  

• その時点で読み込まれているアプリケーションの名前（zipファイルの名前）がメイン画面のCurrent applicationのところに表示されます．

アプリケーションの書き出し

• 書き出しボタンをクリックし，保存する場所/ファイル名を指定します，zipファイルにまとめて保存されます．

  

アプリケーションの起動・停止

OpenAI API キーの登録

最初にDialBB-NCを使うときや，DialBBのインストールをし直した後には，OpenAIのAPIキーの登録が必要です．OpenAIのAPIキーの登録は以下のようにします．

• `設定ボタンを押します．
  

• OPENAI_API_KEYの右側に別途入手したOpenAIのAPIキーを入力し，OKボタンを押します．保存しましたという表示が出るので再度OKボタンを押します．OpenAIのAPIキーの入手方法は別途「OpenAI API キー」などで検索して調べてください．

• 入力したAPIキーは暗号化して保存されますが、DialBBのプログラムがあれば復号できるので、個人用PC以外では保存しないようにしてください。消去する場合には、OPENAI_API_KEYに他の文字列をセットするか、DialBBをアンインストールしてください。

起動

• 起動ボタンをクリックします．アプリケーションサーバが起動します．

• ChromeやEdgeなどのブラウザを開き，アドレスバーにhttp://localhost:8080/を打ち込んでEnterを押します．以下のようなチャット画面が表示されます．

  

• start dialogueボタンを押すと会話が開始されます．

• 再度最初から会話を始めたい場合はブラウザのリロードボタンを押してください．

• http://localhost:8080/testにアクセスするとシンプルな画面が出ます．（対話のログのコピペがしやすいです）

停止

• メインGUIでstopボタンを押すとアプリケーションサーバが停止します．

ログ

• ブラウザからアクセスしても画面が出ない場合や対話がうまくいかない場合は，ログ表示ボタンを押し，ログを見て近くのエンジニアかDialBB開発者に相談してください．

• ログはホームフォルダ（ホームディレクトリ）の中の.dialbb_nc_logsフォルダの中に書きだされます．

  • ホームフォルダは，Windowsの場合，C:\Users\<ユーザ名>です．

  • ログは日付毎にフォルダにまとまっています．

  • ログファイルは<アプリケーションが起動した時間>.txtです．

アンインストール

dialbb-setupフォルダの中にある、uninstallというアイコンをダブルクリックするとDialBBがアンインストールできます。

アプリケーションの編集

• アプリケーションを読み込んだ状態でeditボタンをクリックし，編集するアプリケーションファイルを選択します．
  

コンフィギュレーションの変更

Edit Application画面でコンフィギュレーションボタンを押すと，以下の画面が表示されます．

以下が各編集項目の説明です．

シナリオファイルの編集

Edit Application画面でシナリオボタンを押すと，シナリオエディタが表示されます．もし表示されなければ，Webブラウザを立ち上げて，現れたウインドウに書いてあるURLをブラウザのアドレスバーに貼り付けてエンターキーを押してください．

シナリオエディタの概要

シナリオは，システムノードとユーザノードがリンクで接続されたものです．システムノードではシステム発話を記述し，ユーザノードでは，遷移の条件を記述します．priorityの値が高い順に遷移の条件を調べていき，条件が満たされれば，その次のシステムノードに遷移します．どのユーザノードの遷移の条件も満たされない場合，同じシステムノードに戻って，システム発話が生成されます．

システムノードは複数のユーザにリンクが出て行き，ユーザノードからは一つだけのノードにリンクが出て行きます．（toが出口，fromが入口です）

システム発話や遷移の条件の記述については，後で説明します．

ノードの追加

背景で右クリック し，システムノード追加かユーザノード追加を選択するとシステムノードかユーザノードが新規追加されます．

ノードの削除

ノードの上で右クリック し，削除を選択するとそのノードが削除されます．

ノードの編集

ノードの上で右クリック し，編集を選択すると，ノードの編集画面が表示されます．

ノードの編集の仕方は後述します．

コネクタの接続・削除

ノードのtoを左クリック し，他ノードのfromへドラッグして接続します．

削除はfromをつまんで離すか，リンク上で右クリック して削除を選択します．

変更を戻すときにはコントロールキーを押しながらzを押してください。

保存

上部のSaveボタンをクリックすると保存します．保存しないでエディタサーバを停止した場合はデータが失われます．

システムノードの編集の仕方

システムノードを右クリックすると以下のような入力ダイアログが表示されますので，中身を書き換えてSaveボタンを押します．Closeボタンを押すと保存せずに閉じます．

typeは以下のどれかです．

utteranceには，システム発話を書きます．システム発話の中の{}で囲んだ部分に以下のようなものを書けます．

• $"<インストラクション>" ChatGPTにインストラクションを与えて発話を生成させます．このとき，コンフィギュレーションで指定したsituationとpersonaが用いられます． 例： {$"感想を言う発話を20字以内で生成してください．"}ところで，最近の体調はいかがですか？

• #<言語理解のスロット名>

  直前のユーザ発話の言語理解で得られたスロットの値で置き換えられます．{#好きなラーメン}なら，好きなラーメンスロットの値で置き換えられます．

  例：{#好きなラーメン}がお好きなんですね！

  スロットが空の場合，空文字列になります．スロットが空でないときだけ，このノードに来るように，ユーザノードで設定する必要があります．

  言語理解については後で説明します．

• #<NE_固有表現のクラス>

  固有表現抽出の結果で置き換えられます．{#NE_人名}なら，直前のユーザ発話の固有表現抽出の結果得られた人名クラスの固有表現が用いられます．

  例：こんにちは，{#NE_人名}さん

  固有表現が抽出できなかった場合，空文字列になります．スロットが空でないときだけ，このノードに来るように，ユーザノードで設定する必要があります．

  固有表現抽出については後で説明します．

ユーザノードの編集の仕方

ユーザノードを右クリックすると以下のような入力ダイアログが表示されますので，中身を書き換えてSaveボタンを押します．Closeボタンを押すと保存せずに閉じます．

優先度はこのユーザノードの優先度を表す整数です．一つのシステムノードからつながっているユーザノードのうち，priority numberの高い順に条件がチェックされます．この数字は，シナリオを保存する度にリセットされ，大きいものから順に100, 90, 80, ...に変更されます．

ユーザ発話の例にはユーザ発話例を書きます．システムの動作には影響しません．書かなくても構いません．

ユーザ発話タイプと遷移の条件にはこのユーザノードの条件を書きます．両方が満たされたとき，このユーザノードの次のシステムノードに移行します．

ユーザ発話タイプは言語理解で得られるユーザ発話のタイプを書きます．コンフィギュレーションで，言語理解を行うことを選択している場合，および，言語理解で得られたユーザ発話のタイプが，ここに書いてあるものにマッチした場合，条件が満たされます．ここが空の場合は，必ず条件が満たされたとみなします．

遷移の条件には，ユーザ発話以外のタイプに関する条件を書きます．条件が複数ある場合は，";"でつなぎます．条件には以下のようなものが書けます．

• $"<インストラクション>" ChatGPTにインストラクションを与えて条件判定をさせます．このとき，コンフィギュレーションで指定したsituationとpersonaが用いられます． 例： $"ユーザが会話に飽きたかどうかを判断してください．"

• #<言語理解のスロット名> == "<文字列>"/ #<言語理解のスロット名> != ""

  直前のユーザ発話の言語理解で得られたスロットの値が文字列に一致するかどうか（==）または一致しないかどうか（!=）を判定します．

  例：#好きなラーメン=="豚骨ラーメン"

  スロットが空の場合，空文字列になります．例えば好きなラーメンスロットの値が空であれば，条件，#好きなラーメン==""は満たされます．

• #<NE_固有表現のクラス> == "<文字列>"/ #<NE_固有表現のクラス> != ""

  直前のユーザ発話の固有表現抽出で得られた固有表現の値が文字列に一致するかどうか（==）または一致しないかどうか（!=）を判定します．

  例：#NE_人名!=""

  固有表現が抽出できなかった場合，空文字列になります．例えばPersonクラスの固有表現が抽出できなかった場合，条件，#NE_Person!=""は満たされません．

• _num_turns_exceeds("<ターン数>")

  対話開始からのユーザ発話の回数が<ターン数>を超えた場合に条件が満たされます． 例：_num_turns_exceeds("10")

• _num_turns_in_state_exceeds("<ターン数>")

  その状態（システムノード）でのユーザ発話の回数が<ターン数>を超えた場合に条件が満たされます． 例：_num_turns_in_state_exceeds("5")

遷移時のアクションは進んだ使い方の時のみ利用するのでここでは説明しません．

言語理解用知識の編集

言語理解とは，発話タイプに分類し，必要な情報を取り出すことです．必要な情報のことをスロットと言います．例えば，気象情報を検索する対話システムならば，タイプは「天気を聞く」「気温を聞く」などで，スロットは，「地名」や「日付」などになります． この「地名」や「日付」をスロット名，実際に抽出される地名や日付の値をスロット値と呼びます．このタイプやスロット値をシナリオのユーザノードで遷移の条件として使うことができます．

対話システムに言語理解を行わせるには，言語理解知識が必要です．言語理解知識には以下のような情報を記述します．

• どのような発話がどのタイプなのか？

• どのようなスロットがあるのか？

• スロット値の例

• 発話とそれから得られるスロットの例

さらに，各スロットの同義語も記述することができます．

同じ単語が別のスロットになることもあります．例えば，券売機の対話システムで「東京から新大阪までの乗車券」と言えば，乗車駅＝東京，降車駅＝新大阪，券種別＝乗車券となりますが，乗車駅スロットと降車駅スロットは両方とも駅名です．

言語理解知識を編集するには，Edit Application画面でNLU knowledgeを選択します．Excelが起動して言語理解知識を読み込むので，編集して保存してください．

言語理解用知識のExcelファイルは，utterancesシートと，slotsシートからなります． 以下がutterancesシートの例です．

• flag列は使いません．

• type列には発話のタイプを書きます．

• utterance列は発話例です．

• slotsには，<スロット名>=<スロット値>, ... ,<スロット名>=<スロット値>の形で発話に含まれるスロットを書きます．カンマは全角でも読点でも構いません．

以下はslotsシートの例です．

• flag列は使いません．

• slot name列にはスロット名を書きます．

• entity列にはスロット値になり得るものの例を書きます．

• synonyms列には，スロット値の同義語をカンマまたは読点で並べて書きます．同義語がスロット値になった場合，entity列のものに置き換えられます．

固有表現抽出知識の編集

固有表現とは，固有名詞＋αと思って構いません．発話テキストから固有表現を抽出することを固有表現抽出と言います．固有表現はクラスに分かれています．例えば，人名，地名，組織名，商品名，時間，数量などが，クラスとして使われます．言語理解のスロットと似ていますが，言語理解のスロットは，タイプと結びついているのに対して，

対話システムに固有表現抽出を行わせるには，固有表現抽出知識が必要です．固有表現抽出知識には以下のような情報を記述します．

• どのようなクラスの固有表現があるのか？

• 各クラスの固有表現の例

• 発話とそれから得られる固有表現の例

一つの発話から同じクラスの固有表現が複数得られることもあります．例えば，「太郎と次郎はラーメンが好き」ならば，「太郎」も「次郎」も人名クラスの固有表現です．

固有表現抽出知識を編集するには，Edit Application画面でNER knowledgeを選択します．Excelが起動するので，編集して保存してください．

固有表現抽出知識のExcelファイルは，utterancesシートと，classesシートからなります．

以下がutterancesシートの例です．

• flag列は使いません．

• utterance列は発話例です．

• entitiesには，<固有表現クラス名>=<固有表現>, ... ,<固有表現クラス名>=<固有表現>の形で発話に含まれるスロットを書きます．カンマは全角でも読点でも構いません．

以下はclassesシートの例です．固有表現のクラス毎に1行記述します．

• flag列は使いません．

• class列には固有表現のクラスを書きます．

• explanation列には固有表現の説明を書きます．

• examples列には，そのクラスの固有表現の例をカンマまたは読点で並べて書きます．