Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

Represents an experiment in an environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Experiment

Returns a new instance of GoogleCloudDialogflowCxV3Experiment.



1032
1033
1034
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1032

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) 


968
969
970
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 968

def create_time
  @create_time
end

#definition ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExperimentDefinition

Definition of the experiment. Corresponds to the JSON property definition

Returns:



973
974
975
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 973

def definition
  @definition
end

#description ⇒ String

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

Returns:

  • (String) 


978
979
980
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 978

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) 


984
985
986
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 984

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


989
990
991
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 989

def end_time
  @end_time
end

#experiment_length ⇒ String

Maximum number of days to run the experiment/rollout. 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) 


996
997
998
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 996

def experiment_length
  @experiment_length
end

#last_update_time ⇒ String

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

Returns:

  • (String) 


1001
1002
1003
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1001

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) 


1007
1008
1009
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1007

def name
  @name
end

#result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExperimentResult

The inference result which includes an objective metric to optimize and the confidence interval. Corresponds to the JSON property result

Returns:



1013
1014
1015
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1013

def result
  @result
end

#start_time ⇒ String

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

Returns:

  • (String) 


1018
1019
1020
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1018

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) 


1025
1026
1027
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1025

def state
  @state
end

#variants_history ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3VariantsHistory>

The history of updates to the experiment variants. Corresponds to the JSON property variantsHistory

Returns:



1030
1031
1032
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1030

def variants_history
  @variants_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1037

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