Stream Data In
Streaming data into the Novelty Detector is simply a matter of making REST API calls. Two endpoints are available:
POST /api/v1/novelty/{name}/observe
POST /api/v1/novelty/{name}/observe/bulk
The only difference between these two endpoints is how many observations they receive. …/observe
takes a single observation and returns a single result. …/observe/bulk
accepts an array of observations and returns a single response containing an array of results. These two endpoints can be used together. Full interactive documentation for these and all other API endpoints is available in each running instance of thatDot Novelty Detector.
Feeding in results requires choosing a value for {name}
in the POST URL. This value is chosen by the user and can be any URL-encoded string which (after being decoded) will be used as the name of the “context” for the provided observation(s). As mentioned above, a “context” is just a group of observations. All observations passed to the same context will use previous observations in that context as a part of their novelty calculations. Contexts with different names have absolutely no bearing on each other.