提供: Bright Pattern Documentation
• English
onSearchKnowledgeBase
これは、Communicatorウィジェットから外部ナレッジベースの検索を実行するためのハンドラです。返された結果は、検索結果リストとして表示されます。
注
:データを返すハンドラを複数設定した場合、最後のハンドラからの結果のみが使用されます。
リクエスト
構文
on('ON_SEARCH_KNOWLEDGE_BASE', handler: OnSearchKnowledgeBaseHandler): void
type OnSearchKnowledgeBaseHandler = (query: string) => ExternalKBSearchResult[] | Promise<EXTERNALKBSEARCHRESULT[]>
type ExternalKBSearchResult = {
id: string
text: string
}
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| query | 文字列 | 必須 | 外部ナレッジベースで実行したい検索クエリ |
リクエスト例
Microsoft Dynamics 365 には、KB (ナレッジベース) 記事が収録された独自のナレッジベースがあります。コールバック onSearchKnowledgeBase を使用すると、コンタクトセンターでは、当社のエージェントデスクトップアプリケーションから Microsoft Dynamics 365 ナレッジベース内で検索を実行できます。
jsApi.on("ON_SEARCH_KNOWLEDGE_BASE", function (query) {
// コンタクトセンターからのクエリを使用して、外部のナレッジベースを検索します
const results = searchExternalKBArticles(query);
// 検索結果をコンタクトセンターに返します
return results;
});
戻り値
| オブジェクト | オブジェクトの値 | データ型 | オプションですか?(はい/いいえ) | 値の説明 |
| ExternalKBSearchResult | ||||
| id | 文字列 | N | onGetKnowledgeBaseArticleハンドラによってリクエストされる記事の一意のidです。 | |
| テキスト | 文字列 | N | 記事のコンテンツのテキストプレビュー |