Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Neighbor.
A neighbor of the query vector.
Generated from protobuf message google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ datapoint |
Google\Cloud\AIPlatform\V1\IndexDatapoint
The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated. |
↳ distance |
float
The distance between the neighbor and the query vector. |
getDatapoint
The datapoint of the neighbor.
Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\IndexDatapoint|null | |
hasDatapoint
clearDatapoint
setDatapoint
The datapoint of the neighbor.
Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\IndexDatapoint
|
| 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 | |