コンテナ

このページでは、UI モジュールを実装する Container メソッドの API ドキュメントについて説明します。コンテナ内のコンポーネントとして実装できる Agent Assist の機能は次のとおりです。

使用方法

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

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

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

<agent-assist-ui-modules>

属性

プロパティ名 タイプ コメント
機能 文字列 レンダリングする Agent Assist の候補機能キーのカンマ区切りのリスト。例: 「SMART_REPLY, CONVERSATION_SUMMARIZATION」
api-headers 文字列 Dialogflow API 呼び出しに含める追加のヘッダー。例: "Content-Type:application/json, Accept:application/json"
conversation-profile 文字列 使用する会話プロファイルの名前。
agent-desktop AgentDesktop 統合するエージェント デスクトップ ソフトウェア。
auth-token 文字列 API 呼び出しに使用する認証トークン。
api-key 文字列 API 呼び出しに使用する API キー（省略可）。
channel CommunicationChannel このアプリケーションに使用されるコミュニケーション チャネル（チャット、音声、オムニチャネル）。
custom-api-endpoint 文字列 使用するオプションのカスタム API エンドポイント（UI モジュールがプロキシ サーバーで構成されている場合）。
テーマ 'dark' | 'light' 使用するカラーテーマ。
show-header BooleanString Agent Assist の返信文候補のヘッダーを表示するかどうか。
dark-mode-background 文字列 ダークモードで使用する背景色。指定しない場合、サポートされているプライマリ エージェント デスクトップにデフォルトが設定されます。
notifier-server-endpoint 文字列 イベントベースの会話に使用する通知サーバー エンドポイント。
event-based-transport EventBasedTransport イベントベースの会話に使用するトランスポート プロトコル。
event-based-library EventBasedLibrary イベントベースの会話に使用するライブラリ。
oauth-client-id 文字列 暗黙的認証用の OAuth クライアント ID（一部のエージェント デスクトップ構成で使用）。
redirect-uri 文字列 認証後に移動するオプションのリダイレクト URI。一部のエージェント デスクトップ構成（Genesys Cloud）で使用されます。
genesys-cloud-region 文字列 Genesys Cloud のオプションのリージョン。デフォルトは mypurecloud.com です。

使用方法

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

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

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

JavaScript コードから:

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

入力

プロパティ名 タイプ コメント
socketIoConnectOpts SocketIoConnectOpts その他の Socket.io 接続オプション。
構成 UiModuleContainerConfig モジュール固有の構成を定義する構成オブジェクト。

使用方法

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

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

型

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

AgentDesktop

"LivePerson" | "GenesysCloud" | "SalesForce" | "Custom"

CommunicationChannel

"chat" | "voice" | "omnichannel"

BooleanString

"true" | "false"

EventBasedTransport

"websocket" | "polling"

EventBasedLibrary

"SocketIo"

SocketIoConnectOpts

interface SocketIoConnectOpts extends SocketIOClient.ConnectOpts {
  auth: {
    token: string;
  };
  withCredentials?: boolean;
}

UiModuleContainerConfig

interface UiModuleContainerConfig {
  knowledgeAssistConfig?: {
    articleLinkConfig: {
      /**
       * Whether to open the article in a new tab or as a dialog. 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;
    };
  };
  knowledgeAssistV2Config?: {
    articleLinkConfig?: {
      /**
       * Whether to open the article in a new tab or as a dialog. 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;
  };
  summarizationConfig?: {
    /**
     * Optional callback that can be used to save the generated summary to an
     * external source.
     */
    onSaveSummary?: (
      summary: {
        summary: string;
        conversationDetails: ConversationDetails;
      },
      saveCallbacks: {
        setLoading: () => void;
        setSuccess: (message: string) => void;
        setError: (message: string) => void;
      }
    ) => void;

    /** Whether to show the 'Generate summary' button. */
    showGenerateSummaryButton?: "true" | "false";
  };
}