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.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die measureInputUsage() Methode der Summarizer-Schnittstelle gibt an, wie viel inputQuota durch eine Zusammenfassungsoperation 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 eine Messung der Eingabenutzung wünschen.

options Optional

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

context

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

signal

Eine AbortSignal-Objektinstanz, die es ermöglicht, die measureInputUsage()-Operation ü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 blockiert ist.

NotReadableError DOMException

Wird ausgelöst, wenn die Ausgabenzusammenfassung durch den Benutzeragenten gefiltert wurde, beispielsweise weil sie als schädlich, ungenau oder unsinnig erkannt wurde.

NotSupportedError DOMException

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

UnknownError DOMException

Wird ausgelöst, wenn der measureInputUsage()-Aufruf aus irgendeinem anderen Grund fehlschlug oder aus einem Grund, den der Benutzeragent nicht offenlegen wollte.

Beispiele

Überprüfen, ob Sie genügend Quota haben

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

Wir prüfen dann, ob die individuelle Eingabenutzung für diesen String größer ist als die insgesamt verfügbare Quote. Falls ja, werfen wir einen entsprechenden Fehler; falls nicht, beginnen wir mit der Zusammenfassung des Strings mittels 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