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.



4530
4531
4532
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4530

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) 


4450
4451
4452
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4450

def create_time
  @create_time
end

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

Definition of the experiment. Corresponds to the JSON property definition

Returns:



4455
4456
4457
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4455

def definition
  @definition
end

#description ⇒ String

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

Returns:

  • (String) 


4460
4461
4462
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4460

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) 


4466
4467
4468
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4466

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


4471
4472
4473
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4471

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) 


4478
4479
4480
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4478

def experiment_length
  @experiment_length
end

#last_update_time ⇒ String

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

Returns:

  • (String) 


4483
4484
4485
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4483

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) 


4489
4490
4491
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4489

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:



4495
4496
4497
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4495

def result
  @result
end

#rollout_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RolloutConfig

The configuration for auto rollout. Corresponds to the JSON property rolloutConfig

Returns:



4500
4501
4502
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4500

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

Returns:

  • (String) 


4506
4507
4508
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4506

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

Returns:



4511
4512
4513
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4511

def rollout_state
  @rollout_state
end

#start_time ⇒ String

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

Returns:

  • (String) 


4516
4517
4518
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4516

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

Returns:

  • (String) 


4523
4524
4525
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4523

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:



4528
4529
4530
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4528

def variants_history
  @variants_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4535

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