Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NearestNeighborQuery

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

Overview

A query to find a number of similar entities.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1NearestNeighborQuery

Returns a new instance of GoogleCloudAiplatformV1NearestNeighborQuery.



15092
15093
15094
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15092

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

Instance Attribute Details

#embedding ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NearestNeighborQueryEmbedding

The embedding vector. Corresponds to the JSON property embedding

Returns:



15059
15060
15061
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15059

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) 


15065
15066
15067
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15065

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) 


15071
15072
15073
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15071

def neighbor_count
  @neighbor_count
end

#parameters ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NearestNeighborQueryParameters

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

Returns:



15077
15078
15079
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15077

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) 


15085
15086
15087
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15085

def per_crowding_attribute_neighbor_count
  @per_crowding_attribute_neighbor_count
end

#string_filters ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NearestNeighborQueryStringFilter>

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

Returns:



15090
15091
15092
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15090

def string_filters
  @string_filters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15097
15098
15099
15100
15101
15102
15103
15104
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15097

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)
  @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