Post v1+indexendpoint:findneighbors — aiplatform

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB

projects

Finds the nearest neighbors of each vector within the request.

post/v1/{+indexEndpoint}:findNeighbors

Path parameters

indexEndpointstring required

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Request body

returnFullDatapointboolean

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.

deployedIndexIdstring

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.

Response

Successful response