目次:
1. イントロダクション
2. ナレッジベースAPIの使用方法
3. APIの動作方法
4. APIの設定
5. ユーザーの質問のキャプチャ
6. APIコールの作成
7. APIレスポンスの分析
8. APIレスポンス変数の保存
9. 回答が見つからない場合の処理
10. ユーザー向けの回答のフォーマット
11. ユーザーに記事を提供する
12. 結論
**ナレッジベースAPIの使用方法**
このチュートリアルでは、ナレッジベースAPIを使用して、ウェブサイトの機能を強化する方法について説明します。このAPIは、ナレッジベースをパワーアップし、回答のソースを含めることができます。
**イントロダクション**
Voice LowのナレッジベースAPIは、ウェブサイトの記事から情報を取得する強力なツールです。このAPIをプロジェクトに統合することで、回答のソースに関する詳細な情報にアクセスでき、回答をより情報豊富で信頼性の高いものにすることができます。
**APIの動作方法**
ユーザーが質問をすると、APIはウェブサイトのすべての記事を検索して、最も関連性の高い情報を見つけます。記事を小さなチャンクに分割し、最適な回答を決定するために分析します。APIはまた、回答が派生した記事のURLも提供し、ソースに関する詳細な情報を提供します。
**APIの設定**
ナレッジベースAPIを使用するには、プロジェクトの統合セクションからAPIキーを取得する必要があります。各プロジェクトには固有のAPIキーがあり、これをコピーしてAPIコールで使用できます。このキーはリクエストを認証し、ナレッジベースにアクセスすることを可能にします。
**ユーザーの質問のキャプチャ**
プロジェクトで、キャプチャステップを使用してユーザーの質問をキャプチャできます。このステップは、ユーザーの質問を「最後の発話」という変数に保存します。この変数は、ナレッジベースから回答を取得するためのAPIコールで使用されます。
**APIコールの作成**
ナレッジベースから回答を取得するには、APIキーとユーザーの質問を使用してAPIコールを行う必要があります。APIコールはこれらのパラメータを期待し、回答とそのソースに関する追加情報を含むレスポンスを返します。
**APIレスポンスの分析**
APIレスポンスには、回答、回答が取得された記事のチャンク、およびソース記事のURLなど、さまざまな情報が含まれています。このレスポンスを分析することで、回答がどのように派生したか、およびそれに貢献した記事の特定の部分を把握できます。
**APIレスポンス変数の保存**
APIレスポンスを保存するには、レスポンスをキャプチャする関数を使用できます。これらの関数を使用すると、APIレスポンスから特定の情報を抽出して変数に保存できます。関連する情報を保存することで、後で会話フローで使用できます。
**回答が見つからない場合の処理**
場合によっては、APIがユーザーの質問に適切な回答を見つけられない場合があります。そのような場合は、一般的なAIモデルを使用して応答を提供するなど、フォールバックアプローチを使用できます。これにより、ユーザーが常に何らかの回答を受け取ることができます。
**ユーザー向けの回答のフォーマット**
回答が見つかった場合、ユーザーがより読みやすくするためにフォーマットすることができます。JavaScriptステップを使用することで、回答の内容と構造を変更して、明確さと表現力を高めることができます。
**ユーザーに記事を提供する**
回答の信頼度が高い場合、信頼性の高い回答を示す場合、回答が派生した記事をユーザーに提供することができます。これは、URLに基づいて記事名を生成し、リンクと簡単な説明をカード形式で含めることで行うことができます。
**結論**
このチュートリアルでは、Voice LowのナレッジベースAPIを使用して、ウェブサイトの機能を強化する方法について説明しました。APIの機能を活用することで、ユーザーにより情報豊富でコンテキストに富んだ回答を提供することができます。質問やサポートが必要な場合は、サポートチームにお問い合わせいただくか、Discordコミュニティに参加してください。
---
**ハイライト:**
- Voice LowのナレッジベースAPIの使用方法を学ぶ
- 回答のソースに関する詳細な情報を取得する
- ユーザーの質問をキャプチャし、APIコールを行う
- APIレスポンスを分析し、関連する変数を保存する
- 回答が見つからない場合の処理
- ユーザー向けの回答をフォーマットする
- ユーザーに記事を提供する
---
**FAQ:**
Q:ナレッジベースAPIのAPIキーを取得するにはどうすればよいですか?
A:プロジェクトの統合セクションで固有のAPIキーを見つけることができます。これにより、リクエストが認証され、ナレッジベースにアクセスできるようになります。
Q:APIがユーザーの質問に回答を見つけられなかった場合、どうなりますか?
A:そのような場合は、一般的なAIモデルを使用して応答を提供するなど、フォールバックアプローチを使用できます。これにより、ユーザーが常に何らかの回答を受け取ることができます。
Q:ユーザー向けの回答のフォーマットをカスタマイズできますか?
A:はい、JavaScriptステップを使用して、回答の内容と構造を変更して、より読みやすくユーザーフレンドリーにすることができます。
Q:ユーザーに記事を提供するにはどうすればよいですか?
A:回答の信頼度が高い場合、URLに基づいて記事名を生成し、リンクと簡単な説明をカード形式で含めることで、ユーザーに記事を提供することができます。
Q:どこでさらなる支援やサポートを受けることができますか?
A:質問やサポートが必要な場合は、サポートチームにお問い合わせいただくか、Discordコミュニティに参加してください。
---
リソース:
- [Voice Low AI Chatbot](https://www.voc.ai/product/ai-chatbot)