Summarizer: phương thức measureInputUsage()

Limited availability

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

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.

Phương thức measureInputUsage() của giao diện Summarizer báo cáo lượng inputQuota sẽ được sử dụng bởi thao tác tóm tắt cho một đầu vào văn bản nhất định.

Cú pháp

js
measureInputUsage(input)
measureInputUsage(input, options)

Tham số

input

Một chuỗi đại diện cho văn bản đầu vào bạn muốn đo lượng sử dụng đầu vào.

options Optional

Một đối tượng xác định các tùy chọn cấu hình cho thao tác measureInputUsage(). Các giá trị có thể bao gồm:

context

Một chuỗi mô tả ngữ cảnh mà văn bản đầu vào sẽ được sử dụng trong đó, để giúp tạo ra bản tóm tắt phù hợp hơn.

signal

Một thực thể đối tượng AbortSignal, cho phép hủy bỏ thao tác measureInputUsage() thông qua AbortController được liên kết.

Giá trị trả về

Một Promise được giải quyết với một số chỉ định mức sử dụng inputQuota của văn bản đầu vào đã cho.

Ngoại lệ

NotAllowedError DOMException

Được ném ra nếu việc sử dụng Summarizer API bị chặn bởi summarizer Permissions-Policy.

NotReadableError DOMException

Được ném ra nếu bản tóm tắt đầu ra bị lọc bởi tác nhân người dùng, ví dụ vì nó bị phát hiện là có hại, không chính xác hoặc vô nghĩa.

NotSupportedError DOMException

Được ném ra nếu context được cung cấp không ở ngôn ngữ mà Summarizer hỗ trợ.

UnknownError DOMException

Được ném ra nếu lần gọi measureInputUsage() thất bại vì bất kỳ lý do nào khác, hoặc lý do mà tác nhân người dùng không muốn tiết lộ.

Ví dụ

Kiểm tra xem bạn có đủ hạn mức không

Trong đoạn mã dưới đây, chúng tôi tạo một thực thể Summarizer mới bằng cách sử dụng create(), sau đó trả về tổng hạn mức đầu vào thông qua inputQuota và mức sử dụng hạn mức đầu vào cho việc tóm tắt một chuỗi văn bản cụ thể thông qua measureInputUsage().

Sau đó chúng tôi kiểm tra xem mức sử dụng đầu vào riêng lẻ cho chuỗi đó có lớn hơn tổng hạn mức có sẵn không. Nếu có, chúng tôi ném một lỗi thích hợp; nếu không, chúng tôi bắt đầu tóm tắt chuỗi bằng cách sử dụng 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);
  // ...
}

Thông số kỹ thuật

Specification
Writing Assistance APIs
# dom-summarizer-measureinputusage

Tương thích trình duyệt

Xem thêm