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

Richtlinien für die Benutzeroberfläche

So gestaltest du optionale Benutzeroberflächen für Plugins in ChatGPT.

Überblick

Mit einer optionalen Benutzeroberfläche kann dein Plugin zusätzliche Aktionen anbieten, ohne das Gespräch zu unterbrechen. Verwende Karten, Karussells, Vollbildansichten und andere Anzeigemodi nur, wenn die visuelle Interaktion einen Arbeitsschritt erleichtert.

Beispiele für Apps in der mobilen ChatGPT-Oberfläche

Designsystem

Mit der Komponentenbibliothek @openai/apps-sdk-ui kannst du hochwertige Benutzeroberflächen gestalten, die sich nahtlos in ChatGPT einfügen.

Die Bibliothek bietet Gestaltungsgrundlagen mit Tailwind, Design-Tokens in Form von CSS-Variablen und eine Auswahl sorgfältig gestalteter, barrierefreier Komponenten.

Die Komponentenbibliothek ist optional. Mit ihr kannst du schneller Komponenten entwickeln, die zum Designsystem von ChatGPT passen.

Entwirf deine Oberfläche mit unserer Komponentenbibliothek für Figma, bevor du mit der Implementierung beginnst.

Anzeigemodi

Der Anzeigemodus bestimmt, wie deine App in ChatGPT erscheint und wie sich ihre Funktionen bedienen lassen. Über diese Ansichten können Partnerunternehmen Inhalte und Aktionen direkt im Gespräch anbieten. Jeder Modus ist auf eine bestimmte Art der Interaktion zugeschnitten, von der schnellen Bestätigung bis zum mehrstufigen Arbeitsablauf in einer eigenen Ansicht.

Wenn du die Modi einheitlich einsetzt, bleibt die Bedienung einfach und vorhersehbar.

Inline-Anzeige

Im Inline-Modus erscheint die App direkt im Gesprächsverlauf. Inline-Ansichten stehen derzeit immer vor der vom Modell generierten Antwort. Jede App erscheint zunächst im Inline-Modus.

Beispiele für Inline-Karten und Inline-Karussells in ChatGPT

Aufbau

  • Symbol und Tool-Aufruf: Eine Kennzeichnung mit dem Namen und dem Symbol der App.
  • Inline-Anzeige: Eine kompakte Ansicht mit App-Inhalten oberhalb der Modellantwort.
  • Anschließende Antwort: Nach dem Widget schlägt das Modell in einer kurzen Antwort Änderungen, nächste Schritte oder verwandte Aktionen vor. Vermeide Wiederholungen von Karteninhalten.

Inline-Karte

Inline-Karten sind kompakte Widgets, die direkt im Gespräch erscheinen und jeweils einen bestimmten Zweck erfüllen. Sie ermöglichen schnelle Bestätigungen und einfache Aktionen oder dienen als visuelle Hilfen.

Wann eignet sich eine Inline-Karte?

  • Für eine einzelne Aktion oder Entscheidung, etwa um eine Buchung zu bestätigen.
  • Für wenige strukturierte Informationen, etwa eine Landkarte, eine Bestellübersicht oder eine kurze Statusmeldung.
  • Für ein eigenständig nutzbares Widget oder Tool, etwa einen Audioplayer oder eine Spielstandsanzeige.

Aufbau

Schematischer Aufbau von Inline-Karten

  • Titel: Gib der Karte einen Titel, wenn sie auf einem Dokument basiert oder Einträge enthält, die zu einem übergeordneten Element gehören, etwa die Titel einer Playlist.
  • Erweitern: Öffne mit dieser Aktion eine Vollbildansicht, wenn die Karte Multimedia-Inhalte oder interaktive Elemente wie eine Landkarte oder ein interaktives Diagramm enthält.
  • Mehr anzeigen: Mit dieser Aktion kannst du weitere Einträge einblenden, wenn du mehrere Ergebnisse als Liste darstellst.
  • Bedienelemente zum Bearbeiten: Ermögliche es, Antworten der App direkt in der Karte zu bearbeiten, ohne den Gesprächsverlauf zu überladen.
  • Hauptaktionen: Platziere höchstens zwei Aktionen am unteren Rand der Karte. Jede Aktion sollte einen weiteren Gesprächsschritt oder einen Tool-Aufruf auslösen.

