ExperimentsResource

Experiment API methods.

Functions

func__init__(self, client) -> None

Initialize the resource.

paramself

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(self, request, idempotency_key=None) -> ExperimentResponse

Create an experiment.

paramself

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(self, experiment_id) -> ExperimentResponse

Get an experiment by id.

paramself

paramexperiment_iduuid.UUID

Id of the experiment.

Returns

kitaru.api_models.v1.experiment.ExperimentResponse

Stored experiment.

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

List experiments.

paramself

paramparamsExperimentListParams | None

= None

Experiment list params.

Returns

kitaru.api_models.v1.base.Page

Page of experiments.

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

Iterate over all experiments.

paramself

paramparamsExperimentListParams | None

= None

Experiment list params.

Returns

collections.abc.AsyncIterator

Async iterator over every experiment.

funcupdate(self, experiment_id, request) -> ExperimentResponse

Update an experiment.

paramself

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(self, experiment_id) -> None

Delete an experiment.

paramself

paramexperiment_iduuid.UUID

Id of the experiment.

Returns

None

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

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

paramself

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.

Functions

On this page