Stay organized with collections Save and categorize content based on your preferences.
A query that finds the documents whose vector fields are closest to a certain query vector. Create an instance of VectorQuery
with .
get query(): Query<AppModelType, DbModelType>;
The query whose results participants in the vector search. Filtering performed by the query will apply before the vector search.
Methods _getResponse(explainOptions)_getResponse(explainOptions?: firestore.ExplainOptions): Promise<QueryResponse<VectorQuerySnapshot<AppModelType, DbModelType>>>;
Parameter Name Description explainOptions
firestore.ExplainOptions
Promise<QueryResponse<VectorQuerySnapshot<AppModelType, DbModelType>>>
explain(options)
explain(options?: firestore.ExplainOptions): Promise<ExplainResults<VectorQuerySnapshot<AppModelType, DbModelType>>>;
Plans and optionally executes this vector search query. Returns a Promise that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any).
A Promise that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any).
Parameter Name Descriptionoptions
firestore.ExplainOptions
get(): Promise<VectorQuerySnapshot<AppModelType, DbModelType>>;
Executes this vector search query.
Returns Type DescriptionPromise<VectorQuerySnapshot<AppModelType, DbModelType>>
A promise that will be resolved with the results of the query.
isEqual(other)isEqual(other: firestore.VectorQuery<AppModelType, DbModelType>): boolean;
Compares this object with the given object for equality.
This object is considered "equal" to the other object if and only if other
performs the same vector distance search as this VectorQuery
and the underlying Query of other
compares equal to that of this object using Query.isEqual()
.
other
FirebaseFirestore.VectorQuery<AppModelType, DbModelType>
The object to compare to this object for equality.
Returns Type Descriptionboolean
true
if this object is "equal" to the given object, as defined above, or false
otherwise.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4