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.



3572
3573
3574
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3572

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


3506
3507
3508
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3506

def create_time
  @create_time
end

#definitionGoogle::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentDefinition

Definition of the experiment. Corresponds to the JSON property definition



3511
3512
3513
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3511

def definition
  @definition
end

#descriptionString

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

Returns:

  • (String)


3516
3517
3518
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3516

def description
  @description
end

#display_nameString

Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. Corresponds to the JSON property displayName

Returns:

  • (String)


3522
3523
3524
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3522

def display_name
  @display_name
end

#end_timeString

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

Returns:

  • (String)


3527
3528
3529
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3527

def end_time
  @end_time
end

#experiment_lengthString

LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc: default_experiment_length) Corresponds to the JSON property experimentLength

Returns:

  • (String)


3536
3537
3538
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3536

def experiment_length
  @experiment_length
end

#last_update_timeString

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

Returns:

  • (String)


3541
3542
3543
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3541

def last_update_time
  @last_update_time
end

#nameString

The name of the experiment. Format: projects//locations//agents//environments// experiments/.. Corresponds to the JSON property name

Returns:

  • (String)


3547
3548
3549
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3547

def name
  @name
end

#resultGoogle::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExperimentResult

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



3553
3554
3555
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3553

def result
  @result
end

#start_timeString

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

Returns:

  • (String)


3558
3559
3560
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3558

def start_time
  @start_time
end

#stateString

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)


3565
3566
3567
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3565

def state
  @state
end

#variants_historyArray<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1VariantsHistory>

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



3570
3571
3572
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3570

def variants_history
  @variants_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3577

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