Cloud AI Platform v1 API - Class FindNeighborsRequest.Types.Query (2.27.0)

public sealed class FindNeighborsRequest.Types.Query : IMessage<FindNeighborsRequest.Types.Query>, IEquatable<FindNeighborsRequest.Types.Query>, IDeepCloneable<FindNeighborsRequest.Types.Query>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class FindNeighborsRequest.Types.Query.

A query to find a number of the nearest neighbors (most similar vectors) of a vector.

Inheritance

object > FindNeighborsRequest.Types.Query

Implements

IMessage FindNeighborsRequest Types Query, IEquatable FindNeighborsRequest Types Query, IDeepCloneable FindNeighborsRequest Types Query, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Query()

public Query()

Query(Query)

public Query(FindNeighborsRequest.Types.Query other)

Parameter
Name	Description
`other`	`FindNeighborsRequestTypesQuery`

Properties

ApproximateNeighborCount

public int ApproximateNeighborCount { get; set; }

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.

Property Value
Type	Description
`int`

Datapoint

public IndexDatapoint Datapoint { get; set; }

Required. The datapoint/vector whose nearest neighbors should be searched for.

Property Value
Type	Description
`IndexDatapoint`

FractionLeafNodesToSearchOverride

public double FractionLeafNodesToSearchOverride { get; set; }

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.

Property Value
Type	Description
`double`

NeighborCount

public int NeighborCount { get; set; }

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).

Property Value
Type	Description
`int`

PerCrowdingAttributeNeighborCount

public int PerCrowdingAttributeNeighborCount { get; set; }

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.

Property Value
Type	Description
`int`