Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Design und Funktionen in ChatKit anpassen

Lege Farben, Typografie, Informationsdichte und Komponentenvarianten fest.

Wenn du den ChatKit-Schnellstart abgeschlossen hast, kannst du das Design und die Funktionen deines eingebetteten Chats anpassen. Wähle passend zu deiner App ein helles oder dunkles Design, lege eine Akzentfarbe fest und stelle ein, wie dicht die Inhalte angeordnet und wie stark die Ecken abgerundet sind.

Überblick

Um das Design anzupassen, übergibst du ein Objekt mit den gewünschten Optionen. Wenn du ChatKit wie im ChatKit-Schnellstart beschrieben in dein Frontend eingebunden hast, verwende die folgende React-Syntax.

  • React: Übergib die Optionen an useChatKit({...}).
  • Erweiterte Integrationen: Lege die Optionen mit chatkit.setOptions({...}) fest.

Das Optionsobjekt hat bei beiden Integrationsarten dieselbe Struktur.

Anpassungsmöglichkeiten erkunden

In ChatKit Studio findest du lauffähige ChatKit-Beispiele und interaktive Werkzeuge zum Gestalten deiner Oberfläche. Wenn du lieber direkt etwas ausprobierst, als eine Anleitung zu lesen, kannst du hier einsteigen.

Die ChatKit-Oberfläche erkunden

chatkit.world

Probiere ChatKit in einer interaktiven Demo aus.

Widget-Editor

Stöbere in den verfügbaren Widgets.

ChatKit Playground

Entdecke die Funktionen, indem du sie in einer interaktiven Demo ausprobierst.

Lauffähige Beispiele ansehen

Beispiele auf GitHub

Lass dich von lauffähigen ChatKit-Beispielen inspirieren.

Repository der Starter-App

Klone das Repository, um mit einer voll funktionsfähigen Vorlage zu starten.

Design ändern

Passe den Chat an das Erscheinungsbild deines Produkts an, indem du unter anderem Farben und Typografie festlegst. Im folgenden Beispiel aktivieren wir den Dunkelmodus, ändern die Farben, runden die Ecken ab, passen die Informationsdichte an und legen die Schriftart fest.

Alle Designoptionen findest du in der API-Referenz.

import type { ChatKitOptions } from "@openai/chatkit";

const options: Partial<ChatKitOptions> = {
  theme: {
    colorScheme: "dark",
    color: {
      accent: {
        primary: "#2D8CFF",
        level: 2,
      },
    },
    radius: "round",
    density: "compact",
    typography: { fontFamily: "'Inter', sans-serif" },
  },
};

Text auf dem Startbildschirm anpassen

Passe den Platzhaltertext im Editor an, um mögliche Fragen vorzuschlagen oder bei der ersten Eingabe zu helfen.

const options: Partial<ChatKitOptions> = {
  composer: {
    placeholder: "Ask anything about your data…",
  },
  startScreen: {
    greeting: "Welcome to FeedbackBot!",
  },
};

Prompts zum Einstieg in neue Threads anzeigen

Schlage zu Beginn eines Gesprächs Prompts vor, die zeigen, welche Fragen man stellen oder welche Aktionen man ausführen kann.

const options: Partial<ChatKitOptions> = {
  startScreen: {
    greeting: "What can I help you build today?",
    prompts: [
      {
        label: "Check on the status of a ticket",
        prompt: "Can you help me check on the status of a ticket?",
        icon: "search",
      },
      {
        label: "Create Ticket",
        prompt: "Can you help me create a new support ticket?",
        icon: "write",
      },
    ],
  },
};

Eigene Schaltflächen zur Kopfzeile hinzufügen

Mit eigenen Schaltflächen in der Kopfzeile kannst du Navigationsziele, Kontextinformationen oder Aktionen anbieten, die zu deiner Integration passen.

const options: Partial<ChatKitOptions> = {
  header: {
    leftAction: {
      icon: "settings-cog",
      onClick: () => openProfileSettings(),
    },
    rightAction: {
      icon: "home",
      onClick: () => openHomePage(),
    },
  },
};

