Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client (v0.39.0)

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

Client for the FeatureOnlineStoreService service.

A service for fetching feature values from the online store.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the FeatureOnlineStoreService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all FeatureOnlineStoreService clients
::Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the FeatureOnlineStoreService 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
Returns

#fetch_feature_values

def fetch_feature_values(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse
def fetch_feature_values(feature_view: nil, data_key: nil, data_format: nil) -> ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse

Fetch feature values under a FeatureView.

Overloads 
def fetch_feature_values(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse
Pass arguments to fetch_feature_values via a request object, either of type Google::Cloud::AIPlatform::V1::FetchFeatureValuesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::FetchFeatureValuesRequest, ::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 fetch_feature_values(feature_view: nil, data_key: nil, data_format: nil) -> ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse
Pass arguments to fetch_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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::FeatureOnlineStoreService::Client.new

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

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

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

#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 FeatureOnlineStoreService client object.

Yields
  • (config) — Configure the FeatureOnlineStoreService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::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)

#search_nearest_entities

def search_nearest_entities(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse
def search_nearest_entities(feature_view: nil, query: nil, return_full_entity: nil) -> ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Overloads 
def search_nearest_entities(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse
Pass arguments to search_nearest_entities via a request object, either of type SearchNearestEntitiesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesRequest, ::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 search_nearest_entities(feature_view: nil, query: nil, return_full_entity: nil) -> ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse
Pass arguments to search_nearest_entities 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
  • feature_view (::String) — Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
  • query (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery, ::Hash) — Required. The query.
  • return_full_entity (::Boolean) — Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::FeatureOnlineStoreService::Client.new

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

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)