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
- (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding) — Optional. The embedding vector that be used for similar search.
#embedding=
def embedding=(value) -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding
Parameter
- value (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding) — Optional. The embedding vector that be used for similar search.
Returns
- (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding) — Optional. The embedding vector that be used for similar search.
#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.
#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.
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.
#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.
#parameters
def parameters() -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters
Returns
- (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters) — Optional. Parameters that can be set to tune query on the fly.
#parameters=
def parameters=(value) -> ::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters
Parameter
- value (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters) — Optional. Parameters that can be set to tune query on the fly.
Returns
- (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters) — Optional. Parameters that can be set to tune query on the fly.
#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
- (::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter>) — Optional. The list of string filters.
#string_filters=
def string_filters=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter>
Parameter
- value (::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter>) — Optional. The list of string filters.
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter>) — Optional. The list of string filters.