Links

Suggestion List

https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions
Retrieves a Pagination of all Suggestion objects for this experiment.
Request Method: GET

Parameters

Name
Type
Required?
Description
after
string
N
Optional. Returns items with ids after after.
before
string
N
Optional. Returns items with ids before before.
limit
int
N
Optional. Limit the number of items returned. The maximum value is 100.
state
string
N
Optional. If open will filter by open suggestions.

Response

Pagination object.

Examples

Request all suggestions

Python
Bash
Java
suggestions = conn.experiments(EXPERIMENT_ID).suggestions().fetch()
SUGGESTIONS=`curl -s -X GET https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions -u "$SIGOPT_API_TOKEN":`
Pagination<Suggestion> suggestions = new Experiment(EXPERIMENT_ID).suggestions().list().call();
Response

Request open suggestions

Python
Bash
Java
suggestions = conn.experiments(EXPERIMENT_ID).suggestions().fetch(
state="open"
)
SUGGESTIONS=`curl -s -X -G GET https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions -u "$SIGOPT_API_TOKEN": \
-d state=open`
Pagination<Suggestion> suggestions = new Experiment(EXPERIMENT_ID).suggestions().list()
.addParam("state", "open")
.call();
Response