You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update token-counting and context overflow API surface
This is mostly to align with webmachinelearning/writing-assistance-apis#31:
* Use TooManyTokensError when appropriate, instead of a "QuotaExceededError" DOMException.
* Rename tokensLeft/tokensSoFar to tokensAvailable/tokenCount.
* Rename countPromptTokens() to countTokens().
* Remove maxTokens.
* Rename "contextoverflow" to "overflow", since the vocabulary "context" is not used elsewhere in the API and there's only one relevant type of overflow for the session.
Copy file name to clipboardexpand all lines: README.md
+23-33
Original file line number
Diff line number
Diff line change
@@ -81,7 +81,7 @@ console.log(await session.prompt("What is your favorite food?"));
81
81
82
82
The system prompt is special, in that the language model will not respond to it, and it will be preserved even if the context window otherwise overflows due to too many calls to `prompt()`.
83
83
84
-
If the system prompt is too large (see [below](#tokenization-context-window-length-limits-and-overflow)), then the promise will be rejected with a `"QuotaExceededError"``DOMException`.
84
+
If the system prompt is too large, then the promise will be rejected with a `TooManyTokens` exception. See [below](#tokenization-context-window-length-limits-and-overflow) for more details on token counting and this new exception type.
85
85
86
86
### N-shot prompting
87
87
@@ -114,7 +114,7 @@ const result2 = await predictEmoji("This code is so good you should get promoted
114
114
Some details on error cases:
115
115
116
116
* Using both `systemPrompt` and a `{ role: "system" }` prompt in `initialPrompts`, or using multiple `{ role: "system" }` prompts, or placing the `{ role: "system" }` prompt anywhere besides at the 0th position in `initialPrompts`, will reject with a `TypeError`.
117
-
* If the combined token length of all the initial prompts (including the separate `systemPrompt`, if provided) is too large, then the promise will be rejected with a `"QuotaExceededError"``DOMException`.
117
+
* If the combined token length of all the initial prompts (including the separate `systemPrompt`, if provided) is too large, then the promise will be rejected with a [`TooManyTokens` exception](#tokenization-context-window-length-limits-and-overflow).
118
118
119
119
### Customizing the role per prompt
120
120
@@ -295,31 +295,36 @@ Note that because sessions are stateful, and prompts can be queued, aborting a s
295
295
A given language model session will have a maximum number of tokens it can process. Developers can check their current usage and progress toward that limit by using the following properties on the session object:
* We do not expose the actual tokenization to developers since that would make it too easy to depend on model-specific details.
310
310
* Implementations must include in their count any control tokens that will be necessary to process the prompt, e.g. ones indicating the start or end of the input.
311
-
* The counting process can be aborted by passing an `AbortSignal`, i.e. `session.countPromptTokens(promptString, { signal })`.
311
+
* The counting process can be aborted by passing an `AbortSignal`, i.e. `session.countTokens(promptString, { signal })`.
312
312
313
-
It's possible to send a prompt that causes the context window to overflow. That is, consider a case where `session.countPromptTokens(promptString) > session.tokensLeft` before calling `session.prompt(promptString)`, and then the web developer calls `session.prompt(promptString)` anyway. In such cases, the initial portions of the conversation with the language model will be removed, one prompt/response pair at a time, until enough tokens are available to process the new prompt. The exception is the [system prompt](#system-prompts), which is never removed. If it's not possible to remove enough tokens from the conversation history to process the new prompt, then the `prompt()` or `promptStreaming()` call will fail with an `"QuotaExceededError"``DOMException` and nothing will be removed.
313
+
It's possible to send a prompt that causes the context window to overflow. That is, consider a case where `session.countTokens(promptString) > session.tokensAvailable` before calling `session.prompt(promptString)`, and then the web developer calls `session.prompt(promptString)` anyway. In such cases, the initial portions of the conversation with the language model will be removed, one prompt/response pair at a time, until enough tokens are available to process the new prompt. The exception is the [system prompt](#system-prompts), which is never removed.
314
314
315
-
Such overflows can be detected by listening for the `"contextoverflow"` event on the session:
315
+
Such overflows can be detected by listening for the `"overflow"` event on the session:
If it's not possible to remove enough tokens from the conversation history to process the new prompt, then the `prompt()` or `promptStreaming()` call will fail with a `TooManyTokens` exception and nothing will be removed. A `TooManyTokens` exception is a new type of exception, which subclasses `DOMException`, and adds the following additional properties:
324
+
325
+
*`tokenCount`: how many tokens the input consists of
326
+
*`tokensAvailable`: how many tokens were available (which will be less than `tokenCount`, and equal to the value of `session.tokensAvailable` at the time of the call)
327
+
323
328
### Multilingual content and expected languages
324
329
325
330
The default behavior for a language model session assumes that the input languages are unknown. In this case, implementations will use whatever "base" capabilities they have available for the language model, and might throw `"NotSupportedError"``DOMException`s if they encounter languages they don't support.
@@ -398,33 +403,19 @@ It is also nicely future-extensible by adding more events and properties to the
398
403
Finally, note that there is a sort of precedent in the (never-shipped) [`FetchObserver` design](https://github.com/whatwg/fetch/issues/447#issuecomment-281731850).
399
404
</details>
400
405
406
+
### Too-large inputs
407
+
401
408
## Detailed design
402
409
403
410
### Full API surface in Web IDL
404
411
405
412
```webidl
406
-
// Shared self.ai APIs
413
+
// Shared self.ai APIs:
414
+
// See https://webmachinelearning.github.io/writing-assistance-apis/#shared-ai-api for most of them.
407
415
408
-
partial interface WindowOrWorkerGlobalScope {
409
-
[Replaceable, SecureContext] readonly attribute AI ai;
0 commit comments