Package com.mongodb.client.model.search

Interface VectorSearchOptions

All Superinterfaces:
Bson
All Known Subinterfaces:
ApproximateVectorSearchOptions, ExactVectorSearchOptions
@Sealed public interface VectorSearchOptions extends Bson
Represents optional fields of the $vectorSearch pipeline stage of an aggregation pipeline.

This includes options for searching against nested (embedded) embeddings and arrays of embeddings, via parentFilter(Bson) and nestedOptions(VectorSearchNestedOptions).

Since:
4.11
See Also:
MongoDB Atlas documentation
$vectorSearch
Since server release
6.0.11

  • Method Details

    • filter

      VectorSearchOptions filter(Bson filter)
      Creates a new VectorSearchOptions with the filter specified.
      Parameters:
      filter - A filter that is applied before applying the queryVector One may use Filters 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.

    • parentFilter

      VectorSearchOptions parentFilter(Bson parentFilter)
      Creates a new VectorSearchOptions with the parent filter specified.

      Applies only when searching against a nested (embedded) field: this filter is applied to the parent (root) documents, while filter(Bson) is applied to the leaf (embedded) documents. For a non-nested search, use filter(Bson) instead.

      Unlike some other MongoDB drivers, the Java driver does not automatically re-route a top-level filter(Bson) to parentFilter based on the path: you must call parentFilter(Bson) explicitly to specify a parent (root-level) filter for a nested search.

      Parameters:
      parentFilter - A filter applied to the parent documents of a nested $vectorSearch. One may use Filters 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.
      Since:
      5.10
      MongoDB Atlas documentation
      $vectorSearch
      Since server release
      8.3

    • nestedOptions

      VectorSearchOptions nestedOptions(VectorSearchNestedOptions nestedOptions)
      Creates a new VectorSearchOptions with the nestedOptions specified.

      Applies only when searching against arrays of embeddings within nested (embedded) documents; for example it controls how the scores of the individual matching embeddings within a document are aggregated (see VectorSearchNestedOptions.scoreMode(VectorSearchScoreMode)).

      Parameters:
      nestedOptions - The options for a nested (embedded) $vectorSearch.
      Returns:
      A new VectorSearchOptions.
      Since:
      5.10
      MongoDB Atlas documentation
      $vectorSearch
      Since server release
      8.3

    • returnStoredSource

      VectorSearchOptions returnStoredSource(boolean returnStoredSource)
      Creates a new VectorSearchOptions that instructs to return only stored source fields.
      Parameters:
      returnStoredSource - The option to return only stored source fields.
      Returns:
      A new VectorSearchOptions.
      Since:
      5.8
      MongoDB Atlas documentation
      $vectorSearch

    • option

      VectorSearchOptions option(String name, Object value)
      Creates a new VectorSearchOptions 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 equivalent VectorSearchOptions 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

      static ApproximateVectorSearchOptions approximateVectorSearchOptions(long numCandidates)
      Returns ApproximateVectorSearchOptions that represents server defaults.
      Parameters:
      numCandidates - The number of candidates.
      Returns:
      ApproximateVectorSearchOptions that represents server defaults.
      Since:
      5.2

    • exactVectorSearchOptions

      static ExactVectorSearchOptions exactVectorSearchOptions()
      Returns ExactVectorSearchOptions that represents server defaults with the exact option set to true.
      Returns:
      ExactVectorSearchOptions that represents server defaults.
      Since:
      5.2