LanguageModel: prompt() Methode

Syntax

prompt(input)
prompt(input, options)

Parameter

input

Der Inhalt, mit dem das Modell aufgefordert wird. Dies kann sein:

• Ein String — Eine Kurzform für eine einzige textuelle Nachricht.
• Ein Array von Objekten, die jeweils eine einzelne Nachricht in einem Gespräch mit einem Sprachmodell darstellen. Objekte können die folgenden Eigenschaften haben:

  role

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

  system

  Eine systemweite Anweisung, die das allgemeine 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 antworten soll.

  assistant

  Eine Eingabe, die Kontext für den KI-Assistenten bietet, wie seine Persona oder das Format seiner Antworten. Solche Nachrichten dienen hauptsächlich dazu, Kontext/Geschichte bereitzustellen und die Reaktion des Modells weiter zu gestalten.

  content

  Eine Zeichenkette, die eine textuelle Aufforderung 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

  Audioinhalt.

  image

  Bildinhalt.

  text

  Textinhalt.

  tool-call

  Ein vom Modell ausgeführter Werkzeugaufruf.

  tool-response

  Das Ergebnis eines Werkzeugaufrufs.

  value

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

  prefix Optional

  Ein boolescher Wert, der standardmäßig auf false gesetzt ist. Wenn true, wird die Nachricht als Präfix für die nächste generierte Antwort des Modells behandelt, anstatt als vollständige Runde.

options Optional

Optionen zur Erstellung einer Aufforderung. Zu den Eigenschaften gehören:

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 es bereitgestellt wird und omitResponseConstraintInput false ist, wird eine implementierungsdefinierte Beschreibungsnachricht in die Messung einbezogen.

omitResponseConstraintInput

Ein boolescher Wert; wenn true, wird die automatische Beschreibungsnachricht aus der Messung ausgeschlossen.

signal

Ein AbortSignal, um die Operation abzubrechen.

Rückgabewert

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

Ausnahmen

AbortError DOMException

Ausgelöst, wenn die Operation über die signal Option abgebrochen wurde.

NotAllowedError DOMException

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

NotSupportedError DOMException

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 keine Zeichenkette ist.
• Der Eingabe- oder Ausgabetext in einer Sprache ist, die vom Benutzer-Agenten für Aufforderungen nicht unterstützt wird.
• Der type einer Nachricht image oder audio ist, aber der Typ nicht in expectedInputs aufgeführt war oder der value kein akzeptierter Datentyp ist.

OperationError DOMException

Ausgelöst, wenn die Aufforderung aus einem anderen als den in den anderen Ausnahmetypen aufgeführten Gründen fehlschlägt.

QuotaExceededError DOMException

Ausgelöst, wenn die Aufforderung Nutzung des Kontexts der Sitzung über das Modell hinaus erhöhen würde LanguageModel.contextWindow.

SyntaxError DOMException

Ausgelöst, wenn:

• Keine Nachrichten in dem 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

Ausgelöst, wenn:

• omitResponseConstraintInput true ist, aber responseConstraint nicht bereitgestellt wurde.
• Die role einer Nachricht system ist, aber es nicht die erste Nachricht ist, die dem Kontext übergeben wurde.

Beschreibung

Die prompt() Methode ist der primäre Mechanismus zur Interaktion mit einer Sprachmodellsitzung. Sie fügt die bereitgestellte Eingabe zum Kontextfenster hinzu und generiert eine Antwort. Die gesamte Antwort wird gepuffert und als einzelne Zeichenkette 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 Inhalt zum Kontextfenster hinzuzufügen, ohne eine Antwort zu generieren, verwenden Sie LanguageModel.append().

Jeder Aufruf von prompt() fügt dem Kontext der Sitzung hinzu. Um von einem gegebenen Zustand abzweigen zu können, ohne die ursprüngliche Sitzung zu beeinflussen, rufen Sie LanguageModel.clone() auf.

Beispiele

Basic Text Prompt

Dieses Beispiel zeigt die grundlegende prompt() Verwendung mit einer einzelnen Benutzereingabe als Text.

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

Siehe auch Using the Prompt API > Prompting the model.

Multi-Turn-Konversation

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

Einschränkungen beim JSON-Ausgang

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

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 initialen und fortlaufenden Eingaben > Hinzufügen von Antwortbeschränkungen.

Abbrechen einer Aufforderung

Das folgende Beispiel zeigt, wie ein Benutzer eine Aufforderung mit einem Knopf abbrechen kann. Dies geschieht durch Erstellen eines AbortController. Sein abort() kann von einem click Handler eines Knopfes aufgerufen werden. Damit dies funktioniert, muss eine Referenz zur 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 canceled.");
  } else {
    console.error("An unexpected error occurred:", err);
  }
}

Siehe auch Using the Prompt API > Canceling operations and destroying instances.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• LanguageModel.promptStreaming()
• LanguageModel.append()
• Prompt API
• Using the Prompt API
• Hinzufügen von Kontext mit initialen und fortlaufenden Eingaben