google_api_dialogflow v0.74.0

View Source GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment (google_api_dialogflow v0.74.0)

Represents an experiment in an environment.

Attributes

  • createTime (type: DateTime.t, default: nil) - Creation time of this experiment.
  • definition (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExperimentDefinition.t, default: nil) - The definition of the experiment.
  • description (type: String.t, default: nil) - The human-readable description of the experiment.
  • displayName (type: String.t, default: nil) - Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
  • endTime (type: DateTime.t, default: nil) - End time of this experiment.
  • experimentLength (type: String.t, default: nil) - 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.
  • lastUpdateTime (type: DateTime.t, default: nil) - Last update time of this experiment.
  • name (type: String.t, default: nil) - The name of the experiment. Format: projects//locations//agents//environments//experiments/..
  • result (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExperimentResult.t, default: nil) - Inference result of the experiment.
  • rolloutConfig (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RolloutConfig.t, default: nil) - 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.
  • rolloutFailureReason (type: String.t, default: nil) - The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
  • rolloutState (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RolloutState.t, default: nil) - State of the auto rollout process.
  • startTime (type: DateTime.t, default: nil) - Start time of this experiment.
  • state (type: String.t, default: nil) - The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
  • variantsHistory (type: list(GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3VariantsHistory.t), default: nil) - The history of updates to the experiment variants.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment{
  createTime: DateTime.t() | nil,
  definition:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExperimentDefinition.t()
    | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  endTime: DateTime.t() | nil,
  experimentLength: String.t() | nil,
  lastUpdateTime: DateTime.t() | nil,
  name: String.t() | nil,
  result:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExperimentResult.t()
    | nil,
  rolloutConfig:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RolloutConfig.t()
    | nil,
  rolloutFailureReason: String.t() | nil,
  rolloutState:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RolloutState.t()
    | nil,
  startTime: DateTime.t() | nil,
  state: String.t() | nil,
  variantsHistory:
    [GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3VariantsHistory.t()]
    | nil
}

Link to this section Functions

Link to this function

decode(value, options)

View Source

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.