- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
FindNeighborsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for MatchService.FindNeighbors.
Attributes |
|
---|---|
Name | Description |
index_endpoint |
str
Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
|
deployed_index_id |
str
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 |
MutableSequence[google.cloud.aiplatform_v1beta1.types.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. |
Classes
Query
Query(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A query to find a number of the nearest neighbors (most similar vectors) of a vector.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Methods
FindNeighborsRequest
FindNeighborsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for MatchService.FindNeighbors.