Error Categories
Error categories are returned as part of the Edits API. They provide additional classification and detail on the types of edits that Sapling suggests. These categories can be used for analysis, reporting, or coaching purposes.
General Categories
- Grammar
- Spelling
- Punctuation
- Fluency/Style
- Other
Subcategories
Error subcategories are represented in 2 or or more components separated by a colon. The first part is a single letter, M
, R
, or U
. This indicates if error is because something is missing (M), needs replacement (R), or is unnecessary (U).
M
: MissingR
: ReplacementU
: Unnecessary
The second or optional third part of the error marks the error subcategory. If an error is a result of a Custom Mapping, an additional :CUST
suffix is added.
PART
: ParticlePUNCT
: PunctuationORTH
: OrthographySPELL
: SpellingWO
: Word OrderMORPH
: Word FormADV
: AdverbCONTR
: ContractionCONJ
: ConjunctionDET
: DeterminerDET:ART
: ArticlePREP
: PrepositionPRON
: PronounVERB
: VerbVERB:FORM
: Verb FormVERB:TENSE
: Verb TenseVERB:SVA
: Subject-Verb AgreementVERB:INFL
: Verb InflectionADJ
: AdjectiveADJ:FORM
: Adjective FormNOUN
: NounNOUN:POSS
: Noun PossessiveNOUN:INFL
: Noun InflectionNOUN:NUM
: Noun NumberOTHER
: Other
Descriptions / Examples
For your application, it may be helpful to include brief descriptions and examples for the error category codes:
M:PART
: Missing particle. Example: "Look the definition." is missing the particle 'up' as in "Look up the definition."M:PUNCT
: Missing punctuation. Example: "Its raining" is missing an apostrophe.M:CONJ
: Missing conjunction. Example: "I like tea coffee" is missing the conjunction 'and'.M:DET
: Missing determiner. Example: "There are just a exceptions" is missing the determiner 'few'.M:DET:ART
: Missing article. Example: "I saw elephant" is missing the article 'an'.M:PREP
: Missing preposition. Example: "I went the store" is missing the preposition 'to'.M:PRON
: Missing pronoun. Example: "She said that liked the movie." is missing the pronoun 'she'.M:VERB
: Missing verb. Example: "I to the park" is missing the verb 'went'.M:ADJ
: Missing adjective. Example: "It is a brand car" is missing the adjective 'new'.M:NOUN
: Missing noun. Example: "The is on the table" is missing the noun 'book'.M:NOUN:POSS
: Missing possessive noun. Example: "That is John car" is missing the possessive form "John's".M:OTHER
: Missing other elements. Example: NAR:PART
: Incorrect particle. Example: "He is interested for that" should have 'for' replaced with 'in'.R:PUNCT
: Incorrect punctuation. Example: "How are you today." should end with a question mark instead of a period.R:ORTH
: Incorrect orthography. Example: "I like readin" should have 'readin' spelled as 'reading'.R:SPELL
: Incorrect spelling. Example: "I like chokolate" should have 'chokolate' spelled as 'chocolate'.R:WO
: Incorrect word order. Example: "I the book read" should be rearranged to "I read the book."R:MORPH
: Incorrect word form. Example: "It is danger" should be "It is dangerous".R:ADV
: Incorrect adverb. Example: "She plays tennis good" should have 'good' replaced with 'well'.R:CONTR
: Incorrect contraction. Example: "I'm not have time" should have 'I'm not have' replaced with "I don't have."R:CONJ
: Incorrect conjunction. Example: "Neither sea or air" should have 'or' replaced with 'nor'.R:DET
: Incorrect determiner. Example: "I like this shoes" should instead be "I like these shoes."R:DET:ART
: Incorrect article. Example: "I saw a elephant" should have 'a' replaced with 'an'.R:PREP
: Incorrect preposition. Example: "I am in work" should have 'in' replaced with 'at'.R:PRON
: Incorrect pronoun. Example: "The group told us us will be there." should have 'us' replaced with 'they'.R:VERB:FORM
: Incorrect verb form. Example: "He is walk to the store" should have 'walk' replaced with 'walking'.R:VERB:TENSE
: Incorrect verb tense. Example: "I go to the park yesterday" should have 'go' replaced with 'went'.R:VERB:SVA
: Incorrect subject-verb agreement. Example: "They likes ice cream" should have 'likes' replaced with 'like'.R:ADJ:FORM
: Incorrect adjective form. Example: "She is much happiest than me" should have 'happiest' replaced with 'happier'.R:NOUN:INFL
: Incorrect noun inflection. Example: "I have two childs" should have 'childs' replaced with 'children'.R:NOUN:NUM
: Incorrect noun number. Example: "I have a cars" should have 'a cars' replaced with 'a car'.R:OTHER
: Replacement of phrase not easily categorized into a grammatical category. Example: In "He go store", 'go' should be replaced with 'goes to the'.U:PART
: Unnecessary particle. Example: "She knocked out on the door." has an unnecessary 'out'.U:PUNCT
: Unnecessary punctuation. Example: "It's my friend's, bag" has an unnecessary comma.U:ADV
: Unnecessary adverb. Example: "She ran fast fast" has an unnecessary 'fast'.U:CONTR
: Unnecessary contraction. Example: "I'm am ready." has an unnecessary contraction "'m".U:CONJ
: Unnecessary conjunction. Example: "I like tea and and coffee" has an unnecessary 'and'.U:DET
: Unnecessary determiner. Example: "I saw your your cat" has an unnecessary 'your'.U:DET:ART
: Unnecessary article. Example: "I saw the an elephant" has an unnecessary 'an'.U:PREP
: Unnecessary preposition. Example: "I am at in home" has an unnecessary 'in'.U:PRON
: Unnecessary pronoun. Example: "He he likes dogs" has an unnecessary 'he'.U:VERB
: Unnecessary verb. Example: "I went go to the park yesterday" has an unnecessary 'go'.U:ADJ
: Unnecessary adjective. Example: "She is more happier than me" has an unnecessary 'more'.U:NOUN
: Unnecessary noun. Example: "The dog dog is on the table" has an unnecessary 'dog'.U:NOUN:POSS
: Unnecessary possessive noun. Example: "That is John's 's car" has an unnecessary 's'.U:OTHER
: Unnecessary text. Example: NA
As a more complete example, for the edit mapping The cat in hat
to The cat in the hat
, the error type would be M:DET
(missing determiner, in this case: the
).
{
"edits": [
{
"general_error_type": "Grammar",
"error_type": "M:DET:ART",
"id": "c73ce00c-7f3f-5759-b3be-4630cc81afed",
"sentence_start": 0,
"sentence": "The cat in hat",
"replacement": "the hat",
"start": 11,
"end": 14
}
]
}