UpdateExperimentRequest

import type { UpdateExperimentRequest } from "https://aws-api.deno.dev/v0.3/services/evidently.ts?docs=full";

interface UpdateExperimentRequest {

description?: string | null;

experiment: string;

metricGoals?: MetricGoalConfig[] | null;

onlineAbConfig?: OnlineAbConfig | null;

project: string;

randomizationSalt?: string | null;

samplingRate?: number | null;

treatments?: TreatmentConfig[] | null;

}

§Properties

description?: string | null

[src]

An optional description of the experiment.

experiment: string

[src]

The name of the experiment to update.

metricGoals?: MetricGoalConfig[] | null

[src]

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

onlineAbConfig?: OnlineAbConfig | null

[src]

A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

project: string

[src]

The name or ARN of the project that contains the experiment that you want to update.

randomizationSalt?: string | null

[src]

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

samplingRate?: number | null

[src]

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

treatments?: TreatmentConfig[] | null

[src]

An array of structures that define the variations being tested in the experiment.