Editorial review: Document the Summarizer API #39263

chrisdavidmills · 2025-04-24T14:13:11Z

Description

Chrome 138 onwards supports the Summarizer API; the relevant ChromeStatus entry says 139, but I've been told this is incorrect.

Note

During review, you may need to enable the chrome://flags/#summarization-api-for-gemini-nano flag to get the demos running in Chrome.

Specifically, this PR adds:

A Summarizer API landing page
A usage guide
A reference for the Summarizer interface.
A reference for the CreateMonitor interface.

Motivation

Additional details

Related issues and pull requests

files/en-us/web/api/summarizer_api/using/index.md

github-actions · 2025-04-24T14:15:13Z

Preview URLs (21 pages)

Flaws (7)

Note! 17 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/CreateMonitor
Title: CreateMonitor
Flaw count: 2

macros:
- Can't resolve /en-US/docs/Web/API/LanguageDetector/create_static
- Can't resolve /en-US/docs/Web/API/Translator/create_static

URL: /en-US/docs/Web/API/Summarizer/summarize
Title: Summarizer: summarize() method
Flaw count: 1

macros:
- Can't resolve /en-US/docs/Web/API/Summarize/inputQuota

URL: /en-US/docs/Web/API/Summarizer/summarizeStreaming
Title: Summarizer: summarizeStreaming() method
Flaw count: 1

macros:
- Can't resolve /en-US/docs/Web/API/Summarize/inputQuota

URL: /en-US/docs/Web/HTTP/Reference/Headers/Permissions-Policy/summarizer
Title: Permissions-Policy: summarizer
Flaw count: 3

unknown:
- No generic content config found
- no blog root
- no blog root

External URLs (31)

URL: /en-US/docs/Web/API/CreateMonitor
Title: CreateMonitor

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/CreateMonitor/downloadprogress_event
Title: CreateMonitor: downloadprogress event

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer
Title: Summarizer

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer_API
Title: Summarizer API

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://developer.chrome.com/docs/ai/summarizer-api (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer_API/Using
Title: Using the Summarizer API

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/availability_static
Title: Summarizer: availability() static method

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://datatracker.ietf.org/doc/html/rfc5646 (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/IETF_language_tag (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/create_static
Title: Summarizer: create() static method

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://datatracker.ietf.org/doc/html/rfc5646 (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/IETF_language_tag (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/destroy
Title: Summarizer: destroy() method

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/expectedContextLanguages
Title: Summarizer: expectedContextLanguages property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://datatracker.ietf.org/doc/html/rfc5646 (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/IETF_language_tag (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/expectedInputLanguages
Title: Summarizer: expectedInputLanguages property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://datatracker.ietf.org/doc/html/rfc5646 (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/IETF_language_tag (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/format
Title: Summarizer: format property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://spec.commonmark.org/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/inputQuota
Title: Summarizer: inputQuota property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/length
Title: Summarizer: length property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/measureInputUsage
Title: Summarizer: measureInputUsage() method

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/outputLanguage
Title: Summarizer: outputLanguage property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)
https://datatracker.ietf.org/doc/html/rfc5646 (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/IETF_language_tag (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/sharedContext
Title: Summarizer: sharedContext property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/summarize
Title: Summarizer: summarize() method

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/summarizeStreaming
Title: Summarizer: summarizeStreaming() method

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Summarizer/type
Title: Summarizer: type property

https://chrome.dev/web-ai-demos/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2025-05-21 15:33:41)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

alexandrascript

Answering some editorial questions

files/en-us/web/api/createmonitor/index.md

files/en-us/web/api/summarizer_api/using/index.md

files/en-us/web/api/createmonitor/downloadprogress_event/index.md

files/en-us/web/api/summarizer_api/using/index.md

bsmth · 2025-05-21T08:53:28Z

files/en-us/web/api/summarizer_api/using/index.md

