Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NearestNeighborQuery (v1.27.0)

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

A query to find a number of similar entities.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#embedding

def embedding() -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding
Returns

#embedding=

def embedding=(value) -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding
Parameter
Returns

#entity_id

def entity_id() -> ::String
Returns
  • (::String) — Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

    Note: The following fields are mutually exclusive: entity_id, embedding. If a field in that set is populated, all other fields in the set will automatically be cleared.

#entity_id=

def entity_id=(value) -> ::String
Parameter
  • value (::String) — Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

    Note: The following fields are mutually exclusive: entity_id, embedding. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

    Note: The following fields are mutually exclusive: entity_id, embedding. If a field in that set is populated, all other fields in the set will automatically be cleared.

#neighbor_count

def neighbor_count() -> ::Integer
Returns
  • (::Integer) — Optional. The number of similar entities to be retrieved from feature view for each query.

#neighbor_count=

def neighbor_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of similar entities to be retrieved from feature view for each query.
Returns
  • (::Integer) — Optional. The number of similar entities to be retrieved from feature view for each query.

#numeric_filters

def numeric_filters() -> ::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::NumericFilter>
Returns

#numeric_filters=

def numeric_filters=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::NumericFilter>
Parameter
Returns

#parameters

def parameters() -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters
Returns

#parameters=

def parameters=(value) -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters
Parameter
Returns

#per_crowding_attribute_neighbor_count

def per_crowding_attribute_neighbor_count() -> ::Integer
Returns
  • (::Integer) — 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.

#per_crowding_attribute_neighbor_count=

def per_crowding_attribute_neighbor_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#string_filters

def string_filters() -> ::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter>
Returns

#string_filters=

def string_filters=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter>
Parameter
Returns