GoogleCloudAiplatformV1FindNeighborsRequestQuery

import type { GoogleCloudAiplatformV1FindNeighborsRequestQuery } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

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

interface GoogleCloudAiplatformV1FindNeighborsRequestQuery {

approximateNeighborCount?: number;

datapoint?: GoogleCloudAiplatformV1IndexDatapoint;

fractionLeafNodesToSearchOverride?: number;

neighborCount?: number;

perCrowdingAttributeNeighborCount?: number;

rrf?: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF;

}

§Properties

approximateNeighborCount?: number

[src]

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.

datapoint?: GoogleCloudAiplatformV1IndexDatapoint

[src]

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

fractionLeafNodesToSearchOverride?: number

[src]

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.

neighborCount?: number

[src]

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

perCrowdingAttributeNeighborCount?: number

[src]

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.

rrf?: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF

[src]

Optional. Represents RRF algorithm that combines search results.