FindNeighborsRequest class final
The request message for
MatchService.FindNeighbors.
- Inheritance
-
- Object
- ProtoMessage
- FindNeighborsRequest
Constructors
-
FindNeighborsRequest({required String indexEndpoint, String deployedIndexId = '', List<
FindNeighborsRequest_Query> queries = const [], bool returnFullDatapoint = false}) - FindNeighborsRequest.fromJson(Object? j)
-
factory
Properties
- deployedIndexId → String
-
The ID of the DeployedIndex that will serve the request. This request is
sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
has a DeployedIndex.id field.
The value of the field below must equal one of the DeployedIndex.id
fields of the IndexEndpoint that is being called for this request.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- indexEndpoint → String
-
Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}final - qualifiedName → String
-
The fully qualified name of this message, i.e.,
google.protobuf.Durationorgoogle.rpc.ErrorInfo.finalinherited -
queries
→ List<
FindNeighborsRequest_Query> -
The list of queries.
final
- returnFullDatapoint → bool
-
If set to true, the full datapoints (including all vector values and
restricts) of the nearest neighbors are returned.
Note that returning full datapoint will significantly increase the
latency and cost of the query.
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