Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::SearchNearestEntitiesRequest (v0.57.0)

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

The request message for FeatureOnlineStoreService.SearchNearestEntities.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#feature_view

def feature_view() -> ::String
Returns
  • (::String) — Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

#feature_view=

def feature_view=(value) -> ::String
Parameter
  • value (::String) — Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
Returns
  • (::String) — Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

#query

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

#query=

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

#return_full_entity

def return_full_entity() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.

#return_full_entity=

def return_full_entity=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.
Returns
  • (::Boolean) — Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.