The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.
getEntityId
The id of the similar entity.
Returns
Type
Description
string
setEntityId
The id of the similar entity.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDistance
The distance between the neighbor and the query vector.
Returns
Type
Description
float
setDistance
The distance between the neighbor and the query vector.
Parameter
Name
Description
var
float
Returns
Type
Description
$this
getEntityKeyValues
The attributes of the neighbor, e.g. filters, crowding and metadata
Note that full entities are returned only when "return_full_entity"
is set to true. Otherwise, only the "entity_id" and "distance" fields
are populated.
The attributes of the neighbor, e.g. filters, crowding and metadata
Note that full entities are returned only when "return_full_entity"
is set to true. Otherwise, only the "entity_id" and "distance" fields
are populated.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class Neighbor (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.NearestNeighbors.Neighbor)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.NearestNeighbors.Neighbor)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.NearestNeighbors.Neighbor)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.NearestNeighbors.Neighbor)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.NearestNeighbors.Neighbor)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.NearestNeighbors.Neighbor)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.NearestNeighbors.Neighbor)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.NearestNeighbors.Neighbor)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.NearestNeighbors.Neighbor)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.NearestNeighbors.Neighbor)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.NearestNeighbors.Neighbor)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.NearestNeighbors.Neighbor)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.NearestNeighbors.Neighbor)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.NearestNeighbors.Neighbor)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.NearestNeighbors.Neighbor)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.NearestNeighbors.Neighbor)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.NearestNeighbors.Neighbor)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.NearestNeighbors.Neighbor)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.NearestNeighbors.Neighbor)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.NearestNeighbors.Neighbor)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.NearestNeighbors.Neighbor)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.NearestNeighbors.Neighbor)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.NearestNeighbors.Neighbor)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.NearestNeighbors.Neighbor)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.NearestNeighbors.Neighbor)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.NearestNeighbors.Neighbor)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.NearestNeighbors.Neighbor)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.NearestNeighbors.Neighbor)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.NearestNeighbors.Neighbor)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.NearestNeighbors.Neighbor)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.NearestNeighbors.Neighbor)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.NearestNeighbors.Neighbor)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.NearestNeighbors.Neighbor)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.NearestNeighbors.Neighbor)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.NearestNeighbors.Neighbor)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.NearestNeighbors.Neighbor)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.NearestNeighbors.Neighbor)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.NearestNeighbors.Neighbor)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.NearestNeighbors.Neighbor)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.NearestNeighbors.Neighbor)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.NearestNeighbors.Neighbor)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.NearestNeighbors.Neighbor)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.NearestNeighbors.Neighbor)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.NearestNeighbors.Neighbor)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.NearestNeighbors.Neighbor)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.NearestNeighbors.Neighbor)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.NearestNeighbors.Neighbor)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.NearestNeighbors.Neighbor)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.NearestNeighbors.Neighbor)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.NearestNeighbors.Neighbor)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.NearestNeighbors.Neighbor)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.NearestNeighbors.Neighbor)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.NearestNeighbors.Neighbor)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.NearestNeighbors.Neighbor)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.NearestNeighbors.Neighbor)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.NearestNeighbors.Neighbor) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Neighbor.\n\nA neighbor of the query vector.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.NearestNeighbors.Neighbor`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ NearestNeighbors\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEntityId\n\nThe id of the similar entity.\n\n### setEntityId\n\nThe id of the similar entity.\n\n### getDistance\n\nThe distance between the neighbor and the query vector.\n\n### setDistance\n\nThe distance between the neighbor and the query vector.\n\n### getEntityKeyValues\n\nThe attributes of the neighbor, e.g. filters, crowding and metadata\nNote that full entities are returned only when \"return_full_entity\"\nis set to true. Otherwise, only the \"entity_id\" and \"distance\" fields\nare populated.\n\n### hasEntityKeyValues\n\n### clearEntityKeyValues\n\n### setEntityKeyValues\n\nThe attributes of the neighbor, e.g. filters, crowding and metadata\nNote that full entities are returned only when \"return_full_entity\"\nis set to true. Otherwise, only the \"entity_id\" and \"distance\" fields\nare populated."]]
