Coveo · Schema

Coveo Search RestHighlightResponse

AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

Properties

Name Type Description
length integer The length (in number of characters) of the word to highlight.
offset integer The 0-based index position of the first character of the word to highlight in the string.
View JSON Schema on GitHub

JSON Schema

coveo-search-resthighlightresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-resthighlightresponse-schema.json",
  "title": "Coveo Search RestHighlightResponse",
  "required": [
    "length",
    "offset"
  ],
  "type": "object",
  "properties": {
    "length": {
      "type": "integer",
      "description": "The length (in number of characters) of the word to highlight.",
      "format": "int64",
      "example": 5
    },
    "offset": {
      "type": "integer",
      "description": "The 0-based index position of the first character of the word to highlight in the string.",
      "format": "int64",
      "example": 15
    }
  }
}