Interaktion

Interaktionsmöglichkeiten bei Inline-Karten

Karten ermöglichen einfache Interaktionen direkt mit ihrem Inhalt.

  • Zustand: Änderungen bleiben gespeichert.
  • Einfache Änderungen direkt in der Karte: Wo es sinnvoll ist, kannst du Text direkt in der Karte bearbeitbar machen. So lassen sich kleine Änderungen ohne Prompt an das Modell vornehmen.
  • Dynamisches Layout: Die Höhe der Karte kann mit ihrem Inhalt wachsen, bis die Höhe des Anzeigebereichs auf einem Mobilgerät erreicht ist.

Faustregeln

  • Begrenze die Zahl der Hauptaktionen pro Karte: Biete höchstens zwei Aktionen an, eine primäre Handlungsaufforderung (CTA) und optional eine sekundäre.
  • Vermeide mehrere Navigationsebenen oder Ansichten innerhalb einer Karte. Eine Karte sollte keine verschachtelten Detailansichten, Tabs oder weiterführenden Navigationsebenen enthalten. Prüfe, ob du die Inhalte auf separate Karten oder Tool-Aktionen verteilen kannst.
  • Vermeide verschachtelte Scrollbereiche. Karten sollten sich automatisch an ihren Inhalt anpassen, sodass innerhalb der Karte kein Scrollen nötig ist.
  • Vermeide doppelte Eingabemöglichkeiten. Bilde ChatGPT-Funktionen nicht in einer Karte nach.

Beispiele für Gestaltungsmuster, die du bei Inline-Karten vermeiden solltest

Inline-Karussell

Ein Karussell zeigt mehrere Karten nebeneinander. So lassen sich die Optionen schnell überblicken und auswählen.

Wann eignet sich ein Inline-Karussell?

  • Wenn du eine kurze Liste ähnlicher Einträge präsentierst, etwa Restaurants, Playlists oder Veranstaltungen.
  • Wenn die Bilder und Metadaten der einzelnen Einträge mehr Platz benötigen, als eine einfache Listenzeile bietet.

Aufbau

Schematischer Aufbau eines Inline-Karussells

  • Bild: Jeder Eintrag sollte ein Bild oder eine andere visuelle Darstellung enthalten.
  • Titel: Gib jedem Eintrag im Karussell in der Regel einen Titel, der den Inhalt beschreibt.
  • Metadaten: Zeige die Informationen zum Eintrag, die für die jeweilige Antwort am wichtigsten sind. Vermeide mehr als zwei Zeilen Text.
  • Badge: Mit einem Badge kannst du bei Bedarf ergänzende Informationen hervorheben.
  • Aktionen: Biete nach Möglichkeit pro Eintrag einen einzigen, klaren CTA an.

Faustregeln

  • Beschränke dich auf 3–8 Einträge pro Karussell, damit es übersichtlich bleibt.
  • Beschränke die Metadaten auf die wichtigsten Details und höchstens drei Zeilen.
  • Jede Karte kann einen einzelnen optionalen CTA enthalten, etwa „Buchen“ oder „Abspielen“.
  • Ordne die Inhalte auf allen Karten nach derselben visuellen Hierarchie an.

Vollbild

Die Vollbildansicht erweitert die Inline-Karte und bietet Platz für mehrstufige Arbeitsabläufe oder die genauere Erkundung von Inhalten. Das Texteingabefeld von ChatGPT bleibt über der Ansicht eingeblendet. So lässt sich das Gespräch „mit der App“ direkt in der Vollbildansicht fortsetzen.

Wann eignet sich die Vollbildansicht?

  • Für komplexe Aufgaben, die sich nicht auf eine einzelne Karte beschränken lassen, etwa die Arbeit mit einer interaktiven Landkarte mit Markierungen, einer umfangreichen Bearbeitungsfläche oder einem interaktiven Diagramm.
  • Zum Durchsehen detaillierter Inhalte wie Immobilienangebote oder Speisekarten.

