Method: projects.locations.featurestores.entityTypes.streamingReadFeatureValues

Reads feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

HTTP request

POST https://{service-endpoint}/v1/{entityType}:streamingReadFeatureValues

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

Path parameters

Parameters
entityType

string

Required. The resource name of the entities' type. 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
{
  "entityIds": [
    string
  ],
  "featureSelector": {
    object (FeatureSelector)
  }
}
Fields
entityIds[]

string

Required. IDs of entities to read feature values of. The maximum number of IDs is 100. 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. feature IDs will be deduplicated.

Response body

If successful, the response body contains a stream of ReadFeatureValuesResponse instances.

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.streamingReadFeatureValues

For more information, see the IAM documentation.