Container V1

Halaman ini berisi dokumentasi API untuk metode penampung dalam menerapkan modul UI. Berikut adalah fitur Agent Assist yang dapat Anda terapkan sebagai komponen dalam penampung Anda.

Atribut

Nama properti Jenis Komentar
yang didukung string Daftar kunci fitur saran Agent Assist yang dipisahkan koma untuk dirender. Contoh: "SMART_REPLY, CONVERSATION_SUMMARIZATION"
api-headers string Header tambahan yang akan disertakan dalam panggilan API Dialogflow. Contoh: "Content-Type:application/json, Accept:application/json"
conversation-profile string Nama profil percakapan yang akan digunakan.
agent-desktop AgentDesktop Software desktop agen yang akan diintegrasikan.
auth-token string Token autentikasi yang akan digunakan untuk panggilan API.
api-key string Kunci API opsional yang akan digunakan untuk panggilan API.
channel CommunicationChannel Saluran komunikasi yang digunakan untuk aplikasi ini (chat, suara, atau omnichannel).
custom-api-endpoint string Endpoint API kustom opsional yang akan digunakan (jika modul UI dikonfigurasi dengan server proxy).
tema 'dark' | 'light' Tema warna yang akan digunakan.
show-header BooleanString Apakah akan menampilkan header saran Agent Assist.
dark-mode-background string Warna latar belakang yang akan digunakan untuk mode gelap. Jika tidak ada yang ditentukan, default akan disediakan untuk desktop agen yang didukung utama.
notifier-server-endpoint string Endpoint server notifikasi yang akan digunakan untuk percakapan berbasis peristiwa.
event-based-transport EventBasedTransport Protokol transportasi yang akan digunakan untuk percakapan berbasis peristiwa.
event-based-library EventBasedLibrary Library yang akan digunakan untuk percakapan berbasis peristiwa.
oauth-client-id string Client ID OAuth opsional untuk autentikasi implisit, digunakan dalam beberapa konfigurasi desktop agen (Genesys Cloud).
redirect-uri string URI pengalihan opsional untuk membuka setelah autentikasi, digunakan dalam beberapa konfigurasi desktop agen (Genesys Cloud).
genesys-cloud-region string Region opsional untuk Genesys Cloud, defaultnya adalah mypurecloud.com.

Penggunaan

Atribut adalah properti komponen berbasis string yang dapat ditetapkan dengan cara berikut:

HTML

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

JavaScript

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

Input

Nama properti Jenis Komentar
socketIoConnectOpts SocketIoConnectOpts Opsi koneksi Socket.io tambahan.
config UiModuleContainerConfig Objek konfigurasi untuk menentukan konfigurasi spesifik modul.

Penggunaan

Input biasanya berupa objek JavaScript atau jenis properti kompleks lainnya yang harus ditetapkan langsung pada instance elemen:

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

Jenis

Lihat bagian berikut untuk mengetahui jenis kustom yang digunakan oleh komponen.

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";
  };
}