- 1.18.0 (latest)
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
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
Namespace
Google \ Cloud \ AIPlatform \ V1 \ FindNeighborsResponseMethods
__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 dense embedding query. |
↳ sparse_distance |
float
The distance between the neighbor and the query sparse_embedding. |
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 dense embedding query.
| Returns | |
|---|---|
| Type | Description |
float |
|
setDistance
The distance between the neighbor and the dense embedding query.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSparseDistance
The distance between the neighbor and the query sparse_embedding.
| Returns | |
|---|---|
| Type | Description |
float |
|
setSparseDistance
The distance between the neighbor and the query sparse_embedding.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|