Summarizer

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

实验性: 这是一项实验性技术
在生产中使用此技术之前,请仔细检查浏览器兼容性表格

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

Summarizer 接口是 Summarizer API 的一部分,包含了该 API 的所有功能,包括检查 AI 模型可用性、创建新的 Summarizer 实例、使用它生成新的摘要等。

实例属性

expectedContextLanguages 只读 实验性

上下文字符串应使用的语言。

expectedInputLanguages 只读 实验性

Summarizer 应支持的语言。

format 只读 实验性

摘要将返回的文本格式。

inputQuota 只读 实验性

浏览器用于生成摘要的可用输入配额。

length 只读 实验性

生成的摘要的相对长度。

outputLanguage 只读 实验性

应生成摘要的语言。

sharedContext 只读 实验性

描述待摘要文本所处上下文的文本字符串,这有助于 Summarizer 生成更合适的摘要。

type 只读 实验性

Summarizer 将生成的摘要类型。

静态方法

availability() 实验性

返回一个枚举值,指示浏览器 AI 模型是否支持给定的 Summarizer 配置。

create() 实验性

创建新的 Summarizer 实例以用于生成摘要。

实例方法

destroy() 实验性

销毁被调用的 Summarizer 实例。

measureInputUsage() 实验性

报告给定文本输入进行摘要操作将使用多少输入配额。

summarize() 实验性

生成新的摘要字符串。

summarizeStreaming() 实验性

将新摘要生成为 ReadableStream

示例

有关完整示例,请参阅 使用 Summarizer API

创建 Summarizer 实例

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",
  format: "markdown",
  expectedInputLanguages: ["en-US"],
  outputLanguage: "en-US",
});

生成摘要

js
const summary = await summarizer.summarize(myTextString);
console.log(summary);

生成摘要流

js
const stream = summarizer.summarizeStreaming(myTextString);
let summary = "";

for await (const chunk of stream) {
  summary += chunk;
}

console.log("Stream complete");
summaryOutput.textContent = summary;

规范

规范
写作辅助 API
# summarizer

浏览器兼容性

另见