Away 12:15 AM

1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

SpellCheckerResult — toolbox-service/v1

The result of spell checker.

Properties

NameTypeRequiredDescription
correctionStatefalseThe state of spell correction: Toolbox.Service.CorrectionState
correctedQuerystringfalseThe spell corrected query if available.
userQuerystringfalseThe user query that originated the correction.

Complete Schema

{
  "type": "object",
  "properties": {
    "correctionState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CorrectionState"
        }
      ],
      "description": "The state of spell correction: Toolbox.Service.CorrectionState",
      "x-enumNames": [
        "NoCorrection",
        "CorrectionAvailable",
        "CorrectionAccepted"
      ],
      "x-enum-varnames": [
        "NoCorrection",
        "CorrectionAvailable",
        "CorrectionAccepted"
      ],
      "x-enum-descriptions": [
        "NoCorrection",
        "CorrectionAvailable",
        "CorrectionAccepted"
      ]
    },
    "correctedQuery": {
      "type": "string",
      "description": "The spell corrected query if available.",
      "nullable": true
    },
    "userQuery": {
      "type": "string",
      "description": "The user query that originated the correction.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "The result of spell checker.",
  "nullable": true
}