Writing Assistance APIs

1. Introduction

For now, see the explainer .

2. Shared AI APIs and infrastructure

partial interface WindowOrWorkerGlobalScope {
  [Replaceable, SecureContext] readonly attribute AI ai;
};
[Exposed=(Window,Worker), SecureContext]
interface AI {};
[Exposed=(Window,Worker), SecureContext]
interface AICreateMonitor : EventTarget {
  attribute EventHandler ondownloadprogress;
};
callback AICreateMonitorCallback = undefined (AICreateMonitor monitor);
enum AICapabilityAvailability { "readily", "after-download", "no" };

The minimum availability given a list of



AICapabilityAvailability

-or-null values availabilities is:

If availabilities contains null, then return null.
If availabilities contains " no ", then return " no ".
If availabilities contains " after-download ", then return " after-download ".
Return " readily ".

Each WindowOrWorkerGlobalScope has an AI namespace , an AI object. Upon creation of the WindowOrWorkerGlobalScope object, its AI namespace must be set to a new AI object created in the WindowOrWorkerGlobalScope object’s relevant realm .

The ai getter steps are to return this ’s AI namespace .

Tasks queued by this specification use the AI task source .

The following are the event handlers (and their corresponding event handler event types ) that must be supported, as event handler IDL attributes , by all AICreateMonitor objects:

Event handler	Event handler event type
`ondownloadprogress`	`downloadprogress`

3. The summarizer API

partial interface AI {
  readonly attribute AISummarizerFactory summarizer;
};
[Exposed=(Window,Worker), SecureContext]
interface AISummarizerFactory {
  Promise<AISummarizer> create(optional AISummarizerCreateOptions options = {});
  Promise<AICapabilityAvailability> availability(optional AISummarizerCreateCoreOptions options = {});
};
[Exposed=(Window,Worker), SecureContext]
interface AISummarizer {
  Promise<DOMString> summarize(
    DOMString input,
    optional AISummarizerSummarizeOptions options = {}
  );
  ReadableStream summarizeStreaming(
    DOMString input,
    optional AISummarizerSummarizeOptions options = {}
  );
  readonly attribute DOMString sharedContext;
  readonly attribute AISummarizerType type;
  readonly attribute AISummarizerFormat format;
  readonly attribute AISummarizerLength length;
  readonly attribute FrozenArray<DOMString>? expectedInputLanguages;
  readonly attribute FrozenArray<DOMString>? expectedContextLanguages;
  readonly attribute DOMString? outputLanguage;
  undefined destroy();
};
dictionary AISummarizerCreateCoreOptions {
  AISummarizerType type = "key-points";
  AISummarizerFormat format = "markdown";
  AISummarizerLength length = "short";
  sequence<DOMString> expectedInputLanguages;
  sequence<DOMString> expectedContextLanguages;
  DOMString outputLanguage;
};
dictionary AISummarizerCreateOptions : AISummarizerCreateCoreOptions {
  AbortSignal signal;
  AICreateMonitorCallback monitor;
  DOMString sharedContext;
};
dictionary AISummarizerSummarizeOptions {
  AbortSignal signal;
  DOMString context;
};
enum AISummarizerType { "tl;dr", "teaser", "key-points", "headline" };
enum AISummarizerFormat { "plain-text", "markdown" };
enum AISummarizerLength { "short", "medium", "long" };

Each AI has an summarizer factory , an AISummarizerFactory object. Upon creation of the AI object, its summarizer factory must be set to a new AISummarizerFactory object created in the AI object’s relevant realm .

The summarizer getter steps are to return this ’s summarizer factory .

3.1. Creation

The


create(

options

)

method steps are:

If this ’s relevant global object is a Window whose associated Document is not fully active , then return a promise rejected with an " InvalidStateError " DOMException.
If options [" signal "] exists and is aborted , then return a promise rejected with options [" signal "]'s abort reason .
Validate and canonicalize language tags given options. If this throws an exception e, catch it, and return a promise rejected with e.

This can mutate options.
Let fireProgressEvent be an algorithm taking two arguments that does nothing.
If options [" monitor "] exists , then:
1. Let monitor be a new AICreateMonitor created in this ’s relevant realm .
2. Invoke options [" monitor "] with « monitor » and " rethrow ".
  
  If this throws an exception e, catch it, and return a promise rejected with e.
