Limited availability
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The summarize()
method of the Summarizer
interface generates a new summary string.
summarize(input)
summarize(input, options)
Parameters
input
A string representing the text to be summarized.
options
Optional
An object specifying configuration options for the summarize()
operation. Possible values include:
context
A string describing the context the input text is being used in, which helps the Summarizer
generate a more suitable summary.
signal
An AbortSignal
object instance, which allows the summarize()
operation to be aborted via the associated AbortController
.
A Promise
that fulfills with a string containing the generated summary.
InvalidStateError
DOMException
Thrown if the current Document
is not active.
NotAllowedError
DOMException
Thrown if usage of the Summarizer API is blocked by a summarizer
Permissions-Policy
.
NotReadableError
DOMException
Thrown if the output summary was filtered by the user agent, for example because it was detected to be harmful, inaccurate, or nonsensical.
NotSupportedError
DOMException
Thrown if the provided context
is not in language the Summarizer
supports.
QuotaExceededError
DOMException
Thrown if the summarize operation exceeds the available inputQuota
.
UnknownError
DOMException
Thrown if the summarize()
call failed for any other reason, or a reason the user agent did not wish to disclose.
summarize()
usage
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 summary = await summarizer.summarize(myTextString);
console.log(summary);
Specifications Browser compatibility See also
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4