Class GoogleCloudAiplatformV1FindNeighborsRequestQuery

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

Inheritance

object

GoogleCloudAiplatformV1FindNeighborsRequestQuery

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1FindNeighborsRequestQuery : IDirectResponseSchema

Properties

ApproximateNeighborCount

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.

Declaration

[JsonProperty("approximateNeighborCount")]
public virtual int? ApproximateNeighborCount { get; set; }

Property Value

Type	Description
int?

Datapoint

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

Declaration

[JsonProperty("datapoint")]
public virtual GoogleCloudAiplatformV1IndexDatapoint Datapoint { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1IndexDatapoint

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

FractionLeafNodesToSearchOverride

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.

Declaration

[JsonProperty("fractionLeafNodesToSearchOverride")]
public virtual double? FractionLeafNodesToSearchOverride { get; set; }

Property Value

Type	Description
double?

NeighborCount

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

Declaration

[JsonProperty("neighborCount")]
public virtual int? NeighborCount { get; set; }

Property Value

Type	Description
int?

PerCrowdingAttributeNeighborCount

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.

Declaration

[JsonProperty("perCrowdingAttributeNeighborCount")]
public virtual int? PerCrowdingAttributeNeighborCount { get; set; }

Property Value

Type	Description
int?

Rrf

Optional. Represents RRF algorithm that combines search results.

Declaration

[JsonProperty("rrf")]
public virtual GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF Rrf { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF

Implements

IDirectResponseSchema