Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Experiment

Returns a new instance of GoogleCloudDialogflowCxV3beta1Experiment.



3351
3352
3353
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3351

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Creation time of this experiment. Corresponds to the JSON property createTime

Returns:

  • (String) 


3287
3288
3289
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3287

def create_time
  @create_time
end

#definition ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentDefinition

Definition of the experiment. Corresponds to the JSON property definition

Returns:



3292
3293
3294
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3292

def definition
  @definition
end

#description ⇒ String

The human-readable description of the experiment. Corresponds to the JSON property description

Returns:

  • (String) 


3297
3298
3299
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3297

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

Returns:

  • (String) 


3303
3304
3305
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3303

def display_name
  @display_name
end

#end_time ⇒ String

End time of this experiment. Corresponds to the JSON property endTime

Returns:

  • (String) 


3308
3309
3310
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3308

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

Returns:

  • (String) 


3315
3316
3317
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3315

def experiment_length
  @experiment_length
end

#last_update_time ⇒ String

Last update time of this experiment. Corresponds to the JSON property lastUpdateTime

Returns:

  • (String) 


3320
3321
3322
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3320

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

Returns:

  • (String) 


3326
3327
3328
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3326

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

Returns:



3332
3333
3334
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3332

def result
  @result
end

#start_time ⇒ String

Start time of this experiment. Corresponds to the JSON property startTime

Returns:

  • (String) 


3337
3338
3339
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3337

def start_time
  @start_time
end

#state ⇒ String

The current state of the experiment. Transition triggered by Expriments. StartExperiment: PENDING->RUNNING. Transition triggered by Expriments. CancelExperiment: PENDING->CANCELLED or RUNNING->CANCELLED. Corresponds to the JSON property state

Returns:

  • (String) 


3344
3345
3346
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3344

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

Returns:



3349
3350
3351
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3349

def variants_history
  @variants_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3356

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)
  @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