3. Set fireProgressEvent to an algorithm taking ~~arguments~~ argument loaded and total, which performs the following steps:
  1. Assert : this algorithm is running in parallel .
  2. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. Fire an event named downloadprogress at monitor, using ProgressEvent, with the loaded attribute initialized to loaded, the total attribute initialized to ~~total ,~~ 1, and the lengthComputable attribute initialized to true.
      
      This assumes whatwg/xhr#394 is merged so that passing non-integer values for loaded works as expected.
Let abortedDuringDownload be false.

This variable will be written to from the event loop , but read from in parallel .
If options [" signal "] exists , then add the following abort steps to options [" signal "]:
1. Set abortedDuringDownload to true.
Let promise be a new promise created in this ’s relevant realm .
In parallel :
1. Let availability be the result of computing summarizer options availability given options.
  
  This can mutate options.
2. Switch on availability:
null
1. Reject promise with an " UnknownError " DOMException.
2. Abort these steps.
" no "
1. Reject promise with a " NotSupportedError " DOMException.
2. Abort these steps.
" readily "
1. If initializing the summarization model given promise and options returns false, then abort these steps.
2. ~~Let totalBytes be the total size of the previously-downloaded summarization capabilities, in bytes. Assert : totalBytes is greater than 0.~~ Perform fireProgressEvent given ~~0 and totalBytes .~~ 0.
3. Perform fireProgressEvent given ~~totalBytes and totalBytes .~~ 1.
4. Finalize summarizer creation given promise and options.
" after-download "
1. Initiate the download process for everything the user agent needs to summarize text according to options.
2. Run the following steps, but abort when abortedDuringDownload becomes true:
  1. Wait for the total number of bytes to be downloaded to become determined, and let that number be totalBytes.
  2. Let lastProgressTime be the monotonic clock ’s unsafe current time .
  3. Perform fireProgressEvent given ~~0 and totalBytes .~~ 0.
  4. While true:
    
    If one or more bytes have been downloaded, then:
    
    If the monotonic clock ’s unsafe current time minus lastProgressTime is greater than 50 ms, then:
    
    Let bytesSoFar be the number of bytes downloaded so far.
    
    Assert : bytesSoFar is greater than 0 and less than or equal to totalBytes.
    
    ~~Perform~~ Let fireProgressEvent rawProgressFraction ~~given~~ be bytesSoFar ~~and~~ divided by totalBytes.
    
    Let progressFraction be floor ( rawProgressFraction × 65,536) ÷ 65,536.
    Perform fireProgressEvent given progressFraction.
    We use a fraction, instead of firing a progress event with the number of bytes downloaded, to avoid giving precise information about the size of the model or other material being downloaded.
    progressFraction is calculated from rawProgressFraction to give a precision of one part in 2 ¹⁶. This ensures that over most internet speeds and with most model sizes, the loaded value will be different from the previous one that was fired ~50 milliseconds ago.
    Full calculation
    Assume a 5 GiB download size, and a 20 Mbps download speed (chosen as a number on the lower range from this source ). Then, downloading 5 GiB will take:
    $\begin{matrix} 5 GiB \times \frac{2^{30} bytes}{GiB} \times \frac{8 bits}{bytes} \div \frac{20 \times 10^{6} bits}{s} \times \frac{1000 ms}{s} \div \frac{50 ms}{interval} \\ = & 49,950 intervals \end{matrix}$
    Rounding up to the nearest power of two gives a conservative estimate of 65,536 fifty millisecond intervals, so we want to give progress to 1 part in 2 ¹⁶.
    If bytesSoFar equals totalBytes, then break .
    
    Since this is the only exit condition for the loop, we are guaranteed to fire a downloadprogress event for the 100% mark.
    
    Set lastProgressTime to the monotonic clock ’s unsafe current time .
    
    Otherwise, if downloading has failed and cannot continue, then:
    
    Queue a global task on the AI task source given this ’s relevant global object to reject promise with a " NetworkError " DOMException.
    
    Abort these steps.
3. If aborted , then:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    
    Assert : options [" signal "]'s is aborted .
    
    Reject promise with options [" signal "]'s abort reason .
  2. Abort these steps.
4. If initializing the summarization model given promise and options returns false, then abort these steps.
5. Finalize summarizer creation given promise and options.
Return promise.

To initialize the summarization model , given a



Promise

promise and an



AISummarizerCreateOptions

options:

Assert : these steps are running in parallel .
Perform any necessary initialization operations for the AI model backing the user agent ’s summarization capabilities.

This could include loading the model into memory, loading options [" sharedContext "] into the model’s context window, or loading any fine-tunings necessary to support the other options expressed by options.
If initialization failed for any reason, then:
1. Queue a global task on the AI task source given promise ’s relevant global object to reject promise with an " OperationError " DOMException.
2. Return false.
Return true.