Aufbau

Schematischer Aufbau der Vollbildansicht

  • Schließen-Schaltfläche des Systems: Schließt das eingeblendete Fenster oder die Ansicht.
  • Vollbildansicht: Hier erscheinen die Inhalte.
  • Texteingabefeld: Im integrierten Texteingabefeld von ChatGPT lässt sich das Gespräch mit Bezug auf die Vollbildansicht fortsetzen.

Interaktion

Interaktionsmöglichkeiten in der Vollbildansicht

  • Chatfenster: Halte den bisherigen Gesprächsverlauf auch in der Vollbildansicht zugänglich.
  • Nachdenken: Das Texteingabefeld „schimmert“, während die Antwort nach und nach übertragen wird.
  • Antwort: Sobald das Modell seine Antwort abgeschlossen hat, erscheint kurz ein Auszug über dem Texteingabefeld. Durch Antippen öffnet sich das Chatfenster.

Faustregeln

  • Stimme die Bedienung deiner App auf das Texteingabefeld des Systems ab. Das Texteingabefeld ist in der Vollbildansicht immer sichtbar. Unterstütze deshalb natürlich formulierte Prompts, die Tool-Aufrufe auslösen können.
  • Verwende die Vollbildansicht für Aufgaben, die mehr Platz brauchen. Du kannst vorhandene Editoren und Verwaltungsoberflächen einbetten, wenn sie die Richtlinie für iframes erfüllen.

Bild-in-Bild (PiP)

Für laufende Aktivitäten oder Live-Sitzungen wie Spiele oder Videos bietet ChatGPT ein schwebendes Fenster. Während das Gespräch weitergeht, bleibt das PiP-Fenster im Blick und kann seinen Inhalt als Reaktion auf Prompts dynamisch aktualisieren.

Wann eignet sich Bild-in-Bild?

  • Für Aktivitäten, die parallel zum Gespräch laufen, etwa ein Spiel, die Zusammenarbeit in Echtzeit, ein Quiz oder eine Lerneinheit.
  • Wenn das PiP-Widget auf Eingaben im Chat reagieren kann, etwa indem es auf Wunsch eine Spielrunde fortsetzt oder Live-Daten aktualisiert.

Interaktion

Interaktionsmöglichkeiten im Bild-in-Bild-Modus

  • Aktiviert: Beim Scrollen bleibt das PiP-Fenster am oberen Rand des Anzeigebereichs fixiert.
  • Angeheftet: Das PiP-Fenster bleibt an seiner Position, bis die Person im Chat es schließt oder die Sitzung endet.
  • Sitzungsende: Das PiP-Fenster erscheint wieder direkt im Gesprächsverlauf und scrollt mit diesem aus dem sichtbaren Bereich.

Faustregeln

  • Sorge dafür, dass das PiP-Fenster seinen Zustand aktualisieren oder auf Eingaben reagieren kann, wenn jemand das Texteingabefeld des Systems verwendet.
  • Schließe das PiP-Fenster automatisch, wenn die Sitzung endet.
  • Überlade das PiP-Fenster nicht mit Bedienelementen oder statischen Inhalten, die sich besser für die Inline- oder Vollbildansicht eignen.

Richtlinien für die visuelle Gestaltung

Ein einheitliches Erscheinungsbild trägt dazu bei, dass sich Tools von Partnerunternehmen nahtlos in ChatGPT einfügen. Die Gestaltungsrichtlinien fördern Übersichtlichkeit, Benutzerfreundlichkeit und Barrierefreiheit. Zugleich lassen sie Raum für gezielte Markenakzente.

Die folgenden Grundsätze zeigen, wie du Farben, Schrift, Abstände und Bilder so einsetzt, dass die Oberfläche übersichtlich bleibt und dein Angebot erkennbar ist.

Warum das wichtig ist

Wenn Apps in ChatGPT einheitlich aussehen und sich ähnlich bedienen lassen, fällt die Nutzung insgesamt leichter. Mit diesen Richtlinien können Partnerunternehmen ihre Tools so gestalten, dass die Bedienung vertraut ist und nichts von der eigentlichen Aufgabe ablenkt.

