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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ feature_view |
string
Required. FeatureView resource format |
↳ query |
Google\Cloud\AIPlatform\V1\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 |
Google\Cloud\AIPlatform\V1\NearestNeighborQuery|null |
|
hasQuery
clearQuery
setQuery
Required. The query.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\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 |
|