Method: projects.locations.featurestores.batchReadFeatureValues

Stay organized with collections Save and categorize content based on your preferences.

Batch reads Feature values from a Featurestore.

This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

HTTP request

POST https://{service-endpoint}/v1beta1/{featurestore}:batchReadFeatureValues

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

Path parameters

Parameters
featurestore

string

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

Request body

The request body contains data with the following structure:

JSON representation
{
  "destination": {
    object (FeatureValueDestination)
  },
  "passThroughFields": [
    {
      object (PassThroughField)
    }
  ],
  "entityTypeSpecs": [
    {
      object (EntityTypeSpec)
    }
  ],
  "startTime": string,

  // Union field read_option can be only one of the following:
  "csvReadInstances": {
    object (CsvSource)
  },
  "bigqueryReadInstances": {
    object (BigQuerySource)
  }
  // End of list of possible types for union field read_option.
}
Fields
destination

object (FeatureValueDestination)

Required. Specifies output location and format.

passThroughFields[]

object (PassThroughField)

When not empty, the specified fields in the *_read_instances source will be joined as-is in the output, in addition to those fields from the Featurestore Entity.

For BigQuery source, the type of the pass-through values will be automatically inferred. For CSV source, the pass-through values will be passed as opaque bytes.

entityTypeSpecs[]