Send feedback
Method: googleapis.aiplatform.v1.projects.locations.featureOnlineStores.featureViews.searchNearestEntities
Stay organized with collections
Save and categorize content based on your preferences.
Preview
This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section
of the Service Specific Terms .
Pre-GA features are available "as is" and might have limited support.
For more information, see the
launch stage descriptions .
Search the nearest entities under a FeatureView. Search only works for
indexable feature view; if a feature view isn't indexable, returns
Invalid argument response.
Arguments
Parameters
featureView
string
Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
region
string
Required. Region of the HTTP endpoint. For example, if region is set to us-central1
, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints .
body
object (GoogleCloudAiplatformV1SearchNearestEntitiesRequest )
Required.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of GoogleCloudAiplatformV1SearchNearestEntitiesResponse
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation .
YAML
- searchNearestEntities :
call : googleapis.aiplatform.v1.projects.locations.featureOnlineStores.featureViews.searchNearestEntities
args :
featureView : ...
region : ...
body :
query :
embedding :
value : ...
entityId : ...
neighborCount : ...
parameters :
approximateNeighborCandidates : ...
leafNodesSearchFraction : ...
perCrowdingAttributeNeighborCount : ...
stringFilters : ...
returnFullEntity : ...
result : searchNearestEntitiesResult
JSON
[
{
"searchNearestEntities" : {
"call" : "googleapis.aiplatform.v1.projects.locations.featureOnlineStores.featureViews.searchNearestEntities" ,
"args" : {
"featureView" : "..." ,
"region" : "..." ,
"body" : {
"query" : {
"embedding" : {
"value" : "..."
},
"entityId" : "..." ,
"neighborCount" : "..." ,
"parameters" : {
"approximateNeighborCandidates" : "..." ,
"leafNodesSearchFraction" : "..."
},
"perCrowdingAttributeNeighborCount" : "..." ,
"stringFilters" : "..."
},
"returnFullEntity" : "..."
}
},
"result" : "searchNearestEntitiesResult"
}
}
]
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-01 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-10-01 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-01 UTC."]]