Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
- 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
-
#create_time ⇒ String
Creation time of this experiment.
-
#definition ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExperimentDefinition
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/rollout.
-
#last_update_time ⇒ String
Last update time of this experiment.
-
#name ⇒ String
The name of the experiment.
-
#result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExperimentResult
The inference result which includes an objective metric to optimize and the confidence interval.
-
#rollout_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutConfig
The configuration for auto rollout.
-
#rollout_failure_reason ⇒ String
The reason why rollout has failed.
-
#rollout_state ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutState
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::DialogflowV3::GoogleCloudDialogflowCxV3VariantsHistory>
The history of updates to the experiment variants.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Experiment
constructor
A new instance of GoogleCloudDialogflowCxV3Experiment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Experiment
Returns a new instance of GoogleCloudDialogflowCxV3Experiment.
1889 1890 1891 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1889 def initialize(**args) update!(**args) end |
Instance Attribute Details
#create_time ⇒ String
Creation time of this experiment.
Corresponds to the JSON property createTime
1809 1810 1811 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1809 def create_time @create_time end |
#definition ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExperimentDefinition
Definition of the experiment.
Corresponds to the JSON property definition
1814 1815 1816 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1814 def definition @definition end |
#description ⇒ String
The human-readable description of the experiment.
Corresponds to the JSON property description
1819 1820 1821 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1819 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
1825 1826 1827 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1825 def display_name @display_name end |
#end_time ⇒ String
End time of this experiment.
Corresponds to the JSON property endTime
1830 1831 1832 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1830 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
1837 1838 1839 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1837 def experiment_length @experiment_length end |
#last_update_time ⇒ String
Last update time of this experiment.
Corresponds to the JSON property lastUpdateTime
1842 1843 1844 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1842 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
1848 1849 1850 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1848 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
1854 1855 1856 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1854 def result @result end |
#rollout_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutConfig
The configuration for auto rollout.
Corresponds to the JSON property rolloutConfig
1859 1860 1861 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1859 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
1865 1866 1867 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1865 def rollout_failure_reason @rollout_failure_reason end |
#rollout_state ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutState
State of the auto-rollout process.
Corresponds to the JSON property rolloutState
1870 1871 1872 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1870 def rollout_state @rollout_state end |
#start_time ⇒ String
Start time of this experiment.
Corresponds to the JSON property startTime
1875 1876 1877 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1875 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
1882 1883 1884 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1882 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
1887 1888 1889 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1887 def variants_history @variants_history end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1894 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 |