added
New `advice.examples` property structure
11 months ago by Mark Healey
We added an all-new Advice API response format earlier this year, which enables a host of new development and integration options. As we expanded the testing of the API's new response body, we discovered the examples
property could be much better.
In the previous version, the advice.examples[]
property was an Array—a collection of Advice nodes tagged as example
type.
With this update, the advice.examples{}
is now an Object with two children properties as follows: advice[]
and inputRequests[]
.
advice.examples = {
advice: [ {/* current example in Advice format */} ],
inputRequests: [ /* list of all examples in InputRequest format */ ]
}
This examples
property is only available when providing Context: "examples"
as an input parameter.