Class Experiment

Represents an experiment in an environment.

Attributes
NameDescription
strname
The name of the experiment. Format: projects/
strdisplay_name
Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
strdescription
The human-readable description of the experiment.
google.cloud.dialogflowcx_v3.types.Experiment.Statestate
The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
google.cloud.dialogflowcx_v3.types.Experiment.Definitiondefinition
The definition of the experiment.
google.cloud.dialogflowcx_v3.types.RolloutConfigrollout_config
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.
google.cloud.dialogflowcx_v3.types.RolloutStaterollout_state
State of the auto rollout process.
strrollout_failure_reason
The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
google.cloud.dialogflowcx_v3.types.Experiment.Resultresult
Inference result of the experiment.
google.protobuf.timestamp_pb2.Timestampcreate_time
Creation time of this experiment.
google.protobuf.timestamp_pb2.Timestampstart_time
Start time of this experiment.
google.protobuf.timestamp_pb2.Timestampend_time
End time of this experiment.
google.protobuf.timestamp_pb2.Timestamplast_update_time
Last update time of this experiment.
google.protobuf.duration_pb2.Durationexperiment_length
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.
Sequence[google.cloud.dialogflowcx_v3.types.VariantsHistory]variants_history
The history of updates to the experiment variants.

Inheritance

builtins.object > proto.message.Message > Experiment

Classes

Definition

Definition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Result

Result(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

State

State(value)

The state of the experiment.