- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 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 FindNeighborsRequest.
The request message for MatchService.FindNeighbors .
Generated from protobuf message google.cloud.aiplatform.v1.FindNeighborsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ index_endpoint
string
Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
↳ 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
↳ 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}
string
setIndexEndpoint
Required. The name of the index endpoint.
Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
var
string
$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.
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.
var
string
$this
getQueries
The list of queries.
setQueries
The list of queries.
$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.
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.
var
bool
$this
