ナレッジ アシスト

このページには、Knowledge Assist UI モジュールの API ドキュメントが記載されています。このモジュールは、会話中に役立つ記事やよくある質問の候補をエージェントに表示するために使用されます。

使用方法

次のコードを使用して、HTML ページにモジュールをインポートします。

<script src="https://www.gstatic.com/agent-assist-ui-modules/v1/knowledge_assist.js"></script>

次のタグを使用してモジュールを埋め込みます。

<agent-assist-knowledge-assist>

属性

プロパティ名	タイプ	コメント
機能	文字列	レンダリングするナレッジ アシスト機能（ARTICLE_SUGGESTION、FAQ、ARTICLE_SEARCH）のカンマ区切りのリスト。

使用方法

属性は文字列ベースのコンポーネント プロパティで、次の方法で設定できます。

HTML テンプレートから直接:

<element-selector property-name="value">

JavaScript コードから:

var el = document.querySelector('element-selector');
el.setAttribute('property-name', 'value');

入力

プロパティ名	タイプ	コメント
構成	KnowledgeAssistConfig	Knowledge Assist モジュールのオプションの構成。

使用方法

入力は通常、JavaScript オブジェクトやその他の複雑なプロパティ タイプで、要素インスタンスに直接割り当てる必要があります。

const el = document.querySelector('element-selector');
el.propertyName = value;

型

コンポーネントで使用されるカスタム型については、次のセクションをご覧ください。

KnowledgeAssistConfig

interface KnowledgeAssistConfig {
  articleLinkConfig: {
    /**
     * Whether to open the article in a new tab, or as a popup. Defaults to new
     * tab.
     */
    target?: "blank" | "popup";
    /**
     * Options to configure the popup's size and location. See
     * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
     */
    popupWindowOptions?: string;
    /**
     * The field name on the document metadata if a separate article link source
     * is provided.
     */
    linkMetadataKey?: string;
  };
}