# FAQメンテナンスアプリ

FAQメンテナンスアプリでは、整っていない文章からFAQ化をする際に、汎用的なFAQ用の文章へとメンテナンスを行い、登録処理を行えるアプリです。

## フロー全体図 <a href="#overall" id="overall"></a>

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FEnZgVsiBmx2V8P0fvZOS%2Fimage.png?alt=media&#x26;token=2671bc6b-37e7-491b-a856-3140c1e73821" alt=""><figcaption></figcaption></figure>

## 概要 <a href="#outline" id="outline"></a>

FAQメンテナンスアプリは、入力フォームにFAQとして登録を行いたいが文章の整っていない質問文と回答文をそれぞれ入力し送信すると、LLM実行で整えられた文章で質問文と回答文を作成し再度表示します。

整えられた質問文と回答をそのまま登録される場合は「適用」ボタンを、修正が必要な場合は文章を上書きしてから「適用」ボタンを押すと、FAQとして登録するかを確認され、それに対して「はい」を選択すると、L連携(アドバンスド)で指定したAPIキーをキーにナレッジベース＞Q\&AにFAQが登録されます。

### 文章の整っていないFAQ(質問文と回答文)の取集（入力フォームノード） <a href="#form_node1" id="form_node1"></a>

整っていないFAQ(質問文と回答文)を取得する変数は以下で構成されています。

質問文

変数：@QUESTION\_ORIGINAL

回答文

変数：@QUESTION\_ORIGINAL

* 変数種別：会話変数
* タイプ：文字列

<div><figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FD2C49zer83UPppaXnOQK%2Fimage.png?alt=media&#x26;token=107088e3-f894-4718-9310-6518e306dc8b" alt="" width="317"><figcaption></figcaption></figure> <figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FAGePyXGVsyC3tW7OhgrW%2Fimage.png?alt=media&#x26;token=5f892cb9-8a9a-414d-9341-23c12c0ccc64" alt="" width="287"><figcaption></figcaption></figure></div>

### 入力フォームで入力された質問文と回答文をFAQへ整える（LLM実行ノード） <a href="#llm-node" id="llm-node"></a>

#### 質問文を整える（LLM実行ノード）

LLM実行ノードでは入力フォームノードでユーザーが入力した情報を保存した変数＠QUETION\_ORIGINALをプロンプトで指定し実行し、さらに出力した結果を、変数「@SUMMARY\_QUESTION」に保存します。

* ベースモデル：OPENAI GPT-4Turbo
* プロンプト：FAQ整理（質問文整理）

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FzBX5Tw4i4AcfJAR7dCa9%2Fimage.png?alt=media&#x26;token=40edd68d-bc7f-4060-bb5e-2c38df9f430b" alt="" width="375"><figcaption></figcaption></figure>

#### 回答文を整える（LLM実行ノード） <a href="#llm-node2" id="llm-node2"></a>

LLM実行ノードでは入力フォームノードでユーザーが入力した情報を保存した変数＠ANSWER\_ORIGINALをプロンプトで指定し実行し、さらに出力した結果を、変数「@SUMMARY\_ANSWER」に保存します。

* ベースモデル：OPENAI GPT-4Turbo
* プロンプト：FAQ整理（回答文整理）

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2F5qNUJNWzxsj6oSFlaQR5%2Fimage.png?alt=media&#x26;token=585b2343-db77-4140-8b01-d85e66f38887" alt="" width="375"><figcaption></figcaption></figure>

### 生成AIで整理されたFAQを確認・修正する（入力フォーム） <a href="#form-node2" id="form-node2"></a>

LLM実行ノードで生成した結果を保存した変数@SUMMARY\_QUESTIONと@SUMMARY\_ANSWERを入力フォーム上で表示させます。入力フォームを活用することにより、LLMで生成した結果に対してさらに修正などを加える余地ができます。

* 質問文
  * 変数：QUESTION\_ORIGINAL
* 回答文
  * 変数：@QUESTION\_ORIGINAL

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FIsABgCtGNqxcmUhEtON7%2Fimage.png?alt=media&#x26;token=5d7cd818-335b-48ed-ac66-586882f0284e" alt="" width="375"><figcaption></figcaption></figure>

### FAQをAlliのナレッジベースへ登録する（連携アドバンスド） <a href="#integrate-a-d-node" id="integrate-a-d-node"></a>

APIを通じて、チャット画面から直接、整理されたFAQをナレッジベースのFAQデータとして直接登録を行います。

* URL：POST
  * <https://backend-ja.alli.ai/webapi/register_faq>
* Header1
  * API-KEY
  * **必ず、プロジェクト設定画面よりREST APIキーをコピーし、値を貼り付け直してください**
* Header2
  * Content-Type
    * application/json
* 送信するデータ1
  * status
    * ON
* 送信するデータ2
  * question
    * @SUMMARY\_QUESTION
* 送信するデータ3
  * answer
    * @SUMMARY\_ANSWER

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FZe7ruRS33ihnA0JoUUUI%2Fimage.png?alt=media&#x26;token=382bab6c-e939-4caf-8a79-b1a06af4a363" alt="" width="375"><figcaption></figcaption></figure>

公開される前に、登録したFAQがナレッジベースに登録されているか、テスト利用をした上でご利用ください。