autocompleteRequest

Object containing the data for performing an autocomplete search.

SearchFull-Text SearchVector SearchElasticsearch CompatibleOpen SourceDatabase

Properties

Name	Type	Description
table	string	The table to perform the search on
query	string	The beginning of the string to autocomplete
options	object	Autocomplete options - layouts: A comma-separated string of keyboard layout codes to validate and check for spell correction. Available options - us, ru, ua, se, pt, no, it, gr, uk, fr, es, dk, de, ch

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/manticore/main/json-schema/autocompleteRequest.json",
  "title": "autocompleteRequest",
  "description": "Object containing the data for performing an autocomplete search.",
  "type": "object",
  "required": [
    "table",
    "query"
  ],
  "properties": {
    "table": {
      "type": "string",
      "description": "The table to perform the search on"
    },
    "query": {
      "type": "string",
      "description": "The beginning of the string to autocomplete"
    },
    "options": {
      "type": "object",
      "description": "Autocomplete options\n  - layouts: A comma-separated string of keyboard layout codes to validate and check for spell correction. Available options - us, ru, ua, se, pt, no, it, gr, uk, fr, es, dk, de, ch, br, bg, be. By default, all are enabled.\n  - fuzziness: (0,1 or 2) Maximum Levenshtein distance for finding typos. Set to 0 to disable fuzzy matching. Default is 2\n  - prepend: true/false If true, adds an asterisk before the last word for prefix expansion (e.g., *word )\n  - append:  true/false If true, adds an asterisk after the last word for prefix expansion (e.g., word* )\n  - expansion_len: Number of characters to expand in the last word. Default is 10.\n",
      "additionalProperties": true
    }
  },
  "example": {
    "table": "test",
    "query": "Start",
    "options": {
      "layouts": "us,uk",
      "fuzziness": 0
    }
  }
}