Writing requests for Eevo
This guide covers how to write requests for Eevo's two APIs. Choose the tab for the API you are calling.
The SystemOne-compatible API follows the SystemOne endpoint format, introduced by Typesafe for asking a model typed questions about a state; SystemOne decision has the full reference.
A SystemOne request consists of a state, which holds the content the questions are about as plain text or a JSON object, and the questions themselves.
Choice questions
A choice question's probabilities add up to 1 across the choices you send, so a case that fits none of them goes to whichever choice is closest. If such cases can occur, add a choice for them, as the model routing example does with general.
There is no need to ask a choice question again with its options reordered: Eevo already averages over their order, as described under Option order.
Score questions
List the levels of a score question from lowest to highest, since a level's position in the list is its score.
Yes/no questions
A yes/no question can be phrased as a statement or as a question; the examples in these docs use statements, such as "The customer is attempting fraud." Keep each to a single proposition. "The task needs tools or a long context" should be split into two questions, since one probability cannot say which half is true.
Several questions in one request
When you need several answers about the same input, ask for them in one request. The state is then sent and billed only once.
Setting thresholds
The probabilities let your code decide when to act on its own and when to hand a case to a person. Set that threshold separately for each question, based on a small labelled sample of your own cases. Probability, confidence and expected value explains what the numbers mean.