Typesense · Schema

SearchHighlight

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name	Type	Description
field	string	Name of the highlighted field.
snippet	string	Highlighted snippet of the field value.
snippets	array	Array of highlighted snippets for array fields.
value	string	Full highlighted field value.
values	array	Full highlighted values for array fields.
matched_tokens	array	Tokens in the field that matched the query.
indices	array	Indices of matched values in array fields.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchHighlight",
  "title": "SearchHighlight",
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "Name of the highlighted field."
    },
    "snippet": {
      "type": "string",
      "description": "Highlighted snippet of the field value."
    },
    "snippets": {
      "type": "array",
      "description": "Array of highlighted snippets for array fields.",
      "items": {
        "type": "string"
      }
    },
    "value": {
      "type": "string",
      "description": "Full highlighted field value."
    },
    "values": {
      "type": "array",
      "description": "Full highlighted values for array fields.",
      "items": {
        "type": "string"
      }
    },
    "matched_tokens": {
      "type": "array",
      "description": "Tokens in the field that matched the query.",
      "items": {}
    },
    "indices": {
      "type": "array",
      "description": "Indices of matched values in array fields.",
      "items": {
        "type": "integer"
      }
    }
  }
}