LanguageModel: Methode prompt()

Syntax

prompt(input)
prompt(input, options)

Parameter

input

Der Inhalt, mit dem das Modell aufgefordert wird. Dieser ist entweder:

• Ein String — Abkürzung für eine einzelne Textnachricht.
• Ein Array von Objekten, von denen jedes eine einzelne Nachricht in einem Gespräch mit einem Sprachmodell darstellt. Objekte können die folgenden Eigenschaften haben:

  role

  Ein String, der die Perspektive angibt, aus der die Nachricht formuliert ist. Muss eine der folgenden sein:

  system

  Eine Systemanweisung, die das gesamte Verhalten des Modells leitet. Dies muss die erste Anweisung sein, die an das Modell übergeben wird.

  user

  Eine Nachricht vom Benutzer, auf die die API reagieren soll.

  assistant

  Eine Eingabe, die Kontext für den KI-Assistenten bereitstellt, wie z.B. seine Persönlichkeit oder das Format seiner Antworten. Solche Nachrichten dienen hauptsächlich dazu, Kontext/Geschichte bereitzustellen und die Art der Modellantworten zu prägen.

  content

  Ein String, der einen Text-Trigger darstellt, oder ein Array von Objekten. Jedes Objekt enthält die folgenden Eigenschaften:

  type

  Ein enumerierter Wert, der den Inhaltstyp darstellt. Dies kann einer der folgenden sein:

  audio

  Audio-Inhalt.

  image

  Bildinhalt.

  text

  Textinhalt.

  tool-call

  Ein vom Modell ausgeführter Aufruf eines Werkzeugs.

  tool-response

  Das Ergebnis eines Werkzeugaufrufs.

  value

  Der Inhalt der Nachricht. Wenn der type text ist, ist dies immer ein String. Wenn der type audio oder image ist, kann der value einer von mehreren verschiedenen Objekttypen sein; siehe Welche Datentypen werden akzeptiert?.

  prefix Optional

  Ein Boolean, der standardmäßig auf false steht. Wenn true, wird die Nachricht als Präfix für die nächste generierte Antwort des Modells behandelt, anstatt als vollständiger Zug.

options Optional

Optionen zum Erstellen eines Prompts. Eigenschaften umfassen:

responseConstraint

Ein Objekt, das der Struktur von JSON Schema folgt und das genaue Format definiert, in dem die Ausgabe des Modells geliefert werden soll. Wenn bereitgestellt und omitResponseConstraintInput false ist, wird jede implementierungsdefinierte Beschreibungsnachricht in die Messung eingeschlossen.

omitResponseConstraintInput

Ein Boolean; wenn true, wird die automatische Beschreibungsnachricht von der Messung ausgeschlossen.

signal

Ein AbortSignal, um den Vorgang abzubrechen.

Rückgabewert

Ein Promise, das mit einem String aufgelöst wird, der die vollständige Antwort des Modells enthält.

Ausnahmen

AbortError DOMException

Wird ausgelöst, wenn der Vorgang über die signal-Option abgebrochen wurde.

NotAllowedError DOMException

Wird ausgelöst, wenn die Nutzung der Methode durch eine language-model Permissions-Policy blockiert wird.

NotSupportedError DOMException

Wird ausgelöst, wenn:

• Die role einer Nachricht assistant ist und ihr type etwas anderes als text ist.
• Der type einer Nachricht text ist und ihr value kein String ist.
• Der Eingabe- oder Ausgabetext in einer Sprache ist, die vom Benutzeragenten nicht für Prompts unterstützt wird.
• Der type einer Nachricht image oder audio ist, der Typ jedoch nicht in expectedInputs aufgelistet war, oder der value kein akzeptierter Datentyp ist.

OperationError DOMException

Wird ausgelöst, wenn der Prompt aus einem anderen Grund fehlschlägt, der nicht in den anderen Ausnahmetypen aufgeführt ist.

QuotaExceededError DOMException

Wird ausgelöst, wenn der Prompt dazu führen würde, dass der Nutzungskontext der Sitzung das Modell LanguageModel.contextWindow überschreitet.

SyntaxError DOMException

Wird ausgelöst, wenn:

