Class FindNeighborsRequest (1.83.0) 

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_v1.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.