Browse the documentation
AI-Soda Brain

Manage versions and compatibility

Track the product release, model configuration, data definitions and content versions separately. This helps teams anticipate the effect of an upgrade and explain why an answer changed afterward.

Technical guide · November 20263 min read

A result depends on several versions

Results for the same question can change because the business data was refreshed or because the model, tools, knowledge index or metric definitions changed. Associate those versions with the time of the run as well as the product release number.

This guide discusses version management. Consult the release notes for the delivered version for available features, supported environments, fixes and known limitations.

Maintain a compatibility record

RecordPurpose
Product and component versionsIdentify the deployment and its dependencies.
Model and key configurationCompare inference behavior and resource requirements.
Connector and data source versionsIdentify differences in schemas and protocols.
Ontology and metric definitionsExplain changes to calculation rules.
Document and industry package versionsTrace knowledge sources and task templates.
Client contract versionValidate API and integration compatibility.

Four questions to ask about release notes

  • Does the change affect existing questions, access permissions or generated files?
  • Does it require a manual data or configuration migration?
  • Can you retain records for the previous version, and what does rollback require?
  • Which success and failure cases need to be retested?

Keep comparable upgrade results

Run a representative question set with the same snapshot and identity. Compare answers, sources, execution states and elapsed times separately. If the new version changes a business definition, explain the difference before deciding whether to recalculate historical results.

When updating site documentation, retain the applicable scope and revision date. Older links should lead readers to the relevant guidance or an explicit migration path so teams maintaining existing integrations can still find the right material.

Try “permissions,” “data source,” “manufacturing” or “API.”