To finalize summarizer creation , given a



Promise

promise and an



AISummarizerCreateOptions

options:

Assert : these steps are running in parallel .
Queue a global task on the AI task source given promise ’s relevant global object to perform the following steps:
1. If options [" signal "] exists and is aborted , then:
  1. Reject promise with options [" signal "]'s abort reason .
  2. Abort these steps.
  This check is necessary in case any code running on the event loop caused the AbortSignal to become aborted before this task ran.
2. Let summarizer be a new AISummarizer object, created in promise ’s relevant realm , with
  
  shared context
  
  options [" sharedContext "] if it exists ; otherwise null
  
  summary type
  
  options [" type "]
  
  summary format
  
  options [" format "]
  
  summary length
  
  options [" length "]
  
  expected input languages
  
  the result of creating a frozen array given options [" expectedInputLanguages "] if it is not empty ; otherwise null
  
  expected context languages
  
  the result of creating a frozen array given options [" expectedContextLanguages "] if it is not empty ; otherwise null
  
  output language
  
  options [" outputLanguage "] if it exists ; otherwise null
3. If options [" signal "] exists , then add the following abort steps to options [" signal "]:
  1. Destroy summarizer with options [" signal "]'s abort reason .
4. Resolve promise with summarizer.

To validate and canonicalize language tags given an



AISummarizerCreateCoreOptions

options, perform the following steps. They mutate options in place to canonicalize and deduplicate language tags, and throw a



TypeError

if any are invalid.

Let expectedInputLanguages be an empty ordered set .
If options [" expectedInputLanguages "] exists , then for each languageTag of options [" expectedInputLanguages "]:
1. If IsStructurallyValidLanguageTag ( languageTag ) is false, then throw a TypeError.
2. Append CanonicalizeUnicodeLocaleId ( languageTag ) to expectedInputLanguages.
Set options [" expectedInputLanguages "] to expectedInputLanguages.
Let expectedContextLanguages be an empty ordered set .
If options [" expectedContextLanguages "] exists , then for each languageTag of options [" expectedContextLanguages "]:
1. If IsStructurallyValidLanguageTag ( languageTag ) is false, then throw a TypeError.
2. Append CanonicalizeUnicodeLocaleId ( languageTag ) to expectedContextLanguages.
Set options [" expectedContextLanguages "] to expectedContextLanguages.
If options [" outputLanguage "] exists , then:
1. If IsStructurallyValidLanguageTag ( options [" outputLanguage "]) is false, then throw a TypeError.
2. Set options [" outputLanguage "] to CanonicalizeUnicodeLocaleId ( options [" outputLanguage "]).

3.2. Availability

The


availability(

options

)

method steps are:

If this ’s relevant global object is a Window whose associated Document is not fully active , then return a promise rejected with an " InvalidStateError " DOMException.
Validate and canonicalize language tags given options.
Let promise be a new promise created in this ’s relevant realm .
In parallel :
1. Let availability be the result of computing summarizer options availability given options.
2. If availability is null, then reject promise with an " UnknownError " DOMException.
3. Otherwise, resolve promise with availability.

To compute summarizer options availability given an



AISummarizerCreateCoreOptions

options, perform the following steps. They return either an



AICapabilityAvailability

value or null, and they mutate options in place to update language tags to their best-fit matches.

Assert : this algorithm is running in parallel .
Let availability be the summarizer non-language options availability given options [" type "], options [" format "], and options [" length "].
If availability is null, then return null.
Let languageAvailabilities be the summarizer language availabilities .
If languageAvailabilities is null, then return null.
For each languageTag of options [" expectedInputLanguages "]:
1. Let bestReadilyAvailableMatch be LookupMatchingLocaleByBestFit ( languageAvailabilities ’s readily available input languages , languageTag ).
2. If bestReadilyAvailableMatch is not undefined, then:
  1. Replace languageTag with bestReadilyAvailableMatch in options [" expectedInputLanguages "].
  2. Continue .
3. Let bestAfterDownloadAvailableMatch be LookupMatchingLocaleByBestFit ( languageAvailabilities ’s after-download available input languages , languageTag ).
4. If bestAfterDownloadAvailableMatch is not undefined, then:
  1. Replace languageTag with bestAfterDownloadAvailableMatch in options [" expectedInputLanguages "].
  2. Set availability to the minimum availability given « availability, " after-download " ».
