Suggestion List

https://api.staging.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.

Request all suggestions

Python
Java

suggestions = conn.experiments(EXPERIMENT_ID).suggestions().fetch()

Response

{
  "count": 1,
  "data": [
    {
      "assignments": {
        "degree": 2,
        "gamma": 3.6,
        "kernel": "rbf"
      },
      "created": 1414800000,
      "deleted": null,
      "experiment": "1",
      "id": "1",
      "metadata": null,
      "object": "suggestion",
      "state": "closed"
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "CgIQAQ",
    "before": null
  }
}

Request open suggestions

Python
Java

suggestions = conn.experiments(EXPERIMENT_ID).suggestions().fetch(
  state="open"
  )

Response

{
  "count": 0,
  "data": [],
  "object": "pagination",
  "paging": {
    "after": null,
    "before": null
  }
}

Documentation

Suggestion List

Parameters

Response

Examples

Request all suggestions

Request open suggestions

Related Endpoints