Class: Google::Cloud::Retail::V2::ExperimentInfo

Inherits:

Object

Object
Google::Cloud::Retail::V2::ExperimentInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/retail/v2/search_service.rb

Overview

Metadata for active A/B testing [Experiment][].

Defined Under Namespace

Classes: ServingConfigExperiment

Instance Attribute Summary collapse

#experiment ⇒ ::String
The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist.
#serving_config_experiment ⇒ ::Google::Cloud::Retail::V2::ExperimentInfo::ServingConfigExperiment
A/B test between existing Cloud Retail Search ServingConfigs.

Instance Attribute Details

#experiment ⇒ `::String`

Returns The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: projects/*/locations/global/catalogs/default_catalog/experiments/experiment_id.

Returns:

(::String) —
The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: projects/*/locations/global/catalogs/default_catalog/experiments/experiment_id

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1187

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

  # Metadata for active serving config A/B tests.
  # @!attribute [rw] original_serving_config
  #   @return [::String]
  #     The fully qualified resource name of the original
  #     {::Google::Cloud::Retail::V2::SearchRequest#placement SearchRequest.placement}
  #     in the search request prior to reassignment by experiment API. For
  #     example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.
  # @!attribute [rw] experiment_serving_config
  #   @return [::String]
  #     The fully qualified resource name of the serving config
  #     [Experiment.VariantArm.serving_config_id][] responsible for generating
  #     the search response. For example:
  #     `projects/*/locations/*/catalogs/*/servingConfigs/*`.
  class ServingConfigExperiment
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#serving_config_experiment ⇒ `::Google::Cloud::Retail::V2::ExperimentInfo::ServingConfigExperiment`

Returns A/B test between existing Cloud Retail Search ServingConfigs.