---
title: "POST /v1/{+featurestore}:batchReadFeatureValues"
method: POST
path: "/v1/{+featurestore}:batchReadFeatureValues"
tags: ["projects"]
---

# POST /v1/{+featurestore}:batchReadFeatureValues

`POST /v1/{+featurestore}:batchReadFeatureValues`

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.

## Path parameters

- `featurestore` string, required

## Request body

- GoogleCloudAiplatformV1BatchReadFeatureValuesRequest — Request message for FeaturestoreService.BatchReadFeatureValues.
  - `startTime` string, google-datetime — Optional. Excludes Feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in Feature Store. Timestamp, if present, must not have higher than millisecond precision.
  - `entityTypeSpecs` GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec[] — Required. Specifies EntityType grouping Features to read values of and settings.
    - `entityTypeId` string — Required. ID of the EntityType to select Features. The EntityType id is the entity_type_id specified during EntityType creation.
    - `featureSelector` GoogleCloudAiplatformV1FeatureSelector — Selector for Features of an EntityType.
      - `idMatcher` GoogleCloudAiplatformV1IdMatcher — Matcher for Features of an EntityType by Feature ID.
        - `ids` string[] — Required. The following are accepted as `ids`: * A single-element list containing only `*`, which selects all Features in the target EntityType, or * A list containing only Feature IDs, which selects only Features with those IDs in the target EntityType.
    - `settings` GoogleCloudAiplatformV1DestinationFeatureSetting[] — Per-Feature settings for the batch read.
      - `featureId` string — Required. The ID of the Feature to apply the setting to.
      - `destinationField` string — Specify the field name in the export destination. If not specified, Feature ID is used.
  - `csvReadInstances` GoogleCloudAiplatformV1CsvSource — The storage details for CSV input content.
    - `gcsSource` GoogleCloudAiplatformV1GcsSource — The Google Cloud Storage location for the input content.
      - `uris` string[] — Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
  - `destination` GoogleCloudAiplatformV1FeatureValueDestination — A destination location for Feature values and format.
    - `bigqueryDestination` GoogleCloudAiplatformV1BigQueryDestination — The BigQuery location for the output content.
      - `outputUri` string — Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
    - `tfrecordDestination` GoogleCloudAiplatformV1TFRecordDestination — The storage details for TFRecord output content.
      - `gcsDestination` GoogleCloudAiplatformV1GcsDestination — The Google Cloud Storage location where the output is to be written to.
        - `outputUriPrefix` string — Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
    - `csvDestination` GoogleCloudAiplatformV1CsvDestination — The storage details for CSV output content.
      - `gcsDestination` GoogleCloudAiplatformV1GcsDestination — The Google Cloud Storage location where the output is to be written to.
        - `outputUriPrefix` string — Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
  - `passThroughFields` GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField[] — 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.
    - `fieldName` string — Required. The name of the field in the CSV header or the name of the column in BigQuery table. The naming restriction is the same as Feature.name.
  - `bigqueryReadInstances` GoogleCloudAiplatformV1BigQuerySource — The BigQuery location for the input content.
    - `inputUri` string — Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/aiplatform.md) · [All operations](https://skmtc.net/google/apis/aiplatform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/aiplatform/versions/b608d71b91f0/schema)