Skip to content

Overhaul availability testing and add expected language options #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 17, 2025

Conversation

domenic
Copy link
Collaborator

@domenic domenic commented Dec 6, 2024

  • Add options for expectedInputLanguages, expectedContextLanguages, and outputLanguage. The former two are used for downloading additional material and early errors if the web developer's required input/context languages cannot be supported by the browser. The latter gives clarity about what to do given mixed-language inputs.

  • Remove the capabilities() method and the accompanying AI*Capabilities classes. The reasoning is as follows:

    Those classes had three APIs: available, createOptionsAvailable(), and languageAvailable(). languageAvailable() wasn't clear if it was talking about input, context, or output languages. Now that we have explicit options for those three, we could fold language availability testing into createOptionsAvailable(). But then, we can note that the available property is kind of useless, as just knowing that some possible combination of options/languages is supported is not helpful for any known use case. So, the only real functionality we care about is testing whether a given set of options to create() is supported.

    This was previously done via (await ai.apiName.capabilities()).createOptionsAvailable(). We instead expose it via await ai.apiName.availability(). This name is a bit clearer, and this design also avoids the complexity where we have to retrieve all the availability information for every combination of options during the call to capabilities(), for later sync access. Now we can just retrieve the relevant information during the call to availability().

This was previously discussed in webmachinelearning/prompt-api#29; see especially webmachinelearning/prompt-api#29 (comment). Closes #16.

See also webmachinelearning/prompt-api#69 and webmachinelearning/translation-api#31.


Preview | Diff

@domenic
Copy link
Collaborator Author

domenic commented Dec 11, 2024

Further work might remove the AISummarizerCapabilities object altogether, since now it's mostly a wrapper around the single createOptionsAvailable() method.

I'm becoming more convinced this is correct. I will try to add those changes on this branch, first in the explainer, then the spec.

These solve the problem discussed in webmachinelearning/prompt-api#29 and #16. They provide a mechanism for web developers to tell the browser to download additional material to support additional languages, and for web developers to get early errors if they know they will be trying to use a language that isn't supported. It also clearly separates input, context, and output languages, with a requirement on how the output language is produced by default (match the input).

This removes the languageAvailable() API, folding it into createOptionsAvailable(). Further work might remove the AISummarizerCapabilities object altogether, since now it's mostly a wrapper around the single createOptionsAvailable() method.
@domenic domenic changed the title Add expectedInputLanguages, expectedContextLanguages, outputLanguage Overhaul availability testing and add expected language options Dec 12, 2024
aarongable pushed a commit to chromium/chromium that referenced this pull request Dec 13, 2024
Add CoreOptions dictionaries with new tone|format|length enums.
Add factory availability() methods and helpers with skeleton impls.
Update and expand some test coverage.

Update API shape to better match latest explainer updates:
  https://github.com/WICG/writing-assistance-apis
  webmachinelearning/writing-assistance-apis#22

TODO: Expand chrome/browser/ai/ai_[re]writer_unittest.cc coverage:
- Add AIRewriterTest RewritePlainText and RewriteMarkdown.
- Add AIWriterTest coverage for tone, format, length options.

Bug: 380088820, 382596381, 382615217, 380239468
Test: Shape better matches explainer and naive impl WAI.
Change-Id: I7e6c569adf30c6324038b7ee8738a4689c2b2838
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6071867
Reviewed-by: Brad Triebwasser <btriebw@chromium.org>
Auto-Submit: Mike Wasserman <msw@chromium.org>
Reviewed-by: Will Harris <wfh@chromium.org>
Reviewed-by: Clark DuVall <cduvall@chromium.org>
Commit-Queue: Clark DuVall <cduvall@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1396042}
@domenic domenic merged commit da9ac67 into main Jan 17, 2025
1 check passed
@domenic domenic deleted the language-settings branch January 17, 2025 02:38
domenic added a commit to webmachinelearning/prompt-api that referenced this pull request Jan 17, 2025
Remove the `ai.languageModel.capabilities()` method and its accompanying `AILanguageModelCapabilities` class. Instead, replace it with:

* `ai.languageModel.availability(options)`, which takes the same options as `ai.languageModel.create()`, and returns the corresponding availability.
* `ai.languageModel.params()`, which returns the default and max params (currently top-K and temperature).

Additionally, add the `expectedInputLanguages` option to `create()` and `availability()`. The addition of this option to `create()` allows the web developer to signal the expected input languages ahead of time, allowing the downloading of additional material, or fast-failing if the additional material cannot be supported. The addition of this option to `availability()` replaces the `(await ai.languageModel.capabilities()).languageAvailable()` method.

Closes #29; see especially #29 (comment).

See also webmachinelearning/writing-assistance-apis#22 and webmachinelearning/translation-api#31.
domenic added a commit to webmachinelearning/translation-api that referenced this pull request Jan 17, 2025
…tector

Add an `expectedInputLanguages` option to language detector creation API. This allows the browser to download relevant material if necessary, or fail-fast if a language the web developer needs to support is not available.

Then, remove the `capabilities()` methods and the accompanying `AI*Capabilities` classes.

* For translator, the only useful capabilities API was `(await ai.translator.capabilities()).languagePairAvailable()`. We simplify this to `await ai.translator.availability()`. This design also avoids the complexity where we have to retrieve all the availability information for every combination of options during the call to `capabilities()`, for later sync access. Now we can just retrieve the relevant information during the call to `availability()`.

  Also, by unifying on using the same options for `create()` and `availability()`, we fix #24.

* For language detector, the capabilities supplied both `(await ai.languageDetector.capabilities()).available` and `(await ai.languageDetector.capabilities()).languageAvailable()`. We simplify this into `await ai.languageDetector.availability()`, which can either take no arguments (emulating `available`) or take the same `{ expectedInputLanguages }` argument as `create()` (emulating `languageAvailable()`).

See also webmachinelearning/writing-assistance-apis#22 and webmachinelearning/prompt-api#69.
aarongable pushed a commit to chromium/chromium that referenced this pull request Feb 5, 2025
Per latest spec change, new `availability()` method will replace
`capabilities()` method, which is planned to be removed after the
heads-up to the OT users.
webmachinelearning/writing-assistance-apis#22

NO_IFTTT=updated

Bug: 390477782
Change-Id: I3ffa50209564a268bb5a611e2eb98dcb174b569e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6197919
Commit-Queue: Daseul Lee <dslee@chromium.org>
Reviewed-by: Mingyu Lei <leimy@chromium.org>
Reviewed-by: Giovanni Ortuno Urquidi <ortuno@chromium.org>
Reviewed-by: Mike Wasserman <msw@chromium.org>
Reviewed-by: Takashi Toyoshima <toyoshim@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1416193}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

General lack of clarity about input/output/context languages
1 participant