Versioning
Third-party integrations can be updated at any time. For efficiency, the LLM-based platform may cache the intents.json
file and only update it when necessary. This is where versioning comes into play.
Relevant Fields
schema
: The schema version of theintents.json
. For version 1, it should be set tov1
.version
: The version of theintents.json
. This should be a string in semantic versioning format.
Instructions for Intent Providers
- Update the
version
field whenever you update theintents.json
. - Update the
schema
field whenever you change the schema of theintents.json
. - Deploy the
intents.json
as a static file, similar to how files are served on a CDN. This approach makes it easier to detect changes using response headers likeETag
andLast-Modified
, allowing LLM-based platforms to cache it using standard static file logic.
Instructions for LLM-based Platforms
- Check the
version
field and update the cache if the version has changed. - Check the
schema
field and validate theintents.json
against the corresponding schema. - Cache the
intents.json
and follow standard caching logic as you would for a normal static file.