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.



18155
18156
18157
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18155

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

Instance Attribute Details

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

The embedding vector. Corresponds to the JSON property embedding

Returns:



18117
18118
18119
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18117

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) 


18123
18124
18125
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18123

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) 


18129
18130
18131
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18129

def neighbor_count
  @neighbor_count
end

#numeric_filters ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter>

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

Returns:



18134
18135
18136
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18134

def numeric_filters
  @numeric_filters
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:



18140
18141
18142
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18140

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) 


18148
18149
18150
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18148

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:



18153
18154
18155
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18153

def string_filters
  @string_filters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18160
18161
18162
18163
18164
18165
18166
18167
18168
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18160

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