Bantuan Pengetahuan

Halaman ini berisi dokumentasi API untuk modul UI Knowledge Assist. Modul ini digunakan untuk menampilkan artikel bermanfaat dan saran FAQ kepada agen selama percakapan berlangsung.

Penggunaan

Impor modul di halaman HTML Anda menggunakan kode berikut:

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

Sematkan modul menggunakan tag berikut:

<agent-assist-knowledge-assist>

Atribut

Nama properti Jenis Komentar
yang didukung string Daftar fitur Bantuan Pengetahuan yang dipisahkan koma yang harus dirender (SARAN_ARTIKEL, FAQ, dan PENCARIAN_ARTIKEL).

Penggunaan

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

Langsung dari template HTML Anda:

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

Dari kode JavaScript Anda:

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

Input

Nama properti Jenis Komentar
config KnowledgeAssistConfig Konfigurasi opsional untuk modul Bantuan Pengetahuan.

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.

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