Parameter | Type | Default | Description |
---|---|---|---|
query_vector | List[float] or np.ndarray | None | Single query vector |
query_vectors | List[List[float]] or np.ndarray | None | Multiple query vectors for batch search |
query_contents | str | None | Text content for semantic search |
top_k | int | 100 | Number of results to return per query |
n_probes | int | 1 | Number of clusters to probe for search |
filters | Dict | None | (Optional) Metadata filters to apply |
include | List[str] | ["distance", "metadata"] | Fields to include in results |
greedy | bool | False | Use greedy search algorithm |
List[List[Dict]]
- List of result lists. For single queries, returns a list with one result list. For batch queries, returns multiple result lists.
Error
Validation Errors
include
parameter contains invalid field names.