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.



1417
1418
1419
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1417

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) 


1337
1338
1339
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1337

def create_time
  @create_time
end

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

Definition of the experiment. Corresponds to the JSON property definition

Returns:



1342
1343
1344
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1342

def definition
  @definition
end

#description ⇒ String

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

Returns:

  • (String) 


1347
1348
1349
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1347

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) 


1353
1354
1355
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1353

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


1358
1359
1360
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1358

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) 


1365
1366
1367
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1365

def experiment_length
  @experiment_length
end

#last_update_time ⇒ String

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

Returns:

  • (String) 


1370
1371
1372
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1370

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) 


1376
1377
1378
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1376

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:



1382
1383
1384
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1382

def result
  @result
end

#rollout_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RolloutConfig

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

Returns:



1387
1388
1389
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1387

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) 


1393
1394
1395
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1393

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

Returns:



1398
1399
1400
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1398

def rollout_state
  @rollout_state
end

#start_time ⇒ String

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

Returns:

  • (String) 


1403
1404
1405
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1403

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) 


1410
1411
1412
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1410

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:



1415
1416
1417
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1415

def variants_history
  @variants_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1422

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