Improve human readability of saved files

texascloud / api-ai-git

This is a CLI tool to version control intents and entities in API.ai born out of a frustration of having them constantly mangled by other team members without a way to rollback to a working version.

MIT License

15 stars 3 forks source link

Improve human readability of saved files #1

Open beeedy opened 7 years ago

beeedy commented 7 years ago

While the current pickle format works it seems that a more human readable format would be beneficial so that by diff-ing two files you could easily get an idea of what was changed. Personally I think a stretch goal would be to back up into the format found within api.ai's .zip file they offer for manual backups (no idea why there isn't access to the backup/restore feature through their api)

texascloud commented 7 years ago

Good idea! I was using pickle files to try to save space in the event someone's agent had a large amount of intents and entities, but it's likely pre-mature optimization. I'll try to have this done by next week as I'm currently in the process of moving, thanks!

beeedy commented 7 years ago

I verified that you can remove the agent.json and customDomainsResponses.json from the backup .zip file and the built in restore functionality within API.ai will still accept the .zip as a valid backup. It may be beneficial to go with this structuring so that this tool isn't required to restore an agent, plus it is pretty human readable!