Google Cloud Ai Platform V1 Client - Class BatchReadFeatureValuesRequest (1.12.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class BatchReadFeatureValuesRequest.

Request message for FeaturestoreService.BatchReadFeatureValues.

Generated from protobuf message google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ csv_read_instances CsvSource

Each read instance consists of exactly one read timestamp and one or more entity IDs identifying entities of the corresponding EntityTypes whose Features are requested. Each output instance contains Feature values of requested entities concatenated together as of the read time. An example read instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z. An example output instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, bar_entity_feature2_value. Timestamp in each read instance must be millisecond-aligned. csv_read_instances are read instances stored in a plain-text CSV file. The header should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The columns can be in any order. Values in the timestamp column must use the RFC 3339 format, e.g. 2012-07-30T10:43:17.123Z.
↳ bigquery_read_instances BigQuerySource

Similar to csv_read_instances, but from BigQuery source.
↳ featurestore string

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

Required. Specifies output location and format.
↳ pass_through_fields array<BatchReadFeatureValuesRequest\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.
↳ entity_type_specs array<BatchReadFeatureValuesRequest\EntityTypeSpec>

Required. Specifies EntityType grouping Features to read values of and settings.
↳ start_time Google\Protobuf\Timestamp

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.

getCsvReadInstances

Each read instance consists of exactly one read timestamp and one or more entity IDs identifying entities of the corresponding EntityTypes whose Features are requested.

Each output instance contains Feature values of requested entities concatenated together as of the read time. An example read instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z. An example output instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, bar_entity_feature2_value. Timestamp in each read instance must be millisecond-aligned. csv_read_instances are read instances stored in a plain-text CSV file. The header should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The columns can be in any order. Values in the timestamp column must use the RFC 3339 format, e.g. 2012-07-30T10:43:17.123Z.

Returns
Type Description
CsvSource|null

hasCsvReadInstances

setCsvReadInstances

Each read instance consists of exactly one read timestamp and one or more entity IDs identifying entities of the corresponding EntityTypes whose Features are requested.

Each output instance contains Feature values of requested entities concatenated together as of the read time. An example read instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z. An example output instance may be foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, bar_entity_feature2_value. Timestamp in each read instance must be millisecond-aligned. csv_read_instances are read instances stored in a plain-text CSV file. The header should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The columns can be in any order. Values in the timestamp column must use the RFC 3339 format, e.g. 2012-07-30T10:43:17.123Z.

Parameter
Name Description
var CsvSource
Returns
Type Description
$this

getBigqueryReadInstances

Similar to csv_read_instances, but from BigQuery source.

Returns
Type Description
BigQuerySource|null

hasBigqueryReadInstances

setBigqueryReadInstances

Similar to csv_read_instances, but from BigQuery source.

Parameter
Name Description
var BigQuerySource
Returns
Type Description
$this

getFeaturestore

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

Returns
Type Description
string

setFeaturestore

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDestination

Required. Specifies output location and format.

Returns
Type Description
FeatureValueDestination|null

hasDestination

clearDestination

setDestination

Required. Specifies output location and format.

Parameter
Name Description
var FeatureValueDestination
Returns
Type Description
$this

getPassThroughFields

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPassThroughFields

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.

Parameter
Name Description
var array<BatchReadFeatureValuesRequest\PassThroughField>
Returns
Type Description
$this

getEntityTypeSpecs

Required. Specifies EntityType grouping Features to read values of and settings.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEntityTypeSpecs

Required. Specifies EntityType grouping Features to read values of and settings.

Parameter
Name Description
var array<BatchReadFeatureValuesRequest\EntityTypeSpec>
Returns
Type Description
$this

getStartTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getReadOption

Returns
Type Description
string

static::build

Parameter
Name Description
featurestore string

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore} Please see FeaturestoreServiceClient::featurestoreName() for help formatting this field.
Returns
Type Description
BatchReadFeatureValuesRequest