5. Otherwise, return " no ".
For each languageTag of options [" expectedContextLanguages "]:
1. Let bestReadilyAvailableMatch be LookupMatchingLocaleByBestFit ( languageAvailabilities ’s readily available context languages , languageTag ).
2. If bestReadilyAvailableMatch is not undefined, then:
  1. Replace languageTag with bestReadilyAvailableMatch in options [" expectedContextLanguages "].
  2. Continue .
3. Let bestAfterDownloadAvailableMatch be LookupMatchingLocaleByBestFit ( languageAvailabilities ’s after-download available context languages , languageTag ).
4. If bestAfterDownloadAvailableMatch is not undefined, then:
  1. Replace languageTag with bestAfterDownloadAvailableMatch in options [" expectedContextLanguages "].
  2. Set availability to the minimum availability given « availability, " after-download " ».
5. Otherwise, return " no ".
If options [" outputLanguage "] is present, then:
1. Let bestReadilyAvailableMatch be LookupMatchingLocaleByBestFit ( languageAvailabilities ’s readily available output languages , options [" outputLanguage "]).
2. If bestReadilyAvailableMatch is not undefined, then:
  1. Set options [" outputLanguage "] to bestReadilyAvailableMatch.
3. Otherwise:
  1. Let bestAfterDownloadAvailableMatch be LookupMatchingLocaleByBestFit ( languageAvailabilities ’s after-download available output languages , options [" outputLanguage "]).
  2. If bestAfterDownloadAvailableMatch is not undefined, then:
    1. Set options [" outputLanguage "] to bestAfterDownloadAvailableMatch.
    2. Set availability to the minimum availability given « availability, " after-download " ».
  3. Otherwise, return " no ".
Assert : availability is either " readily " or " after-download ".
Return availability.

The summarizer non-language options availability , given a



AISummarizerType

type,



AISummarizerFormat

format, and an



AISummarizerLength

length, is given by the following steps. They return an



AICapabilityAvailability

value or null.

Assert : this algorithm is running in parallel .
If there is some error attempting to determine whether the user agent supports summarizing text, which the user agent believes to be transient (such that re-querying the summarizer non-language options availability could stop producing such an error), then return null.
If the user agent supports summarizing text into the type of summary described by type, in the format described by format, and with the length guidance given by length without performing any downloading operations, then return " readily ".
If the user agent believes it can summarize text according to type, format, and length, but only after performing a download (e.g., of an AI model or fine-tuning), then return " after-download ".
Otherwise, return " no ".

A language availabilities is a struct with the following items :

readily available input languages
after-download available input languages
readily available context languages
after-download available context languages
readily available output languages
after-download available output languages

All of these items are sets of strings representing Unicode canonicalized locale identifiers , initially empty. [ECMA-402]

The summarizer language availabilities are given by the following steps. They return a language availabilities or null.

Assert : this algorithm is running in parallel .
If there is some error attempting to determine whether the user agent supports summarizing text, which the user agent believes to be transient (such that re-querying the summarizer language availabilities could stop producing such an error), then return null.
Let availabilities be a language availabilities .
Fill language availabilities given availabilities ’s readily available input languages , availabilities ’s after-download available input languages , and the purpose of summarizing text written in that language.
Fill language availabilities given availabilities ’s readily available context languages , availabilities ’s after-download available context languages , and the purpose of summarizing text using web-developer provided context information written in that language.
Fill language availabilities given availabilities ’s readily available output languages , availabilities ’s after-download available output languages , and the purpose of producing text summaries in that language.
Return availabilities.

To fill language availabilities given a set readilyAvailableLanguages, a set afterDownloadAvailableLanguages, and a description of the purpose for which we’re checking language availability, perform the following steps:

For each human language languageTag, represented as a Unicode canonicalized locale identifier , for which the user agent supports purpose, without performing any downloading operations:
1. Append languageTag to readilyAvailableLanguages.
For each human language languageTag, represented as a Unicode canonicalized locale identifier , for which the user agent believes it can support purpose, but only after performing a download (e.g., of an AI model or fine-tuning):
1. Assert : readilyAvailableLanguages does not contain languageTag.
2. Append languageTag to afterDownloadAvailableLanguages.
If the union of readilyAvailableLanguages and afterDownloadAvailableLanguages does not meet the language tag set completeness rules , then:
1. Let missingLanguageTags be the set of missing language tags necessary to meet the language tag set completeness rules .
2. For each languageTag of missingLanguageTags:
  1. Append languageTag to either readilyAvailableLanguages or afterDownloadAvailableLanguages. Which of the two sets to append to is implementation-defined , and should be guided by considerations similar to that of LookupMatchingLocaleByBestFit in terms of keeping "best fallback languages" together.

