Recommendations AI API - Module Google::Cloud::RecommendationEngine (v0.2.3)

Reference documentation and code samples for the Recommendations AI API module Google::Cloud::RecommendationEngine.

Methods

.catalog_service

def self.catalog_service(version: :v1beta1, &block) -> CatalogService::Client

Create a new client object for CatalogService.

By default, this returns an instance of Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client for version V1beta1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the CatalogService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About CatalogService

Service for ingesting catalog information of the customer's website.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional. Defaults to :v1beta1.
Returns
  • (CatalogService::Client) — A client object for the specified version.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-recommendation_engine library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.recommendation_engine)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.prediction_api_key_registry

def self.prediction_api_key_registry(version: :v1beta1, &block) -> PredictionApiKeyRegistry::Client

Create a new client object for PredictionApiKeyRegistry.

By default, this returns an instance of Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Client for version V1beta1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the PredictionApiKeyRegistry service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About PredictionApiKeyRegistry

Service for registering API keys for use with the predict method. If you use an API key to request predictions, you must first register the API key. Otherwise, your prediction request is rejected. If you use OAuth to authenticate your predict method call, you do not need to register an API key. You can register up to 20 API keys per project.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional. Defaults to :v1beta1.
Returns
  • (PredictionApiKeyRegistry::Client) — A client object for the specified version.

.prediction_service

def self.prediction_service(version: :v1beta1, &block) -> PredictionService::Client

Create a new client object for PredictionService.

By default, this returns an instance of Google::Cloud::RecommendationEngine::V1beta1::PredictionService::Client for version V1beta1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the PredictionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About PredictionService

Service for making recommendation prediction.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional. Defaults to :v1beta1.
Returns
  • (PredictionService::Client) — A client object for the specified version.

.user_event_service

def self.user_event_service(version: :v1beta1, &block) -> UserEventService::Client

Create a new client object for UserEventService.

By default, this returns an instance of Google::Cloud::RecommendationEngine::V1beta1::UserEventService::Client for version V1beta1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the UserEventService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About UserEventService

Service for ingesting end user actions on the customer website.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional. Defaults to :v1beta1.
Returns
  • (UserEventService::Client) — A client object for the specified version.

Constants

VERSION

value: "0.2.3"