Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: document score threshold in mvi search #614

Merged
merged 1 commit into from
Jan 11, 2024
Merged

chore: document score threshold in mvi search #614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/vector-index/develop/api-reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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). |

<details>
<summary>Method response object</summary>
Expand Down Expand Up @@ -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). |

<details>
<summary>Method response object</summary>
Expand Down
Loading