What's New in Version 1.0.0
Version 1.0.0 of the relationalai Python package is now available!
To upgrade, activate your virtual environment and run the following command:
pip install --upgrade relationalaiBreaking Changes
Section titled “Breaking Changes”-
Version
1.0.0is a major update of the Python SDK that introduces:-
PyRel, a new modeling and query DSL organized around
Concept,Property, andRelationshipclasses, and new chainable query methods likedefine,where, andselect. See Build a semantic model for an introduction to the new modeling and query patterns. -
Improved configuration management with a new
raiconfig.yamlformat. The v1 SDK treatsraiconfig.tomlas deprecated, so if you have an existingraiconfig.toml, you should migrate to YAML usingrai init --migrate. See Configuring PyRel for details on new configuration patterns. -
A new CLI with updated commands for managing reasoners, which were previously called engines, and job, which were previously called transactions. Check out the CLI reference for details on the new CLI commands and syntax.
-
Upgrade Notes
Section titled “Upgrade Notes”-
Treat this upgrade as a migration. You should expect to make non-trivial changes to your codebase when upgrading from v0.x to v1.0.0. If you need help, contact RelationalAI support for assistance.
-
Protect existing workflows. Make sure existing production and staging environments install
relationalaiin a way that doesn’t break existing code until you’re ready to migrate. For example, if you usepip, you can specify the version in yourrequirements.txtorsetup.pyto avoid accidentally upgrading to v1.0.0 before you’re ready.You can pin your project to the latest v0.x version with:
Terminal window relationalai==0.14.3Or, you can use a version specifier to allow the latest v0.x but prevent upgrading to v1.0.0 until you’re ready:
Terminal window relationalai>=0.14.0,<1.0.0