FindNeighborsRequest_Query class final
A query to find a number of the nearest neighbors (most similar vectors) of a vector.
- Inheritance
-
- Object
- ProtoMessage
- FindNeighborsRequest_Query
Constructors
- FindNeighborsRequest_Query({FindNeighborsRequest_Query_Rrf? rrf, required IndexDatapoint? datapoint, int neighborCount = 0, int perCrowdingAttributeNeighborCount = 0, int approximateNeighborCount = 0, double fractionLeafNodesToSearchOverride = 0})
- FindNeighborsRequest_Query.fromJson(Object? j)
-
factory
Properties
- approximateNeighborCount → int
-
The number of neighbors to find via approximate search before
exact reordering is performed. If not set, the default value from scam
config is used; if set, this value must be > 0.
final
- datapoint → IndexDatapoint?
-
Required. The datapoint/vector whose nearest neighbors should be searched
for.
final
- fractionLeafNodesToSearchOverride → double
-
The fraction of the number of leaves to search, set at query time allows
user to tune search performance. This value increase result in both
search accuracy and latency increase. The value should be between 0.0
and 1.0. If not set or set to 0.0, query uses the default value specified
in
NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- neighborCount → int
-
The number of nearest neighbors to be retrieved from database for each
query. If not set, will use the default from the service configuration
(https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
final
- perCrowdingAttributeNeighborCount → int
-
Crowding is a constraint on a neighbor list produced by nearest neighbor
search requiring that no more than some value k' of the k neighbors
returned have the same value of crowding_attribute.
It's used for improving result diversity.
This field is the maximum number of matches with the same crowding tag.
final
- qualifiedName → String
-
The fully qualified name of this message, i.e.,
google.protobuf.Durationorgoogle.rpc.ErrorInfo.finalinherited - rrf → FindNeighborsRequest_Query_Rrf?
-
Optional. Represents RRF algorithm that combines search results.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Object -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- fullyQualifiedName → const String