Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Experiment.
Represents an experiment in an environment.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Creation time of this experiment.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Creation time of this experiment.
Returns
- (::Google::Protobuf::Timestamp) — Creation time of this experiment.
#definition
def definition() -> ::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition) — The definition of the experiment.
#definition=
def definition=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition) — The definition of the experiment.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition) — The definition of the experiment.
#description
def description() -> ::String
Returns
- (::String) — The human-readable description of the experiment.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — The human-readable description of the experiment.
Returns
- (::String) — The human-readable description of the experiment.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
Returns
- (::String) — Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — End time of this experiment.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — End time of this experiment.
Returns
- (::Google::Protobuf::Timestamp) — End time of this experiment.
#experiment_length
def experiment_length() -> ::Google::Protobuf::Duration
Returns
- (::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.
#experiment_length=
def experiment_length=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::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.
Returns
- (::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.
#last_update_time
def last_update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Last update time of this experiment.
#last_update_time=
def last_update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Last update time of this experiment.
Returns
- (::Google::Protobuf::Timestamp) — Last update time of this experiment.
#name
def name() -> ::String
Returns
- (::String) — The name of the experiment. Format: projects/
#name=
def name=(value) -> ::String
Parameter
- value (::String) — The name of the experiment. Format: projects/
Returns
- (::String) — The name of the experiment. Format: projects/
#result
def result() -> ::Google::Cloud::Dialogflow::CX::V3::Experiment::Result
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Experiment::Result) — Inference result of the experiment.
#result=
def result=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Experiment::Result
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::Experiment::Result) — Inference result of the experiment.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Experiment::Result) — Inference result of the experiment.
#rollout_config
def rollout_config() -> ::Google::Cloud::Dialogflow::CX::V3::RolloutConfig
Returns
- (::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_config=
def rollout_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::RolloutConfig
Parameter
- value (::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.
Returns
- (::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_failure_reason
def rollout_failure_reason() -> ::String
Returns
- (::String) — The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
#rollout_failure_reason=
def rollout_failure_reason=(value) -> ::String
Parameter
- value (::String) — The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
Returns
- (::String) — The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
#rollout_state
def rollout_state() -> ::Google::Cloud::Dialogflow::CX::V3::RolloutState
Returns
- (::Google::Cloud::Dialogflow::CX::V3::RolloutState) — State of the auto rollout process.
#rollout_state=
def rollout_state=(value) -> ::Google::Cloud::Dialogflow::CX::V3::RolloutState
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::RolloutState) — State of the auto rollout process.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::RolloutState) — State of the auto rollout process.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Start time of this experiment.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Start time of this experiment.
Returns
- (::Google::Protobuf::Timestamp) — Start time of this experiment.
#state
def state() -> ::Google::Cloud::Dialogflow::CX::V3::Experiment::State
Returns
- (::Google::Cloud::Dialogflow::CX::V3::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.
#state=
def state=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Experiment::State
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::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.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::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.
#variants_history
def variants_history() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>) — The history of updates to the experiment variants.
#variants_history=
def variants_history=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>
Parameter
- value (::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>) — The history of updates to the experiment variants.
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>) — The history of updates to the experiment variants.