Farbe

Die Farbpaletten des Systems sorgen dafür, dass Aktionen und Antworten in ChatGPT einheitlich aussehen. Partnerunternehmen können mit Akzenten, Symbolen oder eingebetteten Bildern ihre Marke sichtbar machen. Die Systemfarben sollten sie beibehalten.

Farbpalette

Faustregeln

  • Verwende Systemfarben für Text, Symbole und gliedernde Elemente wie Trennlinien.
  • Markenakzente wie Logos oder Symbole sollten die Hintergrund- und Textfarben nicht überschreiben.
  • Vermeide eigene Farbverläufe oder Muster, die vom minimalistischen Erscheinungsbild von ChatGPT abweichen.
  • Verwende die Akzentfarben deiner Marke für primäre Schaltflächen in den Anzeigemodi deiner App.

Beispiel für den Einsatz von Farben

Verwende Markenfarben für Akzente und Badges. Behalte die Textfarben und die übrigen grundlegenden Stile der Komponenten bei.

Beispiel für den Einsatz von Farben

Verzichte in Textbereichen auf farbige Hintergründe.

Typografie

ChatGPT verwendet die Systemschriften der jeweiligen Plattform (SF Pro unter iOS, eine serifenlose Schrift unter Android). So bleiben Texte auf unterschiedlichen Geräten gut lesbar und zugänglich.

Typografie

Faustregeln

  • Übernimm per Vererbung immer die Schriftfamilien des Systems in der vorgegebenen Reihenfolge. Halte dich bei Überschriften, Fließtext und Bildunterschriften an die vorgegebenen Schriftgrößen.
  • Beschränke markenspezifische Gestaltung wie Fettdruck, Kursivschrift oder Hervorhebungen auf Inhaltsbereiche. Strukturelle Elemente der Benutzeroberfläche sollten die Systemstile verwenden.
  • Verwende möglichst wenige Schriftgrößen. Bevorzuge die normale und die kleine Schriftgröße für Fließtext.

Beispiel für den Einsatz von Typografie

Verzichte auch in Vollbildansichten auf eigene Schriftarten. Verwende nach Möglichkeit die Schriftvariablen des Systems.

Abstände und Layout

Einheitliche Außen- und Innenabstände sowie eine konsistente Ausrichtung machen Inhalte von Partnerunternehmen im Gespräch leicht erfassbar und sorgen für einen vertrauten Aufbau.

Abstände und Layout

Faustregeln

  • Nutze für Karten, Sammlungen und Inspektorfenster die Rasterabstände des Systems.
  • Halte die Innenabstände einheitlich. Gib Inhalten genug Platz und lass Text nicht bis an den Rand reichen.
  • Übernimm nach Möglichkeit die vom System vorgegebenen Eckenradien, damit die Formen einheitlich bleiben.
  • Schaffe eine klare visuelle Hierarchie: zuerst die Überschrift, dann der erläuternde Text und schließlich der CTA.

Symbole und Bilder

Systemsymbole erleichtern die Orientierung. An Logos und Bildern erkennen Nutzende, zu welcher Marke ein Inhalt gehört.

Symbole

Faustregeln

  • Verwende Systemsymbole oder eigene Symbole, die zum Erscheinungsbild von ChatGPT passen: einfarbig und als Kontur gezeichnet.
  • Füge dein Logo nicht in die Antwort ein. ChatGPT zeigt dein Logo und den Namen deiner App immer an, bevor das Widget erscheint.
  • Halte bei allen Bildern die vorgegebenen Seitenverhältnisse ein, damit sie unverzerrt erscheinen.

Symbole und Bilder

Barrierefreiheit

Möglichst viele Menschen sollten die Apps von Partnerunternehmen nutzen können. Berücksichtige Barrierefreiheit von Anfang an, wenn du Apps für ChatGPT entwickelst.

Faustregeln

  • Text und Hintergrund müssen das Mindestkontrastverhältnis nach WCAG AA einhalten.
  • Gib für jedes Bild einen Alternativtext an.
  • Stelle sicher, dass das Layout auch bei geänderter Textgröße funktioniert.