Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest (v0.45.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest.

Request message for FeaturestoreService.BatchReadFeatureValues.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bigquery_read_instances

def bigquery_read_instances() -> ::Google::Cloud::AIPlatform::V1::BigQuerySource
Returns

#bigquery_read_instances=

def bigquery_read_instances=(value) -> ::Google::Cloud::AIPlatform::V1::BigQuerySource
Parameter
Returns

#csv_read_instances

def csv_read_instances() -> ::Google::Cloud::AIPlatform::V1::CsvSource
Returns
  • (::Google::Cloud::AIPlatform::V1::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.

#csv_read_instances=

def csv_read_instances=(value) -> ::Google::Cloud::AIPlatform::V1::CsvSource
Parameter
  • value (::Google::Cloud::AIPlatform::V1::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.

Returns
  • (::Google::Cloud::AIPlatform::V1::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.

#destination

def destination() -> ::Google::Cloud::AIPlatform::V1::FeatureValueDestination
Returns

#destination=

def destination=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureValueDestination
Parameter
Returns

#entity_type_specs

def entity_type_specs() -> ::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::EntityTypeSpec>
Returns

#entity_type_specs=

def entity_type_specs=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::EntityTypeSpec>
Parameter
Returns

#featurestore

def featurestore() -> ::String
Returns
  • (::String) — Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

#featurestore=

def featurestore=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
Returns
  • (::String) — Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

#pass_through_fields

def pass_through_fields() -> ::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::PassThroughField>
Returns
  • (::Array<::Google::Cloud::AIPlatform::V1::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.

#pass_through_fields=

def pass_through_fields=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::PassThroughField>
Parameter
  • value (::Array<::Google::Cloud::AIPlatform::V1::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.

Returns
  • (::Array<::Google::Cloud::AIPlatform::V1::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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.
Returns
  • (::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.