Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FindNeighborsResponse::Neighbor (v0.57.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::FindNeighborsResponse::Neighbor.

A neighbor of the query vector.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#datapoint

def datapoint() -> ::Google::Cloud::AIPlatform::V1::IndexDatapoint
Returns
  • (::Google::Cloud::AIPlatform::V1::IndexDatapoint) — 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.

#datapoint=

def datapoint=(value) -> ::Google::Cloud::AIPlatform::V1::IndexDatapoint
Parameter
  • value (::Google::Cloud::AIPlatform::V1::IndexDatapoint) — 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.
Returns
  • (::Google::Cloud::AIPlatform::V1::IndexDatapoint) — 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.

#distance

def distance() -> ::Float
Returns
  • (::Float) — The distance between the neighbor and the dense embedding query.

#distance=

def distance=(value) -> ::Float
Parameter
  • value (::Float) — The distance between the neighbor and the dense embedding query.
Returns
  • (::Float) — The distance between the neighbor and the dense embedding query.

#sparse_distance

def sparse_distance() -> ::Float
Returns
  • (::Float) — The distance between the neighbor and the query sparse_embedding.

#sparse_distance=

def sparse_distance=(value) -> ::Float
Parameter
  • value (::Float) — The distance between the neighbor and the query sparse_embedding.
Returns
  • (::Float) — The distance between the neighbor and the query sparse_embedding.