NearestNeighborQuery class final
A query to find a number of similar entities.
- Inheritance
-
- Object
- ProtoMessage
- NearestNeighborQuery
Constructors
-
NearestNeighborQuery({String? entityId, NearestNeighborQuery_Embedding? embedding, int neighborCount = 0, List<
NearestNeighborQuery_StringFilter> stringFilters = const [], List<NearestNeighborQuery_NumericFilter> numericFilters = const [], int perCrowdingAttributeNeighborCount = 0, NearestNeighborQuery_Parameters? parameters}) - NearestNeighborQuery.fromJson(Object? j)
-
factory
Properties
- embedding → NearestNeighborQuery_Embedding?
-
Optional. The embedding vector that be used for similar search.
final
- entityId → String?
-
Optional. The entity id whose similar entities should be searched for.
If embedding is set, search will use embedding instead of
entity_id.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- neighborCount → int
-
Optional. The number of similar entities to be retrieved from feature view
for each query.
final
-
numericFilters
→ List<
NearestNeighborQuery_NumericFilter> -
Optional. The list of numeric filters.
final
- parameters → NearestNeighborQuery_Parameters?
-
Optional. Parameters that can be set to tune query on the fly.
final
- perCrowdingAttributeNeighborCount → int
-
Optional. Crowding is a constraint on a neighbor list produced by nearest
neighbor search requiring that no more than
sper_crowding_attribute_neighbor_count of the k neighbors returned have the
same value of crowding_attribute. It's used for improving result diversity.
final
- qualifiedName → String
-
The fully qualified name of this message, i.e.,
google.protobuf.Durationorgoogle.rpc.ErrorInfo.finalinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stringFilters
→ List<
NearestNeighborQuery_StringFilter> -
Optional. The list of string filters.
final
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