Method: projects.locations.featurestores.entityTypes.readFeatureValues

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use entityTypes.streamingReadFeatureValues.

HTTP request

POST https://{service-endpoint}/v1beta1/{entityType}:readFeatureValues

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
entityType

string

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

Request body

The request body contains data with the following structure:

JSON representation
{
  "entityId": string,
  "featureSelector": {
    object (FeatureSelector)
  }
}
Fields
entityId

string

Required. ID for a specific entity. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

featureSelector

object (FeatureSelector)

Required. Selector choosing Features of the target EntityType.

Response body

If successful, the response body contains an instance of ReadFeatureValuesResponse.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the entityType resource:

  • aiplatform.entityTypes.readFeatureValues

For more information, see the IAM documentation.