+
+Next, we use the {{domxref("EventTarget.addEventListener()")}} method to listen to two sets of events:
+
+- `click` events on the `<button>` element; when the button is clicked, the `handleSubmission()` function is called (we're not doing a real form `submit`, as they are disabled in the MDN live example embeds for security purposes).


Suggested change

- `click` events on the `<button>` element; when the button is clicked, the `handleSubmission()` function is called (we're not doing a real form `submit`, as they are disabled in the MDN live example embeds for security purposes).

- `click` events on the `<button>` element; when the button is clicked, the `handleSubmission()` function is called (we're not doing a real form `submit`).

You can do this with "allow-forms", like:

{{embedlivesample("example name", "400px", , , , , "allow-forms")}}

See https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples#sandbox

Nice! I've updated the code and wording to use the real submit.

bsmth · 2025-05-21T08:58:42Z

files/en-us/web/api/summarizer_api/using/index.md

+
+The rendered exaple looks like this:
+
+{{EmbedLiveSample("summarizer-example", "100%", "400px")}}


750px is tall enough for me to get rid of scroll:

Suggested change

{{EmbedLiveSample("summarizer-example", "100%", "400px")}}

{{EmbedLiveSample("summarizer-example", "100%", "750px")}}

And like this for enabling forms, I believe:

{{EmbedLiveSample("summarizer-example", , "750px", , , , , "allow-forms")}}

bsmth · 2025-05-21T09:12:26Z

Thanks, @chrisdavidmills - all done if you want a look 👀

Co-authored-by: Brian Smith <brian@smith.berlin>

bsmth

+1 from me, thanks! 👍🏻

files/en-us/web/api/summarizer_api/using/index.md

Co-authored-by: Brian Smith <brian@smith.berlin>

Document the Summarizer API

9eda31a

chrisdavidmills requested review from a team as code owners April 24, 2025 14:13

chrisdavidmills requested review from sideshowbarker and pepelsbey and removed request for a team April 24, 2025 14:13

chrisdavidmills marked this pull request as draft April 24, 2025 14:13

github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Apr 24, 2025

github-actions bot reviewed Apr 24, 2025

View reviewed changes

files/en-us/web/api/summarizer_api/using/index.md Outdated Show resolved Hide resolved

chrisdavidmills and others added 3 commits April 24, 2025 15:15

Update files/en-us/web/api/summarizer_api/index.md

a8ad5b0

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update files/en-us/web/api/summarizer_api/using/index.md

7edfeda

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Add most of the Summarizer interface docs

4177ab7

github-actions bot added size/xl [PR only] >1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Apr 25, 2025

chrisdavidmills mentioned this pull request Apr 27, 2025

Chrome 138 adds Summarizer API mdn/browser-compat-data#26638

Merged

Finish summarizer API pages

d9573fa

github-actions bot added the Content:HTTP HTTP docs label Apr 27, 2025

alexandrascript reviewed Apr 28, 2025

View reviewed changes

files/en-us/web/api/createmonitor/index.md Outdated Show resolved Hide resolved

files/en-us/web/api/summarizer_api/using/index.md Outdated Show resolved Hide resolved

tomayac reviewed Apr 28, 2025

View reviewed changes

files/en-us/web/api/createmonitor/downloadprogress_event/index.md Outdated Show resolved Hide resolved

Merge branch 'main' into writing-assistance-apis

e07c245

chrisdavidmills marked this pull request as ready for review May 5, 2025 13:49

chrisdavidmills requested a review from a team as a code owner May 5, 2025 13:49

chrisdavidmills requested review from bsmth and removed request for a team May 5, 2025 13:49

Small updates

9e20c15

chrisdavidmills changed the title ~~Document the Summarizer API~~ Technical review: Document the Summarizer API May 6, 2025

bsmth removed the request for review from sideshowbarker May 6, 2025 09:50

bsmth reviewed May 21, 2025

View reviewed changes

files/en-us/web/api/summarizer_api/using/index.md Outdated Show resolved Hide resolved

bsmth reviewed May 21, 2025

View reviewed changes

chrisdavidmills and others added 21 commits May 21, 2025 11:15

Update files/en-us/web/api/summarizer/type/index.md

db2453f

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/using/index.md

66f4ac1

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/type/index.md

7a571d8

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/using/index.md

7abb369

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/using/index.md

34dfe28

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/using/index.md

1e0b9fc

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/availability_static/index.md

1e9edf8

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/availability_static/index.md

d9a1fc9

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/expectedcontextlanguages/index.md

04a3de8

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/expectedcontextlanguages/index.md

7882a89

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/expectedinputlanguages/index.md

b299312

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/inputquota/index.md

4673393

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/inputquota/index.md

9d27864

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/inputquota/index.md

07bb615

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/outputlanguage/index.md

2141196

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer/measureinputusage/index.md

2560383

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/index.md

c7558ca

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/using/index.md

1827e01

Co-authored-by: Brian Smith <brian@smith.berlin>

Update files/en-us/web/api/summarizer_api/using/index.md

921cd3e

Co-authored-by: Brian Smith <brian@smith.berlin>

Fixes for bsmth review comments

2682952

Merge branch 'main' into writing-assistance-apis

bc4b6ac

bsmth approved these changes May 21, 2025

View reviewed changes

bsmth reviewed May 21, 2025

View reviewed changes

files/en-us/web/api/summarizer_api/using/index.md Outdated Show resolved Hide resolved

Update files/en-us/web/api/summarizer_api/using/index.md

5c9ea97

Co-authored-by: Brian Smith <brian@smith.berlin>

chrisdavidmills merged commit 683890a into mdn:main May 21, 2025
9 checks passed

chrisdavidmills deleted the writing-assistance-apis branch May 21, 2025 15:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editorial review: Document the Summarizer API #39263

Editorial review: Document the Summarizer API #39263

chrisdavidmills commented Apr 24, 2025 •

edited

Loading

github-actions bot commented Apr 24, 2025 •

edited

Loading

alexandrascript left a comment

bsmth May 21, 2025

chrisdavidmills May 21, 2025

bsmth May 21, 2025

bsmth May 21, 2025

bsmth commented May 21, 2025

bsmth left a comment


		Next, we use the {{domxref("EventTarget.addEventListener()")}} method to listen to two sets of events:

		- `click` events on the `<button>` element; when the button is clicked, the `handleSubmission()` function is called (we're not doing a real form `submit`, as they are disabled in the MDN live example embeds for security purposes).


		The rendered exaple looks like this:

		{{EmbedLiveSample("summarizer-example", "100%", "400px")}}

Editorial review: Document the Summarizer API #39263

Editorial review: Document the Summarizer API #39263

Conversation

chrisdavidmills commented Apr 24, 2025 • edited Loading

Description

Motivation

Additional details

Related issues and pull requests

github-actions bot commented Apr 24, 2025 • edited Loading

alexandrascript left a comment

Choose a reason for hiding this comment

bsmth May 21, 2025

Choose a reason for hiding this comment

chrisdavidmills May 21, 2025

Choose a reason for hiding this comment

bsmth May 21, 2025

Choose a reason for hiding this comment

bsmth May 21, 2025

Choose a reason for hiding this comment

bsmth commented May 21, 2025

bsmth left a comment

Choose a reason for hiding this comment

chrisdavidmills commented Apr 24, 2025 •

edited

Loading

github-actions bot commented Apr 24, 2025 •

edited

Loading