From 550a356607a442fd25484a7722d81acc51d0acf1 Mon Sep 17 00:00:00 2001 From: Michael Landis Date: Wed, 10 Jan 2024 17:35:12 -0800 Subject: [PATCH] chore: document score threshold in mvi search Adds documentation for the `scoreThreshold` MVI search parameter. --- docs/vector-index/develop/api-reference/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/vector-index/develop/api-reference/index.md b/docs/vector-index/develop/api-reference/index.md index 3837137e3..a2c687ebf 100644 --- a/docs/vector-index/develop/api-reference/index.md +++ b/docs/vector-index/develop/api-reference/index.md @@ -115,6 +115,7 @@ Searches for items with vectors most similar to a query vector. | queryVector | number[] | Vector to search for. | | topK | number | Number of results to return. Defaults to 10. | | metadataFields | String[] or ALL_VECTOR_METADATA | A list of metadata fields to return with each result, or a value indicating all metadata should be returned. If not provided, no metadata is returned. Defaults to None. | +| scoreThreshold | number | A score threshold to filter results by. The threshold is exclusive. Defaults to no threshold (all results are returned). |
Method response object @@ -143,6 +144,7 @@ Searches for items with vectors most similar to a query vector. Also returns cor | queryVector | number[] | Vector to search for. | | topK | number | Number of results to return. Defaults to 10. | | metadataFields | String[] or ALL_VECTOR_METADATA | A list of metadata fields to return with each result, or a value indicating all metadata should be returned. If not provided, no metadata is returned. Defaults to None. | +| scoreThreshold | number | A score threshold to filter results by. The threshold is exclusive. Defaults to no threshold (all results are returned). |
Method response object