Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NearestNeighborQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

A query to find a number of similar entities.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1NearestNeighborQuery

Returns a new instance of GoogleCloudAiplatformV1beta1NearestNeighborQuery.



36238
36239
36240
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36238

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#embedding ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding

The embedding vector. Corresponds to the JSON property embedding

Returns:



36200
36201
36202
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36200

def embedding
  @embedding
end

#entity_id ⇒ String

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id. Corresponds to the JSON property entityId

Returns:

  • (String) 


36206
36207
36208
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36206

def entity_id
  @entity_id
end

#neighbor_count ⇒ Fixnum

Optional. The number of similar entities to be retrieved from feature view for each query. Corresponds to the JSON property neighborCount

Returns:

  • (Fixnum) 


36212
36213
36214
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36212

def neighbor_count
  @neighbor_count
end

#numeric_filters ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter>

Optional. The list of numeric filters. Corresponds to the JSON property numericFilters

Returns:



36217
36218
36219
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36217

def numeric_filters
  @numeric_filters
end

#parameters ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters

Parameters that can be overrided in each query to tune query latency and recall. Corresponds to the JSON property parameters

Returns:



36223
36224
36225
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36223

def parameters
  @parameters
end

#per_crowding_attribute_neighbor_count ⇒ Fixnum

Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. Corresponds to the JSON property perCrowdingAttributeNeighborCount

Returns:

  • (Fixnum) 


36231
36232
36233
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36231

def per_crowding_attribute_neighbor_count
  @per_crowding_attribute_neighbor_count
end

#string_filters ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter>

Optional. The list of string filters. Corresponds to the JSON property stringFilters

Returns:



36236
36237
36238
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36236

def string_filters
  @string_filters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36243
36244
36245
36246
36247
36248
36249
36250
36251
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36243

def update!(**args)
  @embedding = args[:embedding] if args.key?(:embedding)
  @entity_id = args[:entity_id] if args.key?(:entity_id)
  @neighbor_count = args[:neighbor_count] if args.key?(:neighbor_count)
  @numeric_filters = args[:numeric_filters] if args.key?(:numeric_filters)
  @parameters = args[:parameters] if args.key?(:parameters)
  @per_crowding_attribute_neighbor_count = args[:per_crowding_attribute_neighbor_count] if args.key?(:per_crowding_attribute_neighbor_count)
  @string_filters = args[:string_filters] if args.key?(:string_filters)
end