Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GetExperimentResultsRequest

import type { GetExperimentResultsRequest } from "https://aws-api.deno.dev/v0.3/services/evidently.ts?docs=full";
interface GetExperimentResultsRequest {
baseStat?: ExperimentBaseStat | null;
endTime?: Date | number | null;
experiment: string;
metricNames: string[];
period?: number | null;
project: string;
reportNames?: ExperimentReportName[] | null;
resultStats?: ExperimentResultRequestType[] | null;
startTime?: Date | number | null;
treatmentNames: string[];
}

§Properties

§
baseStat?: ExperimentBaseStat | null
[src]

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

§
endTime?: Date | number | null
[src]

The date and time that the experiment ended, if it is completed.

§
experiment: string
[src]

The name of the experiment to retrieve the results of.

§
metricNames: string[]
[src]

The names of the experiment metrics that you want to see the results of.

§
period?: number | null
[src]

In seconds, the amount of time to aggregate results together.

§
project: string
[src]

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

§
reportNames?: ExperimentReportName[] | null
[src]

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

§
resultStats?: ExperimentResultRequestType[] | null
[src]

The statistics that you want to see in the returned results.

  • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.
  • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.
  • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.
  • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.
§
startTime?: Date | number | null
[src]

The date and time that the experiment started.

§
treatmentNames: string[]
[src]

The names of the experiment treatments that you want to see the results for.