IBM Cloud Docs
Versioning

Versioning

Current API version: 2022-08-10

API requests require a version parameter that takes the date in the format version=YYYY-MM-DD. Send the version parameter with every API request.

When we change the API in a backwards-incompatible way, we release a new minor version. To take advantage of the changes in a new version, change the value of the version parameter to the new date. If you're not ready to update to that version, don't change your version date.

Deprecation schedule for version dates

When a new version date is released, the previous version date will enter a deprecation period lasting one year. You will have one year to migrate your code to support a version that is not deprecated before API requests that use the retired version are automatically switched over to the latest version available.

The following timeline provides examples of what might happen during the deprecation schedule for the 2019-06-04 version.

  • The 2019-07-12 version date is released. This begins a deprecation period for the previous 2019-06-04 version date that lasts one year.
    • The deprecated version date is still available to use during the deprecation period.
  • A new version date is released during the deprecation period, such as 2020-05-10.
  • On July 12, 2020, the deprecation period for the 2019-06-04 version date ends and the version date is retired.
    • API requests that still use the 2019-06-04 version date after July 12, 2020 are automatically changed to use the behavior of the latest version date available. For this example, the latest version available is 2020-05-10.

Version dates

The following table shows the service behavior changes for each version date. Switching to a later version date will activate all changes introduced in earlier versions.

Version date Changes summary Retirement date
2022-08-10
  • Language expansion of entities with a new model for improved accuracy and confidence scores.
  • Version 2 Russian entity type system.
  • Version 2 Swedish entity type system.
    		•
    2022-04-07
  • Bug fix for Version 2 Categories type system.
    		•
    2020-12-09
  • Version 2 English entity type system.
    		•
    2020-12-02
  • Version 2 Korean entity type system.
  • Version 2 Spanish entity type system.
    		•
    2020-08-01
  • Taxonomy changes aimed towards standardization of the label names in the default taxonomy.
    		•
    2019-07-12
    Deprecated
  • New English entities model with improved accuracy and confidence scores.
    		•  August 1, 2021
    2019-06-04
    Deprecated
  • Fixed a bug that caused entities requests with custom models to ignore the limit option.
  • The default limit value for all entities requests is now 50 for all models.
  • The maximum limit value of 250 entities has been removed.
    		•  July 12, 2020
    2018-11-16
    Deprecated
  • Version 2 Italian entity type system.
    		•  July 12, 2020
    2018-09-21
    Deprecated
  • Version 2 Portuguese entity type system.
    		•  July 12, 2020
    2018-03-16
    Deprecated
  • Version 2 French entity type system.
  • Version 2 German entity type system.
    		•  July 12, 2020
    2017-02-27
    Deprecated    		 Base version. July 12, 2020