New article "Correct grammar with the Proofreader API" #3647
Conversation
mikehoffms
changed the title
| --- | ||
| # Correct grammar, spelling, and punctuation errors in text with the Proofreader API | ||
| <!-- todo: create the below short link: --> | ||
| <!-- https://aka.ms/edge-proofreader-api-docs --> |
There was a problem hiding this comment.
|
Learn Build status updates of commit ad0744e: ✅ Validation status: passed
For more details, please refer to the build report. |
| <!-- ====================================================================== --> | ||
| ## Availability of the Proofreader API | ||
|
|
||
| The Proofreader API is available as a developer preview in Microsoft Edge Canary or Dev channels, starting with version 143<!-- todo: add the correct version. -->. |
There was a problem hiding this comment.
143? add correct version
| To check if your device supports the Proofreader API developer preview, see [Enable the Proofreader API](#enable-the-proofreader-api) below and check your device performance class. | ||
|
|
||
| Due to the experimental nature of the Proofreader API, you might observe issues on specific hardware configurations. If you see issues on specific hardware configurations, please provide feedback by [opening a new issue](https://github.com/MicrosoftEdge/MSEdgeExplainers/issues/new?template=proofreader-api.md) at the MSEdgeExplainers repository. | ||
| <!-- todo: create the above bug template. --> |
|
|
||
| To use any of the Proofreader API in Microsoft Edge: | ||
|
|
||
| 1. Make sure you're using the latest version of Microsoft Edge Canary or Dev (version 143 <!-- todo add correct version --> or newer). See [Become a Microsoft Edge Insider](https://www.microsoft.com/edge/download/insider). |
There was a problem hiding this comment.
add correct version, 143?
|
|
||
| 1. Select **Enabled** next to the **Proofreader API for Phi mini** flag: | ||
|
|
||
| <!-- todo: populate png --> |
There was a problem hiding this comment.
populate flags-proofreader-api.png
- Correct grammar, spelling, and punctuation errors in text with the Proofreader API > Enable the Proofreader API
|
|
||
| 1. In the information banner at the top, check the status: it initially reads **Model downloading, please wait**: | ||
|
|
||
| <!-- todo: populate png --> |
There was a problem hiding this comment.
populate model-downloading.png
- Correct grammar, spelling, and punctuation errors in text with the Proofreader API > See a working example
|
|
||
| After the model has downloaded, the information banner reads **API and model ready**, indicating that the API and model can be used: | ||
|
|
||
| <!-- todo: populate png --> |
There was a problem hiding this comment.
populate api-and-model-ready.png
- Correct grammar, spelling, and punctuation errors in text with the Proofreader API > See a working example
|
|
||
| The output is generated in the response section of the page: | ||
|
|
||
| <!-- todo: populate png --> |
There was a problem hiding this comment.
populate proofreading.png
- Correct grammar, spelling, and punctuation errors in text with the Proofreader API > See a working example
|
|
||
| We're very interested in learning about the range of scenarios for which you intend to use the Proofreader API, any issues with the API or language model, and whether new task-specific APIs would be useful. | ||
|
|
||
| To send feedback about your scenarios and the tasks you want to achieve, please add a comment to [the Proofreader API feedback issue](https://github.com/MicrosoftEdge/MSEdgeExplainers/issues/XYZ)<!-- todo: create a feedback issue -->. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 748ddd6: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 930fd17: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit b85d41f: ✅ Validation status: passed
For more details, please refer to the build report. |
Rendered article for review:
/web-platform/proofreader-api.mdOther articles
TOC
~/toc.ymlPrompt a built-in language model with the Prompt API
/web-platform/prompt-api.mdSummarize, write, and rewrite text with the Writing Assistance APIs
/web-platform/writing-assistance-apis.mdAB#60242099