semanticSearch
Run direct vector similarity search over records whose property is indexed with createEmbeddingIndex. Deprecated alias for vectorSearch; use vectorSearch for new integrations.
Instructions
Deprecated alias for vectorSearch. Performs direct vector similarity search over records whose propertyName has been indexed with createEmbeddingIndex. Prefer vectorSearch for new integrations. For natural-language schema-aware querying, use smartSearch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ef | No | ANN gather breadth when the search runs on the ANN graph. | |
| mode | No | How to rank candidates. "auto" (default): exact on small indexes, the ANN graph on large ones. "exact"/"ann" force a path ("ann" needs a cosine index). | |
| skip | No | Number of results to skip for pagination (default 0). | |
| limit | No | Maximum number of results to return (default 10). | |
| query | No | Free-text query to embed and compare against stored vectors (managed indexes only). Mutually exclusive with queryVector. | |
| where | No | Optional filter applied before scoring (activates prefilter mode). | |
| labels | Yes | One or more record labels to scope the search. The first label is used to resolve the embedding index. | |
| dimensions | No | Disambiguates when multiple indexes share the same label+property. Inferred from queryVector length when queryVector is supplied. | |
| sourceType | No | Select which index type to search. Required when both managed and external indexes exist for the same label+property. | |
| queryVector | No | Pre-computed embedding vector to search with (external indexes). Mutually exclusive with query. Length must match index dimensions. | |
| propertyName | Yes | Name of the indexed property to search against. | |
| scoreThreshold | No | Keep only results scoring at least this much (scores depend on the embedding model). | |
| similarityFunction | No | Disambiguates when multiple indexes share the same label+property+sourceType. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| total | Yes |