Class: Google::Cloud::AIPlatform::V1::FindNeighborsResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/match_service.rb

Overview

The response message for MatchService.FindNeighbors.

Defined Under Namespace

Classes: NearestNeighbors, Neighbor

Instance Attribute Summary collapse

Instance Attribute Details

#nearest_neighbors ⇒ ::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsResponse::NearestNeighbors>

Returns The nearest neighbors of the query datapoints.

Returns:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 108

class FindNeighborsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A neighbor of the query vector.
  # @!attribute [rw] datapoint
  #   @return [::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.
  # @!attribute [rw] distance
  #   @return [::Float]
  #     The distance between the neighbor and the dense embedding query.
  # @!attribute [rw] sparse_distance
  #   @return [::Float]
  #     The distance between the neighbor and the query sparse_embedding.
  class Neighbor
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Nearest neighbors for one query.
  # @!attribute [rw] id
  #   @return [::String]
  #     The ID of the query datapoint.
  # @!attribute [rw] neighbors
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsResponse::Neighbor>]
  #     All its neighbors.
  class NearestNeighbors
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end