Package com.google.cloud.aiplatform.v1

Interface FindNeighborsResponse.NeighborOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FindNeighborsResponse.Neighbor, FindNeighborsResponse.Neighbor.Builder
Enclosing class:
FindNeighborsResponse
public static interface FindNeighborsResponse.NeighborOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    IndexDatapoint
    getDatapoint()
    The datapoint of the neighbor.
    IndexDatapointOrBuilder
    getDatapointOrBuilder()
    The datapoint of the neighbor.
    double
    getDistance()
    The distance between the neighbor and the dense embedding query.
    double
    getSparseDistance()
    The distance between the neighbor and the query sparse_embedding.
    boolean
    hasDatapoint()
    The datapoint of the neighbor.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasDatapoint

      boolean hasDatapoint()
       The datapoint of the neighbor.
 Note that full datapoints are returned only when "return_full_datapoint"
 is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
 fields are populated.
      .google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;
      Returns:
      Whether the datapoint field is set.

    • getDatapoint

      IndexDatapoint getDatapoint()
       The datapoint of the neighbor.
 Note that full datapoints are returned only when "return_full_datapoint"
 is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
 fields are populated.
      .google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;
      Returns:
      The datapoint.

    • getDatapointOrBuilder

      IndexDatapointOrBuilder getDatapointOrBuilder()
       The datapoint of the neighbor.
 Note that full datapoints are returned only when "return_full_datapoint"
 is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
 fields are populated.
      .google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

    • getDistance

      double getDistance()
       The distance between the neighbor and the dense embedding query.
      double distance = 2;
      Returns:
      The distance.

    • getSparseDistance

      double getSparseDistance()
       The distance between the neighbor and the query sparse_embedding.
      double sparse_distance = 3;
      Returns:
      The sparseDistance.