You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 25, 2026. It is now read-only.
Enhance vector search API reference documentation (#226)
- Add detailed parameter descriptions for VectorSearchParams
- Include multiple practical examples showing different use cases
- Document parameter constraints and valid ranges
- Update return value description to match current interface
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: jhaynie@agentuity.com <jhaynie@gmail.com>
Copy file name to clipboardExpand all lines: content/SDKs/javascript/api-reference.mdx
+24-7Lines changed: 24 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -218,26 +218,43 @@ Searches for vectors in the vector storage.
218
218
##### Parameters
219
219
220
220
-`name`: The name of the vector storage
221
-
-`params`: Search parameters including query, limit, similarity threshold, and metadata filters
221
+
-`params`: Search parameters object with the following properties:
222
+
-`query` (string, required): The text query to search for. This will be converted to embeddings and used to find semantically similar documents.
223
+
-`limit` (number, optional): Maximum number of search results to return. Must be a positive integer. If not specified, the server default will be used.
224
+
-`similarity` (number, optional): Minimum similarity threshold for results (0.0-1.0). Only vectors with similarity scores greater than or equal to this value will be returned. 1.0 means exact match, 0.0 means no similarity requirement.
225
+
-`metadata` (object, optional): Metadata filters to apply to the search. Only vectors whose metadata matches all specified key-value pairs will be included in results. Must be a valid JSON object.
222
226
223
227
##### Return Value
224
228
225
-
Returns a Promise that resolves to an array of search results, each containing an ID, metadata, and distance score.
229
+
Returns a Promise that resolves to an array of search results, each containing an ID, key, metadata, and similarity score.
0 commit comments