Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FindNeighborsRequest.
The request message for MatchService.FindNeighbors.
Generated from protobuf message google.cloud.aiplatform.v1.FindNeighborsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index_endpoint |
string
Required. The name of the index endpoint. Format: |
↳ deployed_index_id |
string
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. |
↳ queries |
array<Google\Cloud\AIPlatform\V1\FindNeighborsRequest\Query>
The list of queries. |
↳ return_full_datapoint |
bool
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. |
getIndexEndpoint
Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
| Returns | |
|---|---|
| Type | Description |
string | |
setIndexEndpoint
Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeployedIndexId
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setDeployedIndexId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueries
The list of queries.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setQueries
The list of queries.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\FindNeighborsRequest\Query>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReturnFullDatapoint
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.
| Returns | |
|---|---|
| Type | Description |
bool | |
setReturnFullDatapoint
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |