Suggestion List Delete

https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions

Deletes multiple Suggestion objects. This action cannot be undone. Only open suggestions can be deleted, so if you experience errors, use the state parameter.

Request Method: DELETE

Parameters

Name	Type	Required?	Description
state	string	N	Optional, but usually used. If open will only delete open suggestions.

Response

This endpoint returns nothing.

Examples

Delete all suggestions

Python

suggestion = conn.experiments(EXPERIMENT_ID).suggestions().delete()

Bash

SUGGESTION=`curl -s -X DELETE https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions -u "$SIGOPT_API_TOKEN":`

Java

new Experiment(EXPERIMENT_ID).suggestions().deleteList().call();

Delete open suggestions

Python

suggestion = conn.experiments(EXPERIMENT_ID).suggestions().delete(
  state="open"
)

Bash

OPEN_SUGGESTIONS=`curl -s -X DELETE https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions -u "$SIGOPT_API_TOKEN": \
  -d state=open`

Java

new Experiment(EXPERIMENT_ID).suggestions().deleteList()
  .addParam("state", "open")  
  .call();