Summarizer: measureInputUsage() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die measureInputUsage() Methode der Summarizer Schnittstelle gibt an, wie viel inputQuota durch eine Zusammenfassung für einen gegebenen Texteingang verbraucht würde.

Syntax

js
measureInputUsage(input)
measureInputUsage(input, options)

Parameter

input

Ein String, der den Eingabetext darstellt, für den Sie einen Eingabenutzungswert erhalten möchten.

options Optional

Ein Objekt, das Konfigurationsoptionen für den measureInputUsage()-Vorgang angibt. Mögliche Werte sind:

context

Ein String, der den Kontext beschreibt, in dem der Eingabetext verwendet würde, um eine geeignetere Zusammenfassung zu erzeugen.

signal

Eine Instanz des AbortSignal Objekts, die es ermöglicht, den measureInputUsage()-Vorgang über den zugehörigen AbortController abzubrechen.

Rückgabewert

Ein Promise, das mit einer Zahl erfüllt wird, die die Nutzung der inputQuota des gegebenen Eingabetextes angibt.

Ausnahmen

NotAllowedError DOMException

Wird ausgelöst, wenn die Nutzung der Summarizer API durch eine summarizer Permissions-Policy gesperrt wird.

NotReadableError DOMException

Wird ausgelöst, wenn die Ausgabezusammenfassung durch den Benutzer-Agent gefiltert wurde, zum Beispiel, weil sie als schädlich, ungenau oder unsinnig erkannt wurde.

NotSupportedError DOMException

Wird ausgelöst, wenn der bereitgestellte context nicht in einer vom Summarizer unterstützten Sprache ist.

UnknownError DOMException

Wird ausgelöst, wenn der measureInputUsage()-Aufruf aus einem anderen Grund fehlgeschlagen ist, oder aus einem Grund, den der Benutzer-Agent nicht offenlegen wollte.

Beispiele

Überprüfen, ob Sie über ausreichend Quota verfügen

Im folgenden Beispiel erstellen wir eine neue Summarizer-Instanz mit create(), dann geben wir die gesamte Eingabequote über inputQuota und die Eingabenutzungsquote für die Zusammenfassung eines bestimmten Textstrings über measureInputUsage() zurück.

Wir überprüfen dann, ob die individuelle Eingabenutzung für diesen String größer ist als die insgesamt verfügbare Quote. Ist dies der Fall, werfen wir einen entsprechenden Fehler; ist dies nicht der Fall, beginnen wir mit der Zusammenfassung des Strings mithilfe von summarize().

js
const summarizer = await Summarizer.create({
  sharedContext:
    "A general summary to help a user decide if the text is worth reading",
  type: "tldr",
  length: "short",
});

const totalInputQuota = summarizer.inputQuota;
const inputUsage = await summarizer.measureInputUsage(myTextString);

if (inputUsage > totalInputQuota) {
  throw new Error("Boo, insufficient quota to generate a summary.");
} else {
  console.log("Yay, quota available to generate a summary.");
  const summary = await summarizer.summarize(myTextString);
  // ...
}

Spezifikationen

Specification
Writing Assistance APIs
# dom-summarizer-measureinputusage

Browser-Kompatibilität

Siehe auch