File: proofreader.idl

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (91 lines) | stat: -rw-r--r-- 2,694 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyright 2025 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// https://github.com/explainers-by-googlers/proofreader-api

enum CorrectionType {
  "spelling", // Misspelled words, i.e. typos.
  "punctuation", // Incorrect or missing punctuation marks.
  "capitalization", // Incorrect upper/lowercase letters.
  "preposition", // Errors in the use of prepositions.
  "missing-words", // One or more words are absent from a sentence,
                   // making it grammatically incorrect or altering
                   // its intended meaning.
  "grammar" // Broad and catch-all category, if no more-specific category
            // matches. Encompassing sentence errors in structure
            // errors, word order, subject-verb agreement, etc.
};

dictionary ProofreaderCreateCoreOptions {
  boolean includeCorrectionTypes = false;
  boolean includeCorrectionExplanations = false;
  sequence<DOMString> expectedInputLanguages;
  DOMString correctionExplanationLanguage;
};

dictionary ProofreaderCreateOptions : ProofreaderCreateCoreOptions {
  AbortSignal signal;
  CreateMonitorCallback monitor;
};

dictionary ProofreadResult {
  DOMString correctedInput;
  sequence<ProofreadCorrection> corrections;
};

dictionary ProofreadCorrection {
  unsigned long long startIndex;
  unsigned long long endIndex;
  DOMString correction;
  CorrectionType type;
  DOMString explanation;
};

[
  Exposed=(Window,Worker),
  RuntimeEnabled=AIProofreadingAPI,
  SecureContext
]
interface Proofreader {
  [
    MeasureAs=Proofreader_Availability,
    CallWith=ScriptState,
    RaisesException
  ]
  static Promise<Availability> availability(
    optional ProofreaderCreateCoreOptions options = {}
  );

  [
    MeasureAs=Proofreader_Create,
    CallWith=ScriptState,
    RaisesException
  ]
  static Promise<Proofreader> create(optional ProofreaderCreateOptions options = {});

  [
    MeasureAs=Proofreader_Proofread,
    CallWith=ScriptState,
    RaisesException
  ]
  Promise<ProofreadResult> proofread(
    DOMString input
  );

  [
    MeasureAs=Proofreader_Destroy,
    CallWith=ScriptState,
    RaisesException
  ]
  void destroy();

  [MeasureAs=Proofreader_IncludeCorrectionTypes]
  readonly attribute boolean includeCorrectionTypes;
  [MeasureAs=Proofreader_IncludeCorrectionExplanations]
  readonly attribute boolean includeCorrectionExplanations;
  [MeasureAs=Proofreader_ExpectedInputLanguages]
  readonly attribute FrozenArray<DOMString>? expectedInputLanguages;
  [MeasureAs=Proofreader_CorrectionExplanationLanguage]
  readonly attribute DOMString? correctionExplanationLanguage;
};