Google Cloud Ai Platform V1 Client - Class SearchNearestEntitiesRequest (1.12.0)

Version latest

• 1.12.0 (latest)
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SearchNearestEntitiesRequest.

The request message for FeatureOnlineStoreService.SearchNearestEntities.

Generated from protobuf message google.cloud.aiplatform.v1.SearchNearestEntitiesRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ feature_view	string Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
↳ query	NearestNeighborQuery Required. The query.
↳ return_full_entity	bool 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.

getFeatureView

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

Returns
Type	Description
string

setFeatureView

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getQuery

Required. The query.

Returns
Type	Description
NearestNeighborQuery|null

hasQuery

clearQuery

setQuery

Required. The query.

Parameter
Name	Description
var	NearestNeighborQuery

Returns
Type	Description
$this

getReturnFullEntity

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
Type	Description
bool

setReturnFullEntity

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this