Dateianhänge aktivieren

Dateianhänge sind standardmäßig deaktiviert. Um sie zu aktivieren, ergänze die Konfiguration für Anhänge. Wenn du kein eigenes Backend verwendest, musst du die Upload-Strategie hosted verwenden. Wie andere Upload-Strategien mit einem eigenen Backend funktionieren, erfährst du in der Dokumentation zum Python-SDK.

Du kannst auch festlegen, wie viele Dateien sich an eine Nachricht anhängen lassen, wie groß sie sein dürfen und welche Dateitypen zulässig sind.

const options: Partial<ChatKitOptions> = {
  composer: {
    attachments: {
      enabled: true,
      maxSize: 20 * 1024 * 1024, // 20 MB per file
      maxCount: 3,
      accept: { "application/pdf": [".pdf"], "image/*": [".png", ".jpg"] },
    },
  },
};

@-Erwähnungen im Editor mit Entitäts-Tags aktivieren

Ermögliche es, eigene „Entitäten“ mit @-Erwähnungen zu markieren. So erhält das Gespräch zusätzlichen Kontext und mehr Interaktionsmöglichkeiten.

  • Verwende onTagSearch, um passend zur Suchanfrage eine Liste von Entitäten zurückzugeben.
  • Verwende onClick, um auf einen Klick auf eine Entität zu reagieren.
const options: Partial<ChatKitOptions> = {
  entities: {
    async onTagSearch(query) {
      void query;
      return [
        {
          id: "user_123",
          title: "Jane Doe",
          group: "People",
          interactive: true,
        },
        {
          id: "document_123",
          title: "Quarterly Plan",
          group: "Documents",
          interactive: true,
        },
      ];
    },
    onClick: (entity) => {
      navigateToEntity(entity.id);
    },
  },
};

Darstellung von Entitäts-Tags anpassen

Mit Widgets kannst du anpassen, was erscheint, wenn jemand den Mauszeiger über ein Entitäts-Tag bewegt. Zeige dann zum Beispiel eine Visitenkarte, eine Dokumentzusammenfassung oder ein Bild als Vorschau an.

Widget-Editor

Stöbere in den verfügbaren Widgets.

const options: Partial<ChatKitOptions> = {
  entities: {
    async onTagSearch() {
      return [];
    },
    onRequestPreview: async (entity) => ({
      preview: {
        type: "Basic",
        children: [
          { type: "Text", value: `Profile: ${entity.title}` },
          { type: "Text", value: "Role: Developer" },
        ],
      },
    }),
  },
};

Eigene Tools zum Editor hinzufügen

Erleichtere die Arbeit, indem du Aktionen deiner App direkt über die Editorleiste zugänglich machst. Das ausgewählte Tool wird dem Modell als bevorzugtes Tool übermittelt.

const options: Partial<ChatKitOptions> = {
  composer: {
    tools: [
      {
        id: "add-note",
        label: "Add Note",
        icon: "write",
        pinned: true,
      },
    ],
  },
};

Bereiche und Funktionen der Oberfläche ein- und ausschalten

Wenn dir die Optionen in der Kopfzeile nicht ausreichen und du eigene Lösungen umsetzen möchtest, kannst du zentrale Bereiche und Funktionen der Oberfläche deaktivieren. Den Verlauf zu deaktivieren kann sinnvoll sein, wenn Threads und ein Gesprächsverlauf für deinen Anwendungsfall keine Rolle spielen, etwa bei einem Support-Chatbot.

const options: Partial<ChatKitOptions> = {
  history: { enabled: false },
  header: { enabled: false },
};

Gebietsschema überschreiben

Wenn deine App eine zentrale Spracheinstellung hat, kannst du damit das Standardgebietsschema überschreiben. Standardmäßig verwendet ChatKit das Gebietsschema des Browsers.

const options: Partial<ChatKitOptions> = {
  locale: "de-DE",
};