Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client (v0.38.0)

Version 0.38.0

• 0.58.0 (latest)
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

Client for the FeaturestoreOnlineServingService service.

A service for serving online feature values.

Inherits

• Object

Includes

• Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the FeaturestoreOnlineServingService Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all FeaturestoreOnlineServingService clients
::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the FeaturestoreOnlineServingService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

• (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new FeaturestoreOnlineServingService client object.

Yields

• (config) — Configure the FeaturestoreOnlineServingService client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

• (Google::Cloud::Location::Locations::Client)

#read_feature_values

def read_feature_values(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse
def read_feature_values(entity_type: nil, entity_id: nil, feature_selector: nil) -> ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Overloads

def read_feature_values(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse

Pass arguments to read_feature_values via a request object, either of type ReadFeatureValuesRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def read_feature_values(entity_type: nil, entity_id: nil, feature_selector: nil) -> ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse

Pass arguments to read_feature_values via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• entity_type (::String) — Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.
• entity_id (::String) — Required. ID for a specific entity. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.
• feature_selector (::Google::Cloud::AIPlatform::V1::FeatureSelector, ::Hash) — Required. Selector choosing Features of the target EntityType.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest.new

# Call the read_feature_values method.
result = client.read_feature_values request

# The returned object is of type Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse.
p result

#streaming_read_feature_values

def streaming_read_feature_values(request, options = nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>
def streaming_read_feature_values(entity_type: nil, entity_ids: nil, feature_selector: nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Overloads

def streaming_read_feature_values(request, options = nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>

Pass arguments to streaming_read_feature_values via a request object, either of type StreamingReadFeatureValuesRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::StreamingReadFeatureValuesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def streaming_read_feature_values(entity_type: nil, entity_ids: nil, feature_selector: nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>

Pass arguments to streaming_read_feature_values via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• entity_type (::String) — Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.
• entity_ids (::Array<::String>) — Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.
• feature_selector (::Google::Cloud::AIPlatform::V1::FeatureSelector, ::Hash) — Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::StreamingReadFeatureValuesRequest.new

# Call the streaming_read_feature_values method to start streaming.
output = client.streaming_read_feature_values request

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse
output.each do |current_response|
  p current_response
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#write_feature_values

def write_feature_values(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse
def write_feature_values(entity_type: nil, payloads: nil) -> ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Overloads

def write_feature_values(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse

Pass arguments to write_feature_values via a request object, either of type WriteFeatureValuesRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::WriteFeatureValuesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def write_feature_values(entity_type: nil, payloads: nil) -> ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse

Pass arguments to write_feature_values via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• entity_type (::String) — Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ \\{featurestore}/entityTypes/\\{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.
• payloads (::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload, ::Hash>) — Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::WriteFeatureValuesRequest.new

# Call the write_feature_values method.
result = client.write_feature_values request

# The returned object is of type Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse.
p result