Skip to content

ExperimentRun

Source code in docs_src/capo_appconfig/types/experiment_run.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class ExperimentRun(TypedDict, closed=True):
    application_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The application ID.</p>"""
    experiment_definition_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The experiment definition ID.</p>"""
    run: "capo_appconfig.types.integer.Integer"
    """<p>The experiment run number.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of the experiment run.</p>"""
    status: NotRequired[
        "capo_appconfig.types.experiment_run_status.ExperimentRunStatus"
    ]
    """<p>The current status of the experiment run. Valid values: <code>RUNNING</code>, <code>DONE</code>.</p>"""
    exposure_percentage: NotRequired[
        "capo_appconfig.types.nullable_percentage.NullablePercentage"
    ]
    """<p>The percentage of the target audience exposed to treatments.</p>"""
    treatment_overrides: NotRequired[
        "capo_appconfig.types.treatment_overrides.TreatmentOverrides"
    ]
    """<p>Treatment assignment overrides that assign specific entity IDs to treatments.</p>"""
    result: NotRequired[
        "capo_appconfig.types.experiment_run_result.ExperimentRunResult"
    ]
    """<p>The result of the experiment run, including the executive summary and launch decision rationale.</p>"""
    started_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment run started, in ISO 8601 format.</p>"""
    updated_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment run was last updated, in ISO 8601 format.</p>"""
    ended_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment run ended, in ISO 8601 format.</p>"""
    experiment_definition_snapshot: NotRequired[
        "capo_appconfig.types.experiment_definition_snapshot.ExperimentDefinitionSnapshot"
    ]
    """<p>A snapshot of the experiment definition at the time the run was started.</p>"""

application_id instance-attribute 

application_id: NotRequired[Id]

The application ID.

description instance-attribute 

description: NotRequired[Description]

A description of the experiment run.

ended_at instance-attribute 

ended_at: NotRequired[Iso8601DateTime]

The date and time the experiment run ended, in ISO 8601 format.

experiment_definition_id instance-attribute 

experiment_definition_id: NotRequired[Id]

The experiment definition ID.

experiment_definition_snapshot instance-attribute 

experiment_definition_snapshot: NotRequired[ExperimentDefinitionSnapshot]

A snapshot of the experiment definition at the time the run was started.

exposure_percentage instance-attribute 

exposure_percentage: NotRequired[NullablePercentage]

The percentage of the target audience exposed to treatments.

result instance-attribute 

result: NotRequired[ExperimentRunResult]

The result of the experiment run, including the executive summary and launch decision rationale.

run instance-attribute 

run: Integer

The experiment run number.

started_at instance-attribute 

started_at: NotRequired[Iso8601DateTime]

The date and time the experiment run started, in ISO 8601 format.

status instance-attribute 

status: NotRequired[ExperimentRunStatus]

The current status of the experiment run. Valid values: RUNNING, DONE.

treatment_overrides instance-attribute 

treatment_overrides: NotRequired[TreatmentOverrides]

Treatment assignment overrides that assign specific entity IDs to treatments.

updated_at instance-attribute 

updated_at: NotRequired[Iso8601DateTime]

The date and time the experiment run was last updated, in ISO 8601 format.