Projects

Update

PATCH

Update a specific project.

Set the project’s active model config/experiment by passing either active_experiment_id or active_model_config_id. These will be set to the Default environment unless a list of environments are also passed in specifically detailing which environments to assign the active config or experiment.

Set the feedback labels to be treated as positive user feedback used in calculating top-level project metrics by passing a list of labels in positive_labels.

Path parameters

idstringRequired

String ID of project. Starts with pr_.

Request

This endpoint expects an object.
name
stringOptional
The new unique project name. Caution, if you are using the project name as the unique identifier in your API calls, changing the name will break the calls.
active_experiment_id
stringOptional

ID for an experiment to set as the project’s active deployment. Starts with ‘exp_‘. At most one of ‘active_experiment_id’ and ‘active_model_config_id’ can be set.

active_config_id
stringOptional

ID for a config to set as the project’s active deployment. Starts with ‘config_‘. At most one of ‘active_experiment_id’ and ‘active_config_id’ can be set.

positive_labels
list of objectsOptional
The full list of labels to treat as positive user feedback.
directory_id
stringOptional

ID of directory to assign project to. Starts with dir_.

Response

This endpoint returns an object
id
string
Project ID
name
string
Unique project name.
users
list of objects
Users associated to the project.
data_count
integer
The count of datapoints that have been logged to the project.
feedback_types
list of objects
The feedback types that have been defined in the project.
team_id
string

Unique ID of the team the project belongs to. Starts with tm_.

created_at
datetime
updated_at
datetime
active_experiment
objectOptional

Experiment that has been set as the project’s active deployment. At most one of active_experiment and active_model_config can be set.

active_config
objectOptional

Config that has been set as the project’s active deployment. At most one of active_experiment and active_model_config can be set.

config_type
enumOptional
An enumeration.
Allowed values: genericmodeltoolagentevaluator
active_evaluators
list of objectsOptional
Evaluators that have been set as active for the project.
directory_id
stringOptional

String ID of the directory the project belongs to. Starts with dir_.

Errors