Cloud AI Platform v1 API - Class SearchNearestEntitiesRequest (2.26.0) 

public sealed class SearchNearestEntitiesRequest : IMessage<SearchNearestEntitiesRequest>, IEquatable<SearchNearestEntitiesRequest>, IDeepCloneable<SearchNearestEntitiesRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class SearchNearestEntitiesRequest.

The request message for [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities].

Inheritance

object > SearchNearestEntitiesRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

SearchNearestEntitiesRequest()

public SearchNearestEntitiesRequest()

SearchNearestEntitiesRequest(SearchNearestEntitiesRequest)

public SearchNearestEntitiesRequest(SearchNearestEntitiesRequest other)
Parameter
NameDescription
otherSearchNearestEntitiesRequest

Properties

FeatureView

public string FeatureView { get; set; }

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

Property Value
TypeDescription
string

FeatureViewAsFeatureViewName

public FeatureViewName FeatureViewAsFeatureViewName { get; set; }

FeatureViewName-typed view over the FeatureView resource name property.

Property Value
TypeDescription
FeatureViewName

Query

public NearestNeighborQuery Query { get; set; }

Required. The query.

Property Value
TypeDescription
NearestNeighborQuery

ReturnFullEntity

public bool ReturnFullEntity { get; set; }

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.

Property Value
TypeDescription
bool