Typesense · Schema

CollectionUpdateSchema

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name	Type	Description
fields	array	Array of field definitions to add, modify, or drop.
synonym_sets	array	Updated list of synonym set names for this collection.
metadata	object	Updated metadata for the collection.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CollectionUpdateSchema",
  "title": "CollectionUpdateSchema",
  "type": "object",
  "properties": {
    "fields": {
      "type": "array",
      "description": "Array of field definitions to add, modify, or drop.",
      "items": {
        "$ref": "#/components/schemas/Field"
      }
    },
    "synonym_sets": {
      "type": "array",
      "description": "Updated list of synonym set names for this collection.",
      "items": {
        "type": "string"
      }
    },
    "metadata": {
      "type": "object",
      "description": "Updated metadata for the collection."
    }
  }
}