Package com.mongodb.client.model.search
Interface VectorSearchOptions
- All Superinterfaces:
Bson
- All Known Subinterfaces:
ApproximateVectorSearchOptions
,ExactVectorSearchOptions
Represents optional fields of the
$vectorSearch
pipeline stage of an aggregation pipeline.- Since:
- 4.11
- See Also:
- MongoDB Atlas documentation
- $vectorSearch
- Since server release
- 6.0.11
-
Field Summary
Fields inherited from interface org.bson.conversions.Bson
DEFAULT_CODEC_REGISTRY
-
Method Summary
Modifier and TypeMethodDescriptionapproximateVectorSearchOptions
(long numCandidates) ReturnsApproximateVectorSearchOptions
that represents server defaults.static ExactVectorSearchOptions
ReturnsExactVectorSearchOptions
that represents server defaults with theexact
option set to true.Creates a newVectorSearchOptions
with the filter specified.Creates a newVectorSearchOptions
with the specified option in situations when there is no builder method that better satisfies your needs.Methods inherited from interface org.bson.conversions.Bson
toBsonDocument, toBsonDocument
-
Method Details
-
filter
Creates a newVectorSearchOptions
with the filter specified.- Parameters:
filter
- A filter that is applied before applying thequeryVector
One may useFilters
to create this filter, though not all filters may be supported. See the MongoDB documentation for the list of supported filters.- Returns:
- A new
VectorSearchOptions
.
-
option
Creates a newVectorSearchOptions
with the specified option in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.Example
The following code creates two functionally equivalentVectorSearchOptions
objects, though they may not be equal.VectorSearchOptions options1 = VectorSearchOptions.vectorSearchOptions() .filter(Filters.lt("fieldName", 1)); VectorSearchOptions options2 = VectorSearchOptions.vectorSearchOptions() .option("filter", Filters.lt("fieldName", 1));
- Parameters:
name
- The option name.value
- The option value.- Returns:
- A new
VectorSearchOptions
.
-
approximateVectorSearchOptions
ReturnsApproximateVectorSearchOptions
that represents server defaults.- Parameters:
numCandidates
- The number of candidates.- Returns:
ApproximateVectorSearchOptions
that represents server defaults.- Since:
- 5.2
-
exactVectorSearchOptions
ReturnsExactVectorSearchOptions
that represents server defaults with theexact
option set to true.- Returns:
ExactVectorSearchOptions
that represents server defaults.- Since:
- 5.2
-