Parameters
Parameter | Type | Default | Description |
---|---|---|---|
query_vectors | List[List[float]] or List[float] or np.ndarray | None | (Optional) Multiple query vectors for batch search |
query_contents | str | None | (Optional) Text content for semantic search |
top_k | int | 100 | (Optional) Number of results to return per query |
n_probes | int | None | (Optional) Number of clusters to probe for search |
filters | Dict | None | (Optional) Metadata filters to apply |
include | List[str] | ["distance", "metadata"] | (Optional) Fields to include in results |
greedy | bool | False | (Optional) Use greedy search algorithm |
Returns
For single queries:List[Dict]
- A list of result dictionaries.
For batch queries: List[List[Dict]]
- A list of result lists, one for each query vector.
Result Format
Exceptions
Error
Error
- Throws if the API request fails due to network connectivity issues.
- Throws if authentication fails (invalid API key).
- Throws if the encryption key is invalid for the specified index.
- Throws if there are internal server errors during the search.
Validation Errors
Validation Errors
- Throws if query vectors or query contents is not provided.
- Throws if vector dimensions don’t match the index configuration.
- Throws if parameter values are out of valid ranges.
- Throws if the
include
parameter contains invalid field names.