目的 |
BIZTELサーバと外部APIとのサーバ連携を行う機能となります。 外部APIとしてOpenAI(ChatGPT)と連携し、BIZTEL内に通話の要約内容を保存する設定例です。 ※BIZTEL管理画面上での手動操作での要約をご希望の場合、AI連携オプションの項目をご参照ください。 |
---|---|
対象プラン |
|
用語 |
【ChatGPT】 |
ポイント |
・本機能をご利用いただく場合、以下の条件がございますのでご注意ください。 1.BIZTELバージョン 3.9.0 以上であること ・その他にお客様で以下外部サービスをご契約いただく必要がございます。 1.OpenAIのご契約 |
・本マニュアルはHTML/PHP(PCRE正規表現等)/WebAPIの基礎的な技術知識がある、WEB系開発者様やCRMベンダー様を対象にしております。
目次
1. 動作イメージ
BIZTELバージョン 3.9.0 以降、コールアクションオプションのレスポンス内容をBIZTEL内に保管可能となりました。
本マニュアルでは、OpenAI社のChatGPTと連携し、通話内容の要約結果をBIZTEL内に保管する動作を紹介します。
2. 音声認識連携の設定
BIZTELの通話内容をテキスト化したデータを元にChatGPTで要約を行うため、音声認識連携の設定が必要です。
1.音声認識連携(AmiVoice API)に従い設定ください。
3. OpenAIのAPIキーの発行
OpenAIの APIキー発行方法を説明します。
※OpenAIのご契約が済んでいる前提での説明となります。ご契約が済んでいない場合は、OpenAIのライセンスをご契約後に対応ください。
※本内容は2024年7月時点の参考情報となり、OpenAI社の仕様変更等により手順が変わる可能性があります。OpenAIの操作に関しては、OpenAI社へご確認ください。
手順1.OpenAI社のサイトの右上にある「Dashboard」をクリックします。
手順2.左側にある「API Keys」をクリックし、「Create new secret key」をクリックします。
手順3.各項目を入力し、「Create new secret key」をクリックします。
Owned by | 「You」を選択します。
※個人ユーザーに紐づけられ、指定したプロジェクトに対するリクエストが可能です。プロジェクトから外れるとキーは無効になります。 ※「Service account」はシステムやアプリを自動で操作するための専用アカウントとなり、本機能の対象外です。 |
---|---|
Name | 任意の名称を入力します。 |
project※ | 任意のプロジェクトを選択します。 |
Permissons |
以下のいずれかを選択します。 All Restricted |
※projectを新規作成する場合の手順は以下の通りです。
①右上の「歯車マーク」>「project」をクリックします。
②右上にある「+Create」をクリックし、任意の名称を登録後に「Create」をクリックします。
手順4.API KEY(sk-から始まる英数字)をコピーし、テキスト等に保存後、「Done」をクリックします。
※本操作以降、発行したAPIキーは再表示できないため必ずコピーしてください。
保存したAPI KEYは「4.2 API連携の設定」で利用します。
4. コールアクションの設定
OpenAIとの連携のため、コールアクションの設定を行います。
4.1 コールアクションの作成
手順1.「連携オプション」>「コールアクション連携」をクリックします。
手順2.「新規」をクリックします。
手順3.コールアクション名を入力し、保存します。
※ステータスは「有効」を選択します。
続けて「4.2 API連携の設定」を実施します。
4.2 API連携の設定
手順1.コールアクションの作成後、「API連携」タブをクリックします。
手順2.「新規」をクリックします。
手順3.以下の内容に従い各項目を入力し、保存します。
イベント種別 | 「録音完了 / 音声認識連携完了」を選択します。 |
---|---|
実行順 | 「1」を選択します。 |
メモ | 空欄で問題ありません。 ※任意で入力ください。 |
判定用コード | 空欄で問題ありません。 |
判定評価パターン | 空欄で問題ありません。 |
API連携種別 | 「マニュアル」を選択します。 |
URL |
以下の値を入力します。
https://api.openai.com/v1/chat/completions |
メソッド | 「POST」を選択します。 |
リクエストヘッダ |
以下の値を入力します。
Authorization:Bearer APIKEY Content-Type:application/json
※APIKEYは「3. OpenAIのAPI KEYの発行」で取得したAPI KEYを入力ください。
|
リクエストボディ |
音声認識連携でテキスト化される内容をChatGPTへ学習させ、通話内容を500字以内で要約及び、事後対応が必要なタスクをリスト化するという内容を連携するため、以下の値を入力します。 ※modelには利用したいエンジン名を設定します。本事例では「gpt-3.5-turbo」を設定しています。
|
タイムアウト判定(秒) | 「30」を選択します。 |
JSON加工 | 空欄で問題ありません。 |
変数抽出パターン |
以下の値を入力します。 /"content":"(?P<SUMMARY>[^"]+)"/
|
処理種別 | 「通話履歴のAI解析へ保存」を選択します。 |
保存内容(プロンプト) |
「500文字以内で簡潔に要約してください。」と入力します。 ※ChatGPTに対しての指示内容を入力します。 |
保存内容(AI解析) |
以下の値を入力します。 {RESPONSE_SUMMARY}
|
エラー判定パターン | 空欄で問題ありません。 |
リトライ回数 | 「0」を選択します。 |
リトライ間隔(秒) | 「2」を選択します。 |
4.3 連携対象電話番号の選択
手順1.「連携対象」タブをクリックします。
手順2.「編集」をクリックします。
手順3.コールアクションを動作させる電話番号にチェックを入れ、保存します。
以上で設定完了です。
5. 動作確認
5.1 正常に動作している場合
設定が正常に完了している場合、通話完了後に以下履歴に解析結果が連携されます。
・ワークスペース
・発着信履歴
・コールセンター履歴
・業務ラベル履歴
例)各履歴では通話履歴をクリックすることで解析結果を表示することが可能です。
コールアクションの設定との関連性
コールアクションの設定は、各履歴とワークスペース上に表示されます。
5.2 連携に失敗している場合
連携が失敗している場合、「コールアクション履歴」「外部API連携履歴」から失敗原因をご確認ください。
5.2.1 コールアクション履歴
コールアクション履歴は以下から確認可能です。
①「連携オプション」>「コールアクション連携」>「履歴を見るコールアクション」> 履歴タブ
※本メニューから履歴を参照する場合、選択したコールアクションの履歴のみを表示します。
②「履歴・状況」>「コールアクション履歴」
※本メニューから履歴を参照する場合、設定されている全てのコールアクションの履歴検索が可能です。
履歴の詳細を確認する
検索して表示された結果をクリックすると詳細画面が表示されます。
連携に失敗している場合は、赤枠内のように"抽出データが見つかりません"といったメッセージが表示されていることが確認できます。
更に詳細を確認する場合は、「参照」ボタンをクリックする事で外部API連携履歴へ遷移しますので詳細なエラー内容を確認可能です。
5.2.2 外部API連携履歴
外部API連携履歴は以下から確認可能です。
①「コールアクション連携」>「履歴を見るコールアクション」> 履歴タブ > 検索結果の詳細画面内の参照ボタン
※本手順で外部API連携履歴を参照する場合は、該当のコールアクション履歴の検索条件が指定された状態で表示されます。
②「履歴・状況」>「外部API連携履歴」
※本メニューから検索する場合は、検索条件を指定して該当の履歴を検索する必要があります。
履歴の詳細を確認する
表示された履歴をクリックすると、コールアクションの連携内容の詳細を確認可能です。
以下の場合、レスポンスボディ内に message:Incorrect API key provided と表示されているため、OpenAI の API KEYの入力値に誤りがあると読み解くことが可能です。
また、API連携時に例外エラーが発生した場合は、エラー情報にエラーコードが記録されます。
※エラーコードの一覧は「1.外部API連携履歴」を参照ください。
6. 注意事項
● AI解析結果は、10,000件が保存上限となります。
● 保存上限を超えた場合、毎日夜間帯で保存上限以内となるよう古いデータから削除されますので、必要に応じて画面内のコピーボタンにて、解析結果を保存し、テキスト等で保管ください。