findNeighbors method

Future<GoogleCloudAiplatformV1FindNeighborsResponse> findNeighbors(
  1. GoogleCloudAiplatformV1FindNeighborsRequest request,
  2. String indexEndpoint, {
  3. String? $fields,
})

Finds the nearest neighbors of each vector within the request.

request - The metadata request object.

Request parameters:

indexEndpoint - Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/indexEndpoints/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudAiplatformV1FindNeighborsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudAiplatformV1FindNeighborsResponse> findNeighbors(
  GoogleCloudAiplatformV1FindNeighborsRequest request,
  core.String indexEndpoint, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$indexEndpoint') + ':findNeighbors';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudAiplatformV1FindNeighborsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}