Class: Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb

Overview

Request message for FeaturestoreService.BatchReadFeatureValues.

Defined Under Namespace

Classes: EntityTypeSpec, PassThroughField

Instance Attribute Summary collapse

Instance Attribute Details

#bigquery_read_instances ⇒ ::Google::Cloud::AIPlatform::V1::BigQuerySource

Returns Similar to csv_read_instances, but from BigQuery source.

Note: The following fields are mutually exclusive: bigquery_read_instances, csv_read_instances. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::BigQuerySource) —

    Similar to csv_read_instances, but from BigQuery source.

    Note: The following fields are mutually exclusive: bigquery_read_instances, csv_read_instances. If a field in that set is populated, all other fields in the set will automatically be cleared.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#csv_read_instances ⇒ ::Google::Cloud::AIPlatform::V1::CsvSource

Returns 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.

Note: The following fields are mutually exclusive: csv_read_instances, bigquery_read_instances. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: csv_read_instances, bigquery_read_instances. If a field in that set is populated, all other fields in the set will automatically be cleared.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#destination ⇒ ::Google::Cloud::AIPlatform::V1::FeatureValueDestination

Returns Required. Specifies output location and format.

Returns:



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#entity_type_specs ⇒ ::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::EntityTypeSpec>

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

Returns:



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#featurestore ⇒ ::String

Returns 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}



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pass_through_fields ⇒ ::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::PassThroughField>

Returns 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.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 336

class BatchReadFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describe pass-through fields in read_instance source.
  # @!attribute [rw] field_name
  #   @return [::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
  #     {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
  class PassThroughField
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Selects Features of an EntityType to read values of and specifies read
  # settings.
  # @!attribute [rw] entity_type_id
  #   @return [::String]
  #     Required. ID of the EntityType to select Features. The EntityType id is
  #     the
  #     {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
  #     specified during EntityType creation.
  # @!attribute [rw] feature_selector
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
  #     Required. Selectors choosing which Feature values to read from the
  #     EntityType.
  # @!attribute [rw] settings
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
  #     Per-Feature settings for the batch read.
  class EntityTypeSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end