Coveo · JSON Structure

Coveo Search Restquerycorrection Structure

Type: Properties: 0
AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

RestQueryCorrection is a JSON Structure definition published by Coveo.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "RestQueryCorrection",
  "structure": {
    "type": "object",
    "required": [
      "correctedQuery",
      "wordCorrections"
    ],
    "properties": {
      "correctedQuery": {
        "type": "string",
        "description": "The resulting query expression correction suggestion."
      },
      "wordCorrections": {
        "type": "array",
        "description": "The word correction suggestions.",
        "items": {
          "type": "object",
          "required": [
            "correctedWord",
            "length",
            "offset",
            "originalWord"
          ],
          "properties": {
            "offset": {
              "type": "integer",
              "format": "int32",
              "description": "The offset (in number of characters) of the corrected word, from the beginning of the resulting query expression correction suggestion."
            },
            "length": {
              "type": "integer",
              "format": "int32",
              "description": "The length (in number of characters) of the corrected word."
            },
            "originalWord": {
              "type": "string",
              "description": "The original, un-corrected word."
            },
            "correctedWord": {
              "type": "string",
              "description": "The suggested word correction."
            }
          }
        }
      }
    }
  }
}