Dialogflow v3 API - Class Experiment (2.18.0)

public sealed class Experiment : IMessage<Experiment>, IEquatable<Experiment>, IDeepCloneable<Experiment>, IBufferMessage, IMessage

Reference documentation and code samples for the Dialogflow v3 API class Experiment.

Represents an experiment in an environment.

Inheritance

object > Experiment

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

Experiment()

public Experiment()

Experiment(Experiment)

public Experiment(Experiment other)
Parameter
Name Description
other Experiment

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Creation time of this experiment.

Property Value
Type Description
Timestamp

Definition

public Experiment.Types.Definition Definition { get; set; }

The definition of the experiment.

Property Value
Type Description
ExperimentTypesDefinition

Description

public string Description { get; set; }

The human-readable description of the experiment.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

Property Value
Type Description
string

EndTime

public Timestamp EndTime { get; set; }

End time of this experiment.

Property Value
Type Description
Timestamp

ExperimentLength

public Duration ExperimentLength { get; set; }

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.

Property Value
Type Description
Duration

ExperimentName

public ExperimentName ExperimentName { get; set; }

ExperimentName-typed view over the Name resource name property.

Property Value
Type Description
ExperimentName

LastUpdateTime

public Timestamp LastUpdateTime { get; set; }

Last update time of this experiment.

Property Value
Type Description
Timestamp

Name

public string Name { get; set; }

The name of the experiment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>..

Property Value
Type Description
string

Result

public Experiment.Types.Result Result { get; set; }

Inference result of the experiment.

Property Value
Type Description
ExperimentTypesResult

RolloutConfig

public RolloutConfig RolloutConfig { get; set; }

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.

Property Value
Type Description
RolloutConfig

RolloutFailureReason

public string RolloutFailureReason { get; set; }

The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

Property Value
Type Description
string

RolloutState

public RolloutState RolloutState { get; set; }

State of the auto rollout process.

Property Value
Type Description
RolloutState

StartTime

public Timestamp StartTime { get; set; }

Start time of this experiment.

Property Value
Type Description
Timestamp

State

public Experiment.Types.State State { get; set; }

The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

Property Value
Type Description
ExperimentTypesState

VariantsHistory

public RepeatedField<VariantsHistory> VariantsHistory { get; }

The history of updates to the experiment variants.

Property Value
Type Description
RepeatedFieldVariantsHistory