The language tag set completeness rules state that for every item languageTag, if languageTag has more than one subtag, then the set must also contain a less narrow language tag with the same language subtag and a strict subset of the same following subtags (i.e., omitting one or more).

This definition is intended to align with that of [[AvailableLocales]] in ECMAScript Internationalization API Specification . [ECMA-402]

This means that if an implementation supports summarization of "


de-DE

" input text, it will also count as supporting "

de

" input text.

The converse direction is supported not by the language tag set completeness rules , but instead by the use of LookupMatchingLocaleByBestFit , which ensures that if an implementation supports summarizing " de " input text, it also counts as supporting summarization of " de-CH ", " de-Latn-CH ", etc.

A common setup seen in today’s software is to support two types of written Chinese: "traditional Chinese" and "simplified Chinese". Let’s suppose that the user agent supports summarizing text written in traditional Chinese readily, and simplified Chinese after a download.

One way this could be implemented would be for summarizer language availabilities to return that " zh-Hant " is in the readily available input languages , and " zh " and " zh-Hans " are in the after-download available input languages . This return value conforms to the requirements of the language tag set completeness rules , in ensuring that " zh " is present. Per the "should"-level guidance , the implementation has determined that " zh " belongs in the set of after-download available input languages , with " zh-Hans ", instead of in the set of readily available input languages , with " zh-Hant ".

Combined with the use of LookupMatchingLocaleByBestFit , this means availability() will give the following answers:

function inputLangAvailability(languageTag) {
  return ai.summarizer.availability({
    expectedInputLanguages: [languageTag]
  });
}
inputLangAvailability("zh") === "after-download";
inputLangAvailability("zh-Hant") === "readily";
inputLangAvailability("zh-Hans") === "after-download";
inputLangAvailability("zh-TW") === "readily";          // zh-TW will best-fit to zh-Hant
inputLangAvailability("zh-HK") === "readily";          // zh-HK will best-fit to zh-Hant
inputLangAvailability("zh-CN") === "after-download";   // zh-CN will best-fit to zh-Hans
inputLangAvailability("zh-BR") === "after-download";   // zh-BR will best-fit to zh
inputLangAvailability("zh-Kana") === "after-download"; // zh-Kana will best-fit to zh

3.3. The `AISummarizer` class

Every AISummarizer has a shared context , a string -or-null, set during creation.

Every AISummarizer has a summary type , an AISummarizerType, set during creation.

Every AISummarizer has a summary format , an AISummarizerFormat, set during creation.

Every AISummarizer has a summary length , an AISummarizerLength, set during creation.

Every AISummarizer has an expected input languages , a FrozenArray < DOMString > or null, set during creation.

Every AISummarizer has an expected context languages , a FrozenArray < DOMString > or null, set during creation.

Every AISummarizer has an output language , a string or null, set during creation.

Every AISummarizer has a destruction reason , a JavaScript value, initially undefined.

Every AISummarizer has a destroyed boolean, initially false.

This value is separate from the destruction reason so that it can be read from in parallel during the summarization process.

The sharedContext getter steps are to return this ’s shared context .

The type getter steps are to return this ’s summary type .

The format getter steps are to return this ’s summary format .

The length getter steps are to return this ’s summary length .

The expectedInputLanguages getter steps are to return this ’s expected input languages .

The expectedContextLanguages getter steps are to return this ’s expected context languages .

The outputLanguage getter steps are to return this ’s output language .

The


summarize(

input
,

options

)

method steps are:

If this ’s relevant global object is a Window whose associated Document is not fully active , then return a promise rejected with an " InvalidStateError " DOMException.
If this ’s destroyed is true, then return a promise rejected with this ’s destruction reason .
If options [" signal "] exists and is aborted , then return a promise rejected with options [" signal "]'s abort reason .
Let abortedDuringSummarization be false.

This variable will be written to from the event loop , but read from in parallel .
If options [" signal "] exists , then add the following abort steps to options [" signal "]:
1. Set abortedDuringSummarization to true.
Let promise be a new promise created in this ’s relevant realm .
Let context be options [" context "] if it exists ; otherwise null.
In parallel :
1. Let summary be the empty string.
2. Let chunkProduced be the following steps given a string chunk:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. If abortedDuringSummarization is true, then:
      1. Reject promise with options [" signal "]'s abort reason .
      2. Abort these steps.
    2. If this ’s destroyed is true, then:
      1. Reject promise with this ’s destruction reason .
      2. Abort these steps.
    3. Append chunk to summary.
