Typesense · Schema

VectorMultiSearchParameters

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name Type Description
collection string Name of the collection to search.
q string Text search query. Use * for pure vector search.
query_by string Fields to search for keyword matching.
vector_query string Vector query for nearest-neighbor search.
filter_by string Filter conditions.
sort_by string Sort conditions.
page integer Page number.
per_page integer Results per page.
View JSON Schema on GitHub

JSON Schema

typesense-vectormultisearchparameters-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VectorMultiSearchParameters",
  "title": "VectorMultiSearchParameters",
  "type": "object",
  "required": [
    "collection"
  ],
  "properties": {
    "collection": {
      "type": "string",
      "description": "Name of the collection to search."
    },
    "q": {
      "type": "string",
      "description": "Text search query. Use * for pure vector search."
    },
    "query_by": {
      "type": "string",
      "description": "Fields to search for keyword matching."
    },
    "vector_query": {
      "type": "string",
      "description": "Vector query for nearest-neighbor search."
    },
    "filter_by": {
      "type": "string",
      "description": "Filter conditions."
    },
    "sort_by": {
      "type": "string",
      "description": "Sort conditions."
    },
    "page": {
      "type": "integer",
      "description": "Page number."
    },
    "per_page": {
      "type": "integer",
      "description": "Results per page."
    }
  }
}