Migration from OpenAmplify Version 2.0 to Version 2.1: Considerations and Instructions
In general, applications using Version 2.1 will find it backward compatible with Version 2.0. However, Version 2.1 adds many new features, and therefore some new XML output structures are generated, as follows:
1. Addition of TopicInstance nodes under TopicResult nodes. The inclusion of co-reference in Version 2.1 made it possible for multiple forms of a single topic to be detected. For example, co-reference will relate President Obama, the President, and Obama, so that signals related to them are more accurately calculated. Version 2.1 therefore presents, for each variant of a given TopicResult node, one TopicInstance node. These nodes appear immediately after the TopicResult node, and before any generated Polarity results for the TopicResult.
2. Addition of a RequestInfo structure. This is a structure at the same level of the other OpenAmplify analyses such as Styles or TopicDescriptions. It appears as the last major node, after Styles, in the analysis and is returned for all analysis requests. It contains useful metadata about the request, including a unique RequestID that can be used to retrieve a previously analyzed request from cache, as well as any parameters that the user included in the API call. It also permits users to include custom parameters that are passed through with the transaction, for use by the user's own applications. Any parameter not recognized as an OpenAmplify API parameter is simply passed through.
Version 2.1 added the Ampliverse custom taxonomy feature, which permits users to define multiple, customized taxonomies for mission-specific use and refer to them using an ampliverseID=nnn construct in the API call. Using Ampliverse will change what is returned in the Domains segment of the analysis. The Domains nodal structure is not affected, so there are no migration implications to Ampliverse.
Public platform users should change the head of the OpenAmplify URL from http://portaltnx20.openamplify.com/AmplifyWeb_v20/ to http://portaltnx20.openamplify.com/AmplifyWeb_v21/ to utilize Version 2.1.
Commercial customers using dedicated resources should alter the AmplifyWeb_v20 reference in their OpenAmplify URL to AmplifyWeb_v21. No other changes are required.
For more information, please contact email@example.com