Typesense · Schema

VectorField

Full-Text SearchOpen-SourceSearch EnginesTypo ToleranceVector Search

Properties

Name Type Description
name string Name of the field.
type string Data type. Use float[] for vector embedding fields.
optional boolean Whether this field is optional.
facet boolean Whether this field can be used for faceting.
index boolean Whether this field should be indexed.
num_dim integer Number of dimensions for vector fields. Required for float[] type fields used as embeddings.
vec_dist string Distance metric for nearest-neighbor search.
embed object
View JSON Schema on GitHub

JSON Schema

typesense-vectorfield-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VectorField",
  "title": "VectorField",
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the field."
    },
    "type": {
      "type": "string",
      "description": "Data type. Use float[] for vector embedding fields."
    },
    "optional": {
      "type": "boolean",
      "description": "Whether this field is optional."
    },
    "facet": {
      "type": "boolean",
      "description": "Whether this field can be used for faceting."
    },
    "index": {
      "type": "boolean",
      "description": "Whether this field should be indexed."
    },
    "num_dim": {
      "type": "integer",
      "description": "Number of dimensions for vector fields. Required for float[] type fields used as embeddings."
    },
    "vec_dist": {
      "type": "string",
      "description": "Distance metric for nearest-neighbor search.",
      "enum": [
        "cosine",
        "ip"
      ]
    },
    "embed": {
      "$ref": "#/components/schemas/EmbedConfig"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/typesense-vectorfield"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.