Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb
Overview
Represents an experiment in an environment.
Instance Attribute Summary collapse
-
#create_time ⇒ String
Creation time of this experiment.
-
#definition ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentDefinition
Definition of the experiment.
-
#description ⇒ String
The human-readable description of the experiment.
-
#display_name ⇒ String
Required.
-
#end_time ⇒ String
End time of this experiment.
-
#experiment_length ⇒ String
Maximum number of days to run the experiment.
-
#last_update_time ⇒ String
Last update time of this experiment.
-
#name ⇒ String
The name of the experiment.
-
#result ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentResult
The inference result which includes an objective metric to optimize and the confidence interval.
-
#rollout_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RolloutConfig
The configuration for auto rollout.
-
#rollout_failure_reason ⇒ String
The reason why rollout has failed.
-
#rollout_state ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RolloutState
State of the auto-rollout process.
-
#start_time ⇒ String
Start time of this experiment.
-
#state ⇒ String
The current state of the experiment.
-
#variants_history ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1VariantsHistory>
The history of updates to the experiment variants.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Experiment
constructor
A new instance of GoogleCloudDialogflowCxV3beta1Experiment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Experiment
Returns a new instance of GoogleCloudDialogflowCxV3beta1Experiment.
6031 6032 6033 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6031 def initialize(**args) update!(**args) end |
Instance Attribute Details
#create_time ⇒ String
Creation time of this experiment.
Corresponds to the JSON property createTime
5951 5952 5953 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5951 def create_time @create_time end |
#definition ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentDefinition
Definition of the experiment.
Corresponds to the JSON property definition
5956 5957 5958 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5956 def definition @definition end |
#description ⇒ String
The human-readable description of the experiment.
Corresponds to the JSON property description
5961 5962 5963 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5961 def description @description end |
#display_name ⇒ String
Required. The human-readable name of the experiment (unique in an environment).
Limit of 64 characters.
Corresponds to the JSON property displayName
5967 5968 5969 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5967 def display_name @display_name end |
#end_time ⇒ String
End time of this experiment.
Corresponds to the JSON property endTime
5972 5973 5974 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5972 def end_time @end_time end |
#experiment_length ⇒ String
Maximum number of days to run the experiment. If auto-rollout is not enabled,
default value and maximum will be 30 days. If auto-rollout is enabled, default
value and maximum will be 6 days.
Corresponds to the JSON property experimentLength
5979 5980 5981 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5979 def experiment_length @experiment_length end |
#last_update_time ⇒ String
Last update time of this experiment.
Corresponds to the JSON property lastUpdateTime
5984 5985 5986 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5984 def last_update_time @last_update_time end |
#name ⇒ String
The name of the experiment. Format: projects//locations//agents//environments//
experiments/..
Corresponds to the JSON property name
5990 5991 5992 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5990 def name @name end |
#result ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentResult
The inference result which includes an objective metric to optimize and the
confidence interval.
Corresponds to the JSON property result
5996 5997 5998 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5996 def result @result end |
#rollout_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RolloutConfig
The configuration for auto rollout.
Corresponds to the JSON property rolloutConfig
6001 6002 6003 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6001 def rollout_config @rollout_config end |
#rollout_failure_reason ⇒ String
The reason why rollout has failed. Should only be set when state is
ROLLOUT_FAILED.
Corresponds to the JSON property rolloutFailureReason
6007 6008 6009 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6007 def rollout_failure_reason @rollout_failure_reason end |
#rollout_state ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RolloutState
State of the auto-rollout process.
Corresponds to the JSON property rolloutState
6012 6013 6014 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6012 def rollout_state @rollout_state end |
#start_time ⇒ String
Start time of this experiment.
Corresponds to the JSON property startTime
6017 6018 6019 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6017 def start_time @start_time end |
#state ⇒ String
The current state of the experiment. Transition triggered by Experiments.
StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.
CancelExperiment: DRAFT->DONE or RUNNING->DONE.
Corresponds to the JSON property state
6024 6025 6026 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6024 def state @state end |
#variants_history ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1VariantsHistory>
The history of updates to the experiment variants.
Corresponds to the JSON property variantsHistory
6029 6030 6031 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6029 def variants_history @variants_history end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6036 def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @definition = args[:definition] if args.key?(:definition) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @end_time = args[:end_time] if args.key?(:end_time) @experiment_length = args[:experiment_length] if args.key?(:experiment_length) @last_update_time = args[:last_update_time] if args.key?(:last_update_time) @name = args[:name] if args.key?(:name) @result = args[:result] if args.key?(:result) @rollout_config = args[:rollout_config] if args.key?(:rollout_config) @rollout_failure_reason = args[:rollout_failure_reason] if args.key?(:rollout_failure_reason) @rollout_state = args[:rollout_state] if args.key?(:rollout_state) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) @variants_history = args[:variants_history] if args.key?(:variants_history) end |