3. Let done be the following steps:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. If abortedDuringSummarization is true, then:
      1. Reject promise with options [" signal "]'s abort reason .
      2. Abort these steps.
    2. If this ’s destroyed is true, then:
      1. Reject promise with this ’s destruction reason .
      2. Abort these steps.
    3. Resolve promise with summary.
4. Let error be the following steps given summarization error information errorInfo:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. If abortedDuringSummarization is true, then:
      1. Reject promise with options [" signal "]'s abort reason .
      2. Abort these steps.
    2. Let exception be the result of creating a DOMException with name given by errorInfo ’s error name , using errorInfo ’s error information to populate the message appropriately.
    3. Reject promise with exception.
5. Let stopProducing be the following steps:
  1. Return abortedDuringSummarization.
6. Summarize input given this ’s shared context , context, this ’s summary type , this ’s summary format , this ’s summary length , this ’s output language , chunkProduced, done, error, and stopProducing.
Return promise.

The


summarizeStreaming(

input
,

options

)

method steps are:

If this ’s relevant global object is a Window whose associated Document is not fully active , then throw an " InvalidStateError " DOMException.
If this ’s destroyed is true, then throw this ’s destruction reason .
If options [" signal "] exists and is aborted , then throw options [" signal "]'s abort reason .
Let abortedDuringSummarization be false.

This variable tracks web developer aborts via the options [" signal "] AbortSignal, which are surfaced as errors. It will be written to from the event loop , but sometimes read from in parallel .
If options [" signal "] exists , then add the following abort steps to options [" signal "]:
1. Set abortedDuringSummarization to true.
Let stream be a new ReadableStream created in this ’s relevant realm .
Let canceledDuringSummarization be false.

This variable tracks web developer stream cancelations via stream.cancel(), which are not surfaced as errors. It will be written to from the event loop , but sometimes read from in parallel .
Set up stream with cancelAlgorithm set to the following steps (ignoring the reason argument):
1. Set canceledDuringSummarization to true.
Let context be options [" context "] if it exists ; otherwise null.
In parallel :
1. Let chunkProduced be the following steps given a string chunk:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. If abortedDuringSummarization is true, then:
      1. Error stream with options [" signal "]'s abort reason .
      2. Abort these steps.
    2. If this ’s destroyed is true, then:
      1. Error stream with this ’s destruction reason .
      2. Abort these steps.
    3. Enqueue chunk into stream.
2. Let done be the following steps:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. If abortedDuringSummarization is true, then:
      1. Error stream with options [" signal "]'s abort reason .
      2. Abort these steps.
    2. If this ’s destroyed is true, then:
      1. Error stream with this ’s destruction reason .
      2. Abort these steps.
    3. Close stream.
3. Let error be the following steps given summarization error information errorInfo:
  1. Queue a global task on the AI task source given this ’s relevant global object to perform the following steps:
    1. If abortedDuringSummarization is true, then:
      1. Error stream with options [" signal "]'s abort reason .
      2. Abort these steps.
    2. If this ’s destroyed is true, then:
      1. Error stream with this ’s destruction reason .
      2. Abort these steps.
    3. Let exception be the result of creating a DOMException with name given by errorInfo ’s error name , using errorInfo ’s error information to populate the message appropriately.
    4. Error stream with exception.
4. Let stopProducing be the following steps:
  1. If any of abortedDuringSummarization, canceledDuringSummarization, or this ’s destroyed are true, then return true.
  2. Return false.
5. Summarize input given this ’s shared context , context, this ’s summary type , this ’s summary format , this ’s summary length , this ’s output language , chunkProduced, done, error, and stopProducing.
Return stream.

To summarize a string input, given a string-or-null sharedContext, a string-or-null context, an



AISummarizerType

type, an



AISummarizerFormat

format, an



AISummarizerLength

length, a string -or-null outputLanguage, an algorithm chunkProduced that takes a string and returns nothing, an algorithm done that takes no arguments and returns nothing, an algorithm error that takes summarization error information and returns nothing, and an algorithm stopProducing that takes no arguments and returns a boolean:

Assert : this algorithm is running in parallel .
In an implementation-defined manner, subject to the following guidelines, begin the processs of summarizing input into a string.

If they are non-null, sharedContext and context should be used to aid in the summarization by providing context on how the web developer wishes the input to be summarized.

The summarization should conform to the guidance given by type, format, and length, in the definitions of each of their enumeration values.

