ExperimentsResource

Experiment API methods.

Functions

constructor__init__(client) -> None

Initialize the resource.

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(request, idempotency_key=None) -> ExperimentResponse

Create an experiment.

paramrequestExperimentCreateRequest

Experiment create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.experiment.ExperimentResponse

Created experiment.

funcget(experiment_id) -> ExperimentResponse

Get an experiment by id.

paramexperiment_iduuid.UUID

Id of the experiment.

Returns

kitaru.api_models.v1.experiment.ExperimentResponse

Stored experiment.

funclist(params=None) -> Page[ExperimentResponse]

List experiments.

paramparamsExperimentListParams | None

= None

Experiment list params.

Returns

kitaru.api_models.v1.base.Page

Page of experiments.

funciter(params=None) -> AsyncIterator[ExperimentResponse]

Iterate over all experiments.

paramparamsExperimentListParams | None

= None

Experiment list params.

Returns

collections.abc.AsyncIterator

Async iterator over every experiment.

funcupdate(experiment_id, request) -> ExperimentResponse

Update an experiment.

paramexperiment_iduuid.UUID

Id of the experiment.

paramrequestExperimentUpdateRequest

Experiment update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.experiment.ExperimentResponse

Updated experiment.

funcdelete(experiment_id) -> None

Delete an experiment.

paramexperiment_iduuid.UUID

Id of the experiment.

Returns

None

funcstart_run(experiment_id, request, idempotency_key=None) -> ExperimentRunResponse

Start an experiment run, fanning out one replay per cohort version session.

paramexperiment_iduuid.UUID

Id of the experiment.

paramrequestExperimentRunCreateRequest

Experiment run create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.experiment_run.ExperimentRunResponse

Created run.

FunctionsCopy Anchor Link

On this page

Functions