Typesense · Schema

VectorCollectionSchema

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name Type Description
name string Name of the collection.
fields array Field definitions including vector embedding fields.
default_sorting_field string Default field for sorting results.
enable_nested_fields boolean Whether to enable indexing of nested object fields.
View JSON Schema on GitHub

JSON Schema

typesense-vectorcollectionschema-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VectorCollectionSchema",
  "title": "VectorCollectionSchema",
  "type": "object",
  "required": [
    "name",
    "fields"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the collection."
    },
    "fields": {
      "type": "array",
      "description": "Field definitions including vector embedding fields.",
      "items": {
        "$ref": "#/components/schemas/VectorField"
      }
    },
    "default_sorting_field": {
      "type": "string",
      "description": "Default field for sorting results."
    },
    "enable_nested_fields": {
      "type": "boolean",
      "description": "Whether to enable indexing of nested object fields."
    }
  }
}