machinebox / issues

Machine Box issues, bugs and feature requests
2 stars 0 forks source link

Suggestionbox console API docs don't match behavior #17

Closed autodidaddict closed 6 years ago

autodidaddict commented 6 years ago

There's a couple of examples of this. First, when you create a model you get a "success" boolean variable that isn't mentioned in the localhost docs. You get a success boolean when you list models (not included in the localhost docs). Also, when you create a model you receive the reward_expiration_seconds, softmax_lambda, and ngrams options in the response. The documentation is unclear about which of these options may or may not appear in a JSON response.

Admittedly this is an edge case most people are unlikely to care about, but as I'm coding up the Rust SDK, I'm finding it hard to trust some of the API docs displayed in localhost and resorting to reverse engineering the spec from behavior.

autodidaddict commented 6 years ago

The localhost:8080 console page also doesn't make any mention of the fact that when you upload a state file the response is a model.

autodidaddict commented 6 years ago

The limit parameter in prediction requests is documented in the web console but doesn't show up anywhere in the golang SDK.

matryer commented 6 years ago

All these fixes are done.