Class Experiment (1.20.0)

Version 1.20.0

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

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

Represents an experiment in an environment.

Attributes
Name	Description
name	str The name of the experiment. Format: projects/
display_name	str Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
description	str The human-readable description of the experiment.
state	google.cloud.dialogflowcx_v3beta1.types.Experiment.State The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
definition	google.cloud.dialogflowcx_v3beta1.types.Experiment.Definition The definition of the experiment.
rollout_config	google.cloud.dialogflowcx_v3beta1.types.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	google.cloud.dialogflowcx_v3beta1.types.RolloutState State of the auto rollout process.
rollout_failure_reason	str The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
result	google.cloud.dialogflowcx_v3beta1.types.Experiment.Result Inference result of the experiment.
create_time	google.protobuf.timestamp_pb2.Timestamp Creation time of this experiment.
start_time	google.protobuf.timestamp_pb2.Timestamp Start time of this experiment.
end_time	google.protobuf.timestamp_pb2.Timestamp End time of this experiment.
last_update_time	google.protobuf.timestamp_pb2.Timestamp Last update time of this experiment.
experiment_length	google.protobuf.duration_pb2.Duration 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.
variants_history	MutableSequence[google.cloud.dialogflowcx_v3beta1.types.VariantsHistory] The history of updates to the experiment variants.

Classes

Definition

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

Definition of the experiment.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

Values: STATE_UNSPECIFIED (0): State unspecified. DRAFT (1): The experiment is created but not started yet. RUNNING (2): The experiment is running. DONE (3): The experiment is done. ROLLOUT_FAILED (4): The experiment with auto-rollout enabled has failed.