Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Experiment.
Represents an experiment in an environment.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Experiment
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The name of the experiment. Format: projects/
↳ display_name
string
Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
↳ description
string
The human-readable description of the experiment.
↳ state
int
The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
↳ definition
↳ rollout_config
Google\Cloud\Dialogflow\Cx\V3\RolloutConfig
The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.
↳ rollout_state
↳ rollout_failure_reason
string
The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
↳ result
↳ create_time
↳ start_time
↳ end_time
↳ last_update_time
↳ experiment_length
Google\Protobuf\Duration
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.
↳ variants_history
array< Google\Cloud\Dialogflow\Cx\V3\VariantsHistory
>
The history of updates to the experiment variants.
getName
The name of the experiment.
Format: projects/
string
setName
The name of the experiment.
Format: projects/
var
string
$this
getDisplayName
Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
string
setDisplayName
Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
var
string
$this
getDescription
The human-readable description of the experiment.
string
setDescription
The human-readable description of the experiment.
var
string
$this
getState
The current state of the experiment.
Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
int
setState
The current state of the experiment.
Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
var
int
$this
getDefinition
The definition of the experiment.
hasDefinition
clearDefinition
setDefinition
The definition of the experiment.
$this
getRolloutConfig
The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.
hasRolloutConfig
clearRolloutConfig
setRolloutConfig
The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.
$this
getRolloutState
State of the auto rollout process.
hasRolloutState
clearRolloutState
setRolloutState
State of the auto rollout process.
$this
getRolloutFailureReason
The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
string
setRolloutFailureReason
The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
var
string
$this
getResult
Inference result of the experiment.
hasResult
clearResult
setResult
Inference result of the experiment.
$this
getCreateTime
Creation time of this experiment.
hasCreateTime
clearCreateTime
setCreateTime
Creation time of this experiment.
$this
getStartTime
Start time of this experiment.
hasStartTime
clearStartTime
setStartTime
Start time of this experiment.
$this
getEndTime
End time of this experiment.
hasEndTime
clearEndTime
setEndTime
End time of this experiment.
$this
getLastUpdateTime
Last update time of this experiment.
hasLastUpdateTime
clearLastUpdateTime
setLastUpdateTime
Last update time of this experiment.
$this
getExperimentLength
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.
hasExperimentLength
clearExperimentLength
setExperimentLength
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.
$this
getVariantsHistory
The history of updates to the experiment variants.
setVariantsHistory
The history of updates to the experiment variants.
$this
