Class BatchReadFeatureValuesRequest (1.17.0)

Version 1.17.0

• 1.85.0 (latest)
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.0
• 1.75.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.1
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

BatchReadFeatureValuesRequest(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Request message for FeaturestoreService.BatchReadFeatureValues.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
csv_read_instances	google.cloud.aiplatform_v1beta1.types.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``. This field is a member of `oneof`_ ``read_option``.
bigquery_read_instances	google.cloud.aiplatform_v1beta1.types.BigQuerySource Similar to csv_read_instances, but from BigQuery source. This field is a member of `oneof`_ ``read_option``.
featurestore	str Required. The resource name of the Featurestore from which to query Feature values. Format: ``projects/{project}/locations/{location}/featurestores/{featurestore}``
destination	google.cloud.aiplatform_v1beta1.types.FeatureValueDestination Required. Specifies output location and format.
pass_through_fields	Sequence[google.cloud.aiplatform_v1beta1.types.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	Sequence[google.cloud.aiplatform_v1beta1.types.BatchReadFeatureValuesRequest.EntityTypeSpec] Required. Specifies EntityType grouping Features to read values of and settings. Each EntityType referenced in [BatchReadFeatureValuesRequest.entity_type_specs] must have a column specifying entity IDs in the EntityType in [BatchReadFeatureValuesRequest.request][] .

Inheritance

builtins.object > proto.message.Message > BatchReadFeatureValuesRequest

Classes

EntityTypeSpec

EntityTypeSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Selects Features of an EntityType to read values of and specifies read settings.

PassThroughField

PassThroughField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describe pass-through fields in read_instance source.