Keural Kit

Keural Kit đưa các màn hình Keural vào trang của bạn chỉ bằng một script. Các màn hình được vẽ trong Shadow DOM, nên không bị lẫn với CSS của trang bạn. Kit được cập nhật cùng lúc khi ứng dụng web Keural được triển khai. Nếu sau khi triển khai vẫn thấy màn hình cũ, hãy xóa cache của trình duyệt và CDN, rồi kiểm tra thời điểm build bằng window.KeuralKit.__build.

Tải scriptSao chép liên kết mục

Kit được tải từ địa chỉ web của môi trường Keural bạn đang dùng. Nếu dùng keural.ai thì là https://keural.ai; với môi trường on-premise hoặc môi trường riêng, hãy dùng địa chỉ web Keural của môi trường đó. Trước khi chèn script, hãy đặt địa chỉ máy chủ mà Kit sẽ gọi vào window.__KEURAL_ENV__. Cả ba địa chỉ phải thuộc cùng một môi trường; hãy lấy từ người liên hệ Keural khi triển khai.

<script>
  window.__KEURAL_ENV__ = {
    NEXT_PUBLIC_API_BASE_URL: '<KEURAL_API_URL>',
    NEXT_PUBLIC_FAST_API_BASE_URL: '<KEURAL_AGENT_URL>',
    NEXT_PUBLIC_MODE: 'prd',
  };
</script>
<script src="<KEURAL_WEB_URL>/plugin/kit/keural.js" async></script>

Nếu dùng cùng Kit trên tên miền thứ hai, hãy đặt đủ ba giá trị NEXT_PUBLIC_ADDITIONAL_FRONTEND_URL, NEXT_PUBLIC_ADDITIONAL_API_BASE_URL và NEXT_PUBLIC_ADDITIONAL_FAST_API_BASE_URL. Thiếu bất kỳ giá trị nào sẽ gây lỗi. Các giá trị là địa chỉ https:// không có đường dẫn.

Sau khi script tải xong, window.KeuralKit được tạo ra. Trong SPA như React, hãy dùng bộ tải để script chỉ được tải một lần.

export function loadKeuralKit(src = '<KEURAL_WEB_URL>/plugin/kit/keural.js') {
  if (window.KeuralKit) return Promise.resolve(window.KeuralKit);
  return new Promise((resolve, reject) => {
    const s = document.createElement('script');
    s.src = src;
    s.async = true;
    s.onload = () => resolve(window.KeuralKit);
    s.onerror = () => {
      s.remove();
      reject(new Error('Keural Kit failed to load'));
    };
    document.head.appendChild(s);
  });
}

Nhúng chatSao chép liên kết mục

const el = document.getElementById('keural-chat')!;

window.KeuralKit.mountChat(el, {
  userInfo: { userId: user.id, name: user.name },
  colorMode: 'light',
  initialData: { message: 'Tóm tắt doanh thu quý này', room_name: 'Báo cáo quý' },
  onSessionCreated: (roomId) => router.push(`/c/${roomId}`),
  onError: () => router.push('/'),
});

// Khi rời khỏi màn hình
window.KeuralKit.unmount(el);

• Để mở một cuộc trò chuyện đã có, hãy đặt ID cuộc trò chuyện vào sessionId.
• Chỉ đưa initialData vào khi mở một cuộc trò chuyện mới. Nếu đưa vào khi mở lại cuộc trò chuyện đã có, cùng một tin nhắn sẽ được gửi lại.
• Nếu thiếu userInfo.userId, người dùng được coi là chưa đăng nhập. Hãy gắn component sau khi thông tin đăng nhập đã sẵn sàng.

Phương thứcSao chép liên kết mục

Các phương thức mount* và update* nhận colorMode và userInfo cùng lúc. unmount(el) chỉ nhận phần tử. update* vẽ lại tùy chọn trên cùng phần tử với giá trị mới. Để mở và đóng cửa sổ, hãy đổi giá trị open rồi gọi update*. Gọi lại mount* trên cùng phần tử sẽ dùng lại màn hình hiện có.

Tùy chọn của mountChatSao chép liên kết mục

initialDataSao chép liên kết mục

Ngôn ngữ màn hìnhSao chép liên kết mục

Màn hình Kit hiển thị bằng tiếng Hàn.

Cài đặt và đăng nhậpSao chép liên kết mục

• Thiết lập người dùng thay đổi trên ứng dụng web hoặc ứng dụng Keural, và màn hình Kit theo các thiết lập đó.
• Đăng nhập do dịch vụ của bạn xử lý, Kit chỉ nhận thông tin người dùng đã đăng nhập.