Keural Kit

Keural Kit bindet Keural-Ansichten mit einem einzigen Skript in Ihre Seite ein. Die Ansichten werden innerhalb eines Shadow DOM gezeichnet, sodass sie sich nicht mit dem CSS Ihrer Seite vermischen. Kit wird bei jeder Bereitstellung der Keural-Webanwendung mit aktualisiert. Wird nach einer Bereitstellung noch eine alte Ansicht angezeigt, leeren Sie den Cache von Browser und CDN und prüfen Sie den Build-Zeitpunkt mit window.KeuralKit.__build.

EinbindenAnkerlink kopieren

Kit wird über die Webadresse der von Ihnen genutzten Keural-Umgebung geladen. Bei keural.ai ist das https://keural.ai; bei einer On-Premises- oder dedizierten Umgebung verwenden Sie die Keural-Webadresse dieser Umgebung. Bevor Sie das Skript einbinden, legen Sie in window.__KEURAL_ENV__ die Serveradressen fest, die Kit aufruft. Alle drei Adressen müssen zur selben Umgebung gehören; Sie erhalten sie bei der Einführung von Ihrem Keural-Ansprechpartner.

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

Wenn Sie dasselbe Kit auch auf einer zweiten Domain verwenden, tragen Sie zusätzlich NEXT_PUBLIC_ADDITIONAL_FRONTEND_URL, NEXT_PUBLIC_ADDITIONAL_API_BASE_URL und NEXT_PUBLIC_ADDITIONAL_FAST_API_BASE_URL ein. Fehlt einer dieser drei Werte, tritt ein Fehler auf. Die Werte sind https://-Adressen ohne Pfad.

Nach dem Laden des Skripts existiert window.KeuralKit. In SPAs wie React erstellen Sie einen Loader, damit das Skript nur einmal eingebunden wird.

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

Chat einbindenAnkerlink kopieren

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

window.KeuralKit.mountChat(el, {
  userInfo: { userId: user.id, name: user.name },
  colorMode: 'light',
  initialData: { message: 'Fasse den Quartalsumsatz zusammen', room_name: 'Quartalsbericht' },
  onSessionCreated: (roomId) => router.push(`/c/${roomId}`),
  onError: () => router.push('/'),
});

// Beim Verlassen der Ansicht
window.KeuralKit.unmount(el);

• Um eine bestehende Unterhaltung zu öffnen, tragen Sie deren ID in sessionId ein.
• initialData fügen Sie nur beim Öffnen einer neuen Unterhaltung hinzu. Wird es beim erneuten Öffnen einer bestehenden Unterhaltung angegeben, wird dieselbe Nachricht erneut gesendet.
• Fehlt userInfo.userId, gilt der Benutzer als nicht angemeldet. Binden Sie die Komponente ein, wenn die Anmeldeinformationen bereitstehen.

MethodenAnkerlink kopieren

Die Methoden mount* und update* erhalten colorMode und userInfo gemeinsam. unmount(el) erhält nur das Element. update* zeichnet die Optionen auf demselben Element neu. Zum Öffnen und Schließen des Fensters ändern Sie den Wert von open und rufen update* auf. Ruft man mount* erneut auf demselben Element auf, wird die vorhandene Ansicht wiederverwendet.

Optionen von mountChatAnkerlink kopieren

initialDataAnkerlink kopieren

Sprache der AnsichtAnkerlink kopieren

Die Kit-Ansicht wird auf Koreanisch angezeigt.

Einstellungen und AnmeldungAnkerlink kopieren

• Benutzereinstellungen ändern Sie in der Keural-Webanwendung oder in der App. Die Kit-Ansicht übernimmt diese Einstellungen.
• Die Anmeldung übernimmt Ihr Dienst, an Kit werden nur die Informationen des angemeldeten Benutzers übergeben.