Retail API - Module Google::Cloud::Retail (v1.10.0)

Reference documentation and code samples for the Retail API module Google::Cloud::Retail.

Methods

.analytics_service

def self.analytics_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for AnalyticsService.

By default, this returns an instance of Google::Cloud::Retail::V2::AnalyticsService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the AnalyticsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About AnalyticsService

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.catalog_service

def self.catalog_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for CatalogService.

By default, this returns an instance of Google::Cloud::Retail::V2::CatalogService::Client for a gRPC client for version V2 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About CatalogService

Service for managing catalog configuration.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.completion_service

def self.completion_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for CompletionService.

By default, this returns an instance of Google::Cloud::Retail::V2::CompletionService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the CompletionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About CompletionService

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.configure

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

Configure the google-cloud-retail 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 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.retail)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.control_service

def self.control_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for ControlService.

By default, this returns an instance of Google::Cloud::Retail::V2::ControlService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ControlService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ControlService

Service for modifying Control.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.generative_question_service

def self.generative_question_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for GenerativeQuestionService.

By default, this returns an instance of Google::Cloud::Retail::V2::GenerativeQuestionService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the GenerativeQuestionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About GenerativeQuestionService

Service for managing LLM generated questions in search serving.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.model_service

def self.model_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for ModelService.

By default, this returns an instance of Google::Cloud::Retail::V2::ModelService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ModelService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ModelService

Service for performing CRUD operations on models. Recommendation models contain all the metadata necessary to generate a set of models for the Predict() API. A model is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g. Frequently Bought Together on Home Page).

This service allows you to do the following:

  • Initiate training of a model.
  • Pause training of an existing model.
  • List all the available models along with their metadata.
  • Control their tuning schedule.
Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.prediction_service

def self.prediction_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for PredictionService.

By default, this returns an instance of Google::Cloud::Retail::V2::PredictionService::Client for a gRPC client for version V2 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About PredictionService

Service for making recommendation prediction.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.product_service

def self.product_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for ProductService.

By default, this returns an instance of Google::Cloud::Retail::V2::ProductService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ProductService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ProductService

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

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.search_service

def self.search_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for SearchService.

By default, this returns an instance of Google::Cloud::Retail::V2::SearchService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the SearchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About SearchService

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.serving_config_service

def self.serving_config_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for ServingConfigService.

By default, this returns an instance of Google::Cloud::Retail::V2::ServingConfigService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ServingConfigService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About ServingConfigService

Service for modifying ServingConfig.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.user_event_service

def self.user_event_service(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for UserEventService.

By default, this returns an instance of Google::Cloud::Retail::V2::UserEventService::Client for a gRPC client for version V2 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About UserEventService

Service for ingesting end user actions on the customer website.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

Constants

VERSION

value: "1.10.0"