• Keine Nachrichten im Nachrichtenarray enthalten sind.
• Die prefix-Eigenschaft einer Nachricht auf true gesetzt ist und:
  • Die role der Nachricht nicht assistant ist.
  • Die Nachricht nicht das letzte Element im Nachrichtenarray ist.

TypeError

Wird ausgelöst, wenn:

• omitResponseConstraintInput true ist, aber responseConstraint nicht angegeben wurde.
• Die role einer Nachricht system ist, diese aber nicht die erste übergebene Nachricht an den Kontext war.

Beschreibung

Die Methode prompt() ist der primäre Mechanismus zur Interaktion mit einer Sprachmodell-Sitzung. Sie fügt die bereitgestellten Eingaben in das Kontextfenster ein und generiert eine Antwort. Die gesamte Antwort wird gepuffert und als ein einziger String zurückgegeben, wenn die Generierung abgeschlossen ist.

Für lange Antworten oder Streaming-Anwendungsfälle verwenden Sie stattdessen LanguageModel.promptStreaming(), um die Antwort schrittweise zu erhalten. Um Inhalte dem Kontextfenster hinzuzufügen, ohne eine Antwort zu generieren, verwenden Sie LanguageModel.append().

Jeder Aufruf von prompt() fügt dem Kontext der Sitzung etwas hinzu. Um von einem gegebenen Zustand aus einen Zweig zu eröffnen, ohne die ursprüngliche Sitzung zu beeinträchtigen, rufen Sie LanguageModel.clone() auf.

Beispiele

Einfacher Text-Prompt

Dieses Beispiel zeigt die grundlegende Verwendung von prompt() mit einer einzelnen Benutzertext-Eingabe.

const session = await LanguageModel.create();
const response = await session.prompt(
  "Summarize the water cycle in one paragraph.",
);
console.log(response);

Siehe auch Die Prompt-API verwenden > Das Modell auffordern.

Mehrstufiges Gespräch

const session = await LanguageModel.create();

const reply1 = await session.prompt("My name is Alex.");
console.log(reply1); // "Nice to meet you, Alex!"

const reply2 = await session.prompt("What's my name?");
console.log(reply2); // "Your name is Alex."

Eingeschränkte JSON-Ausgabe

Das folgende Beispiel zeigt, wie JSON an die responseConstraint-Option übergeben wird, um festzulegen, dass Sie ein Array von dem Aufruf an prompt() zurückgeben möchten.

const session = await LanguageModel.create();
const raw = await session.prompt("Name three planets in our solar system.", {
  responseConstraint: {
    type: "object",
    properties: {
      planets: {
        type: "array",
        items: { type: "string" },
      },
    },
    required: ["planets"],
  },
});

const { planets } = JSON.parse(raw);
console.log(planets); // ["Mercury", "Venus", "Earth"]

Siehe auch Hinzufügen von Kontext mit anfänglichen und fortlaufenden Prompt-Eingaben > Hinzufügen von Antwortbeschränkungen.

Abbrechen eines Prompts

Das folgende Beispiel zeigt, wie ein Benutzer einen Prompt mit einem Button abbrechen kann. Dies erfolgt durch die Erstellung eines AbortController. Sein abort() kann von einem Button-click-Handler aufgerufen werden. Damit dies funktioniert, muss ein Verweis auf die signal-Eigenschaft des Controllers an prompt() übergeben werden.

const controller = new AbortController();

// Select your cancel button from the DOM
const cancelButton = document.querySelector("#btn-cancel");

// Trigger the abort when the user clicks the button
cancelButton.addEventListener("click", () => {
  controller.abort();
});

try {
  const response = await session.prompt("write a very long story.", {
    signal: controller.signal,
  });
  console.log(response);
} catch (err) {
  if (err.name === "AbortError") {
    console.log("prompt was cancelled.");
  } else {
    console.error("An unexpected error occurred:", err);
  }
}

Siehe auch Die Prompt-API verwenden > Vorgänge abbrechen und Instanzen zerstören.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• LanguageModel.promptStreaming()
• LanguageModel.append()
• Prompt API
• Die Prompt-API verwenden
• Hinzufügen von Kontext mit anfänglichen und fortlaufenden Prompt-Eingaben