Summarizer: create() 静态方法

可用性有限

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

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

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

Summarizer 接口的 create() 静态方法用于创建一个新的 Summarizer 实例,用于生成摘要。

注意: create() 方法需要 瞬时激活,也就是说,它必须在响应用户操作(如鼠标点击或按钮按下)时调用。

语法

js
Summarizer.create()
Summarizer.create(options)

参数

options 可选

一个对象,用于指定 Summarizer 的配置选项。可能的值包括

expectedInputLanguages

一个字符串数组,用于指定输入文本的预期语言,这些语言应为有效的 BCP 47 语言标签。默认为 ["en"]

expectedContextLanguages

一个字符串数组,用于指定提供的任何上下文字符串(无论是传递给 SummarizersharedContext,还是在 summarize()summarizeStreaming() 调用期间指定的 context)的预期语言,这些语言应为有效的 BCP 47 语言标签。默认为 ["en"]

格式(format)

一个枚举值,用于指定您希望摘要以哪种文本 format 返回。默认为 markdown

length

一个枚举值,用于指定生成的摘要的相对 length。默认为 short

monitor

一个带有 CreateMonitor 参数的回调函数,该函数允许监控 AI 模型的下载进度。

outputLanguage

一个字符串,用于指定 Summarizer 生成的摘要的预期语言,它应为有效的 BCP 47 语言标签。默认为 en

sharedContext

一个 sharedContext 字符串,用于描述要进行摘要的文本片段所处的上下文,这有助于 Summarizer 生成更合适的摘要。

signal

一个 AbortSignal 对象实例,允许通过关联的 AbortController 中止 create() 操作。

type

一个枚举值,用于指定您希望此 Summarizer 生成的摘要的 type。默认为 key-points

返回值

一个 Promise,它会在解析时提供一个 Summarizer 对象实例。

异常

NotAllowedError DOMException

如果 Summarizer API 的使用被 summarizer Permissions-Policy 阻止,则会抛出此错误。

NotSupportedError DOMException

如果 expectedContextLanguagesexpectedInputLanguagesoutputLanguage 中指定的任何语言标签无效或不受支持,则会抛出此错误。

OperationError DOMException

Summarizer 创建因任何其他原因失败时,会抛出此通用异常。

示例

基本的 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",
});

规范

规范
写作辅助 API
# dom-summarizer-create

浏览器兼容性

另见