Skip to content

UpdateExperimentRunRequest

Source code in docs_src/capo_appconfig/types/update_experiment_run_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class UpdateExperimentRunRequest(TypedDict, closed=True):
    application_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The application ID or name.</p>"""
    experiment_definition_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The experiment definition ID or name.</p>"""
    run: "capo_appconfig.types.positive_integer.PositiveInteger"
    """<p>The run number to update.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>An updated description for the experiment run.</p>"""
    exposure_percentage: NotRequired[
        "capo_appconfig.types.nullable_percentage.NullablePercentage"
    ]
    """<p>The new exposure percentage. This value can only be increased from the current setting.</p>"""
    treatment_overrides: NotRequired[
        "capo_appconfig.types.treatment_overrides.TreatmentOverrides"
    ]
    """<p>The updated treatment assignment overrides that assign specific entity IDs to treatments, bypassing random assignment.</p>"""
    deployment_parameters: NotRequired[
        "capo_appconfig.types.deployment_parameters.DeploymentParameters"
    ]
    """<p>The updated deployment parameters for the experiment run.</p>"""

application_identifier instance-attribute 

application_identifier: Identifier

The application ID or name.

deployment_parameters instance-attribute 

deployment_parameters: NotRequired[DeploymentParameters]

The updated deployment parameters for the experiment run.

description instance-attribute 

description: NotRequired[Description]

An updated description for the experiment run.

experiment_definition_identifier instance-attribute 

experiment_definition_identifier: Identifier

The experiment definition ID or name.

exposure_percentage instance-attribute 

exposure_percentage: NotRequired[NullablePercentage]

The new exposure percentage. This value can only be increased from the current setting.

run instance-attribute 

run: PositiveInteger

The run number to update.

treatment_overrides instance-attribute 

treatment_overrides: NotRequired[TreatmentOverrides]

The updated treatment assignment overrides that assign specific entity IDs to treatments, bypassing random assignment.