Add schema for embed API requests

learningequality / le-utils

Utilities and constants shared across Kolibri, Ricecooker, and Kolibri Studio

MIT License

2 stars 31 forks source link

Add schema for embed API requests #117

Closed bjester closed 8 months ago

bjester commented 10 months ago

Summary

Defines a JSON schema for the structure of recommendations API requests that will be received by TorchServe
Fields level, parent, and has_content will be generated in preprocessing in the TorchServe handler
TODO: unit tests to ensure schema does what we expect

Reference

Closes https://github.com/learningequality/studio/issues/4392

bjester commented 10 months ago

@jamalex :: @akolson and I worked on a JSON schema to nail down the format of the data sent to TorchServe for topic recommendations. We followed your example in the example pipeline code. Does it look sufficient?

Other questions:

Do we need has_content to represent whether a topic has non-topic resources? Or is that only representative of whether it has subtopics?
What is category and do we need it?

akolson commented 8 months ago

Hi @jamalex I was able to incorporate the feedback. It was pretty clear so need for the call. We should now be more closer to the final request body 🤞. Please let me know incase there is anything that may require an update. @bjester, a few files have been renamed as noted by Jamie in his comment. Also, any feedback is welcome. Thanks