Release Notes

API Changes

These are modifications since the previous release that may require changes in your calls to the binding.

1.31.0 (20 November 2024)

• Rebranding Rosette -> Analytics
• Use new url and api key header.

1.30.0 (10 July 2024)

• recordSimilarity allows calls with RecordSimilarityParameters with empty fields and properties
• Request timeout can be set on the Api objects. Default request timeout changed to 30 seconds
• Updated /record-similarity example

1.29.0 (17 April 2024)

• Add support and example for /record-similarity
• Add support and example for /events
• Update /entities example to include Fast Coref Server option.
• Update links in README.

1.26.0 (12 July 2023)

• Upgrade dependencies
• CI overhaul
• Code smells
• Remove phpdoc artifacts from main source tree

1.14.4

• Support unfielded addresses and update address example for /address-similarity

1.14.3

• New Address Similarity endpoint /address-similarity
• New Address Similarity example

1.12.1

• New Similar Terms endpoint /semantics/similar
• New Similar Terms example
• /text-embedding endpoint changed to /semantics/vector
• /text-embedding example changed to /semantics/vector example

1.9.0

• Multilingual language identification example
• User Agent includes runtime version

1.8.0

• New topics endpoint
• New topics example

1.7.0

• Added transliteration endpoint
• Added nameDeduplication endpoint
• Added examples for each

1.5.0

• Added api.setUrlParam(param, value) to provide a means for setting url query parameters. Example: api.setUrlParam('output', 'rosette');
• getUrlParam and clearUrlParams are provided as well. A single url parameter may be removed by passing Null into setUrlParam.
• entities/linked completely removed
• changed setCustomerHeaders(array) to setCustomHeader(key, value) to align with setUrlParam and setOption

1.4.0

• removed get/setTimeout - never used internally
• syntaxDependencies endpoint added

1.3.0

• text-embedding endpoint added

1.2.0

• Binding reflects unification of /entities and /entities/linked endpoints; /entities returns a new response model which includes QIDs by default
• resolve_entities parameter is not available anymore (entities function returns QIDs by default)
• linkEntities option is available to turn off QIDs through $api->setOption("linkEntities", FALSE);

1.1.2

• Added api.setOption, api.getOption and api.clearOptions methods to allow users to specify options as needed
• Removed RelationshipParameters. Use DocumentParameters instead and provide an option for accuracyMode: PRECISION|RECALL. Relationships defaults to PRECISION if no option is specified.

1.1.0

• No impact on user operations

1.0.3

• Response data is returned as an associative array. The headers are included in the array, key name 'headers'.

1.0.0

• Enable cURL in php. This can be achieved by using the command sudo apt-get install php5-curl or by uncommenting the line extension=php_curl.dll in php.ini.
• Functions and classes removed: The /matched-name and /translated-name endpoints have been renamed to /name-similarity and /name-translation in the Rosette API, so the PHP binding reflects those changes by adding the new functions nameSimilarity and nameTranslation and new corresponding Parameters classes. Functions matchedName and translatedName and their corresponding Parameters classes are no longer supported.
• All responses now include the response headers in the returned JSON -- make sure to access or filter the desired JSON response object in your code. Related to Rosette API's new headers mentioned here.

Internal Changes

These changes should not require modifications to your bindings calls, but represent major internal changes, often correlating to Rosette API functional changes indicated here.

1.8.1 (Develop)

1.8.0

• Added topics endpoint to Api
• Created unit test for topics

1.7.0

• Added unit tests for new endpoints and parameter classes
• Updated README

1.5.0

• Refactored RosetteRequest to use rmccue/requests instead of curl

1.4.0

• removed retries on 429 error code. All errors will throw an exception.

1.3.0

• Relocated the http connection to be at the Api level in order to reuse the connection
• Adjusted the max connections per the Concurrency return from Rosette API

1.2.0

• Changed DocumentProperties.fileName from public to private and added a getter for it to prevent it from being included in the serialization of class parameters

1.1.2

• Updated unit tests per Options and removal of Relationships
• Updated relationships example
• Cleanup of RosetteParamsSetBase

1.1.1

• Removed active check of binding version against server version

1.1.0

• Retooled unit testing to use phpSpec
• Internal code changes per unit test and functional test discoveries
• Fixed some possible conflicts with PHP 7. Tests pass with PHP 7.
• Added a retry feature when encountering 429 (too many requests) errors. The user may specify the number of retries, default 5, and the number of milliseconds between retries, default 500000, to reduce the number of 429s.

1.0.0

• The unit, contentType, and contentBytes input parameters have been removed. Base64-encoded input should be sent as an input file.
• The X-RosetteAPI-Request-Id and X-RosetteAPI-ProcessedLanguage values have been added as response headers.
• The 'retrying requests' mechanism has been removed and the function name has been changed to makeRequest().
• GET and POST requests are now composed and made using cURL instead of with file_get_contents().