Experiments

Create

POST

Create an experiment for your project.

You can optionally specify IDs of your project’s model configs to include in the experiment, along with a set of labels to consider as positive feedback and whether the experiment should be set as active.

Path parameters

project_idstringRequired

String ID of project. Starts with pr_.

Request

This endpoint expects an object.
name
stringRequired
Name of experiment.
positive_labels
list of objectsRequired
Feedback labels to treat as positive user feedback. Used to monitor the performance of model configs in the experiment.
config_ids
list of stringsOptional
Configs to add to this experiment. Further configs can be added later.
set_active
booleanOptional
Whether to set the created project as the project's active experiment.

Response

This endpoint returns an object
id
string

String ID of experiment. Starts with exp_.

project_id
string

String ID of project the experiment belongs to. Starts with pr_.

name
string
Name of experiment.
status
enum
Status of experiment.
Allowed values: InitializedIn progress
metric
object
Metric used as the experiment's objective.
positive_labels
list of objects
Feedback labels to treat as positive user feedback. Used to monitor the performance of model configs in the experiment.
created_at
datetime
updated_at
datetime
configs
list of objectsOptional
List of configs associated to the experiment.

Errors