If outputLanguage is non-null, the summarization should be in that language. Otherwise, it should be in the language of input (which might not match that of context or sharedContext ). If input contains multiple languages, or the language of input cannot be detected, then either the output language is implementation-defined , or the implementation may treat this as an error, per the guidance in § 3.5 Errors .
While true:
1. Wait for the next chunk of summarization data to be produced, for the summarization process to finish, or for the result of calling stopProducing to become true.
2. If such a chunk is successfully produced:
  1. Let it be represented as a string chunk.
  2. Perform chunkProduced given chunk.
3. Otherwise, if the summarization process has finished:
  1. Perform done.
  2. Break .
4. Otherwise, if stopProducing returns true, then break .
  
  The caller will handle signaling cancelation or aborting as necessary.
5. Otherwise, if an error occurred during summarization:
  1. Let the error be represented as summarization error information errorInfo according to the guidance in § 3.5 Errors .
  2. Perform error given errorInfo.
  3. Break .

The destroy() method steps are to destroy this given a new " AbortError " DOMException.

To destroy an



AISummarizer

summarizer, given a JavaScript value reason:

Set summarizer ’s destroyed to true.
Set summarizer ’s destruction reason to reason.
The user agent should release any resources associated with summarizer, such as AI models loaded during initialize the summarization model , as long as those resources are not needed for other ongoing operations.

3.4. Options

The summarize algorithm’s details are implementation-defined , as they are expected to be powered by an AI model. However, it is intended to be controllable by the web developer through the AISummarizerType, AISummarizerFormat, and AISummarizerLength enumerations.

This section gives normative guidance on how the implementation of summarize should use each enumeration value to guide the summarization process.

`AISummarizerType` values
Value	Meaning
" `tl;dr` "	The summary should be short and to the point, providing a quick overview of the input, suitable for a busy reader.
" `teaser` "	The summary should focus on the most interesting or intriguing parts of the input, designed to draw the reader in to read more.
" `key-points` "	The summary should extract the most important points from the input, presented as a bulleted list.
" `headline` "	The summary should effectively contain the main point of the input in a single sentence, in the format of an article headline.

`AISummarizerLength` values
Value	Meaning
" `short` "	The guidance is dependent on the value of `AISummarizerType`: " `tl;dr` " " `teaser` " The summary should fit within 1 sentence. " `key-points` " The summary should consist of no more than 3 bullet points. " `headline` " The summary should use no more than 12 words.
" `medium` "	The guidance is dependent on the value of `AISummarizerType`: " `tl;dr` " " `teaser` " The summary should fit within 1 short paragraph. " `key-points` " The summary should consist of no more than 5 bullet points. " `headline` " The summary should use no more than 17 words.
" `long` "	The guidance is dependent on the value of `AISummarizerType`: " `tl;dr` " " `teaser` " The summary should fit within 1 paragraph. " `key-points` " The summary should consist of no more than 7 bullet points. " `headline` " The summary should use no more than 22 words.

As with all " should "-level guidance, user agents might not conform perfectly to these. Especially in the case of counting words, it’s expected that language models might not conform perfectly.

`AISummarizerFormat` values
Value	Meaning
" `plain-text` "	The summary should not contain any formatting or markup language.
" `markdown` "	The summary should be formatted using the Markdown markup language, ideally as valid CommonMark. [COMMONMARK]

3.5. Errors

A summarization error information is a struct with the following items :

error name: a string that will be used for the DOMException ’s name .
error information: other information necessary to create a useful DOMException for the web developer. (Typically, just an exception message.)

When summarization fails, the following possible reasons may be surfaced to the web developer. This table lists the possible DOMException names and the cases in which an implementation should use them:

`DOMException` name	Scenarios
" `NotAllowedError` "	Summarization is disabled by user choice or user agent policy.
" `NotReadableError` "	The summarization output was filtered by the user agent, e.g., because it was detected to be harmful, inaccurate, or nonsensical.
" `NotSupportedError` "	The input to be summarized, or the context to be provided, was in a language that the user agent does not support, or was not provided properly in the call to `create()`. The summarization output ended up being in a language that the user agent does not support (e.g., because the user agent has not performed sufficient quality control tests on that output language), or was not provided properly in the call to `create()`. The `outputLanguage` option was not set, and the language of the input text could not be determined, so the user agent did not have a good output language default available.
" `QuotaExceededError` "	The input to be summarized was too large for the user agent to handle.
" `UnknownError` "	All other scenarios, or if the user agent would prefer not to disclose the failure reason.

This table does not give the complete list of exceptions that can be surfaced by summarizer.summarize() and summarizer.summarizeStreaming(). It only contains those which can come from the implementation-defined summarize algorithm.

