v1

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

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

post/v1/{+featureView}:searchNearestEntities

Path parameters

featureViewstring required

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

Request body

returnFullEntityboolean

Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.

Response

Successful response