Client and Database Upgrade Considerations

Understanding When Upgrades are Needed

The NLP API is under constant development to provide new features, bug fixes, faster speed of processing, more flexible deployment, and improve the accuracy of our Natural Language Processing engine.

Many of these updates do not require our customers to update their client verison (or custom software) as they are backward-compatible. Such changes are available to all clients as soon as the NLP API is released and deployed to the NLP API endpoints.

We may make changes that mean that we must modify the NLP API, Result Format, database schema for the Python database client, or Client/SDKs. Customers who want to access these new features may have to upgrade one or more components of the system, and in some cases, customers may be required to upgrade in order to continue using the NLP API. For customers that have built their own client, or that use the NLP API, they may have to make upgrades to their own client code as well.

For a summary of new features and improvements and whether you need to upgrade your client, refer to the Changelog or the release notes for the NLP API..

NLP API Database Migration

When there are changes to the NLP API Result Format, customers who are using the NLP API Database created by the Python database client should perform a database migration. Changes to the result format are noted in the release notes for the NLP API.

Whenever the NLP API database schema changes, run the migrate command provided by the corresponding version of the NLP API Database client. This command updates the table schemas for NLP API databases, correctly handling any pre-existing data.

Customers that have implemented their own custom ETL to their own custom database should contact Emtelligent for further information.

Summary

Not all features and improvements that are released will require you to upgrade your client version or perform a data migration. The engine-client version compatibility information is provided in the Changelog page. When planning to upgrade, we recommend reading the release notes of the NLP API and also the detailed changelogs for the components you are using.

If you need further clarification or would like help in assessing the impact of these types of changes on your implementation, please contact support@emtelligent.com.