4. The writer API

Just IDL for now; full spec coming!

[Exposed=(Window,Worker), SecureContext]
interface AIWriterFactory {
  Promise<AIWriter> create(optional AIWriterCreateOptions options = {});
  Promise<AICapabilityAvailability> availability(optional AIWriterCreateCoreOptions options = {});
};
[Exposed=(Window,Worker), SecureContext]
interface AIWriter {
  Promise<DOMString> write(DOMString writingTask, optional AIWriterWriteOptions options = {});
  ReadableStream writeStreaming(DOMString writingTask, optional AIWriterWriteOptions options = {});
  readonly attribute DOMString sharedContext;
  readonly attribute AIWriterTone tone;
  readonly attribute AIWriterFormat format;
  readonly attribute AIWriterLength length;
  readonly attribute FrozenArray<DOMString>? expectedInputLanguages;
  readonly attribute FrozenArray<DOMString>? expectedContextLanguages;
  readonly attribute DOMString? outputLanguage;
  undefined destroy();
};
dictionary AIWriterCreateCoreOptions {
  AIWriterTone tone = "neutral";
  AIWriterFormat format = "markdown";
  AIWriterLength length = "short";
  sequence<DOMString> expectedInputLanguages;
  sequence<DOMString> expectedContextLanguages;
  DOMString outputLanguage;
};
dictionary AIWriterCreateOptions : AIWriterCreateCoreOptions {
  AbortSignal signal;
  AICreateMonitorCallback monitor;
  DOMString sharedContext;
};
dictionary AIWriterWriteOptions {
  DOMString context;
  AbortSignal signal;
};
enum AIWriterTone { "formal", "neutral", "casual" };
enum AIWriterFormat { "plain-text", "markdown" };
enum AIWriterLength { "short", "medium", "long" };

5. The rewriter API

Just IDL for now; full spec coming!

[Exposed=(Window,Worker), SecureContext]
interface AIRewriterFactory {
  Promise<AIRewriter> create(optional AIRewriterCreateOptions options = {});
  Promise<AICapabilityAvailability> availability(optional AIRewriterCreateCoreOptions options = {});
};
[Exposed=(Window,Worker), SecureContext]
interface AIRewriter {
  Promise<DOMString> rewrite(DOMString input, optional AIRewriterRewriteOptions options = {});
  ReadableStream rewriteStreaming(DOMString input, optional AIRewriterRewriteOptions options = {});
  readonly attribute DOMString sharedContext;
  readonly attribute AIRewriterTone tone;
  readonly attribute AIRewriterFormat format;
  readonly attribute AIRewriterLength length;
  readonly attribute FrozenArray<DOMString>? expectedInputLanguages;
  readonly attribute FrozenArray<DOMString>? expectedContextLanguages;
  readonly attribute DOMString? outputLanguage;
  undefined destroy();
};
dictionary AIRewriterCreateCoreOptions {
  AIRewriterTone tone = "as-is";
  AIRewriterFormat format = "as-is";
  AIRewriterLength length = "as-is";
  sequence<DOMString> expectedInputLanguages;
  sequence<DOMString> expectedContextLanguages;
  DOMString outputLanguage;
};
dictionary AIRewriterCreateOptions : AIRewriterCreateCoreOptions {
  AbortSignal signal;
  AICreateMonitorCallback monitor;
  DOMString sharedContext;
};
dictionary AIRewriterRewriteOptions {
  DOMString context;
  AbortSignal signal;
};
enum AIRewriterTone { "as-is", "more-formal", "more-casual" };
enum AIRewriterFormat { "as-is", "plain-text", "markdown" };
enum AIRewriterLength { "as-is", "shorter", "longer" };

Writing Assistance APIs

Abstract

Status of this document

1. Introduction

2. Shared AI APIs and infrastructure

3. The summarizer API

3.1. Creation

3.2. Availability

3.3. The `AISummarizer` class

3.4. Options

3.5. Errors

4. The writer API

5. The rewriter API

Index

Terms defined by this specification

Terms defined by reference

References

Normative References

IDL Index

Writing Assistance APIs

Abstract

Status of this document

1. Introduction

2. Shared AI APIs and infrastructure

3. The summarizer API

3.1. Creation

3.2. Availability

3.3. The AISummarizer class

3.4. Options

3.5. Errors

4. The writer API

5. The rewriter API

Index

Terms defined by this specification

Terms defined by reference

References

Normative References

IDL Index

3.3. The `AISummarizer` class