ナレッジ アシスト

このページでは、ナレッジ アシスト V2 とも呼ばれる生成ナレッジ アシスト UI モジュールの API ドキュメントについて説明します。このモジュールは、エージェントが会社のナレッジベースをクエリして、生成 AI を活用した回答を受け取るために使用されます。

用途

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

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

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

<agent-assist-knowledge-assist-v2>

属性

プロパティ名	タイプ	コメント
session-id	文字列	会話ベース以外の使用状況のセッション ID（省略可）。
親	文字列	会話ベース以外の使用に使用する親プロジェクトのロケーション名。例: 「projects/foo/locations/global」

用途

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

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

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

JavaScript コードから:

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

入力

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

用途

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

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

型

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

KnowledgeAssistV2Config

interface KnowledgeAssistV2Config {
  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;
  };
  showCopyAnswer: boolean;
  showPasteAnswer: boolean;
}