Release Notes

API Changes

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

1.31.0 (22 November 2024)

• Rebranding Rosette -> Analytics
• Use new url and api key header.
• Add support for /events
• Add support for /record-similarity
• Dependency upgrades
• Set supported versions to "18", "20", "22" & "23"
• Code smells, refactoring, deprecations

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
• Package upgrades.

1.12.2

• Fix content-from-file bug in entities, vectors, syntax dependencies and embeddings.

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 nameDeduplication endpoint
• Added transliteration endpoint

1.5.0

• Added support for url parameters, aka query parameters. Example: api.parameters.urlParameters = {output: "rosette"};
• Removed entities/linked code and example

1.4.0

• removed parameters._maxRetries
• removed parameters._msinterval
• Added syntaxDependencies endpoint

1.3.0

• Added text-embedding endpoint

1.2.0

• customHeaders parameter
• Binding reflects unification of /entities and /entities/linked endpoints; /entities returns a new response model which includes QIDs by default
• linked parameter is not available anymore
• linkEntities option is available to turn off QIDs through api.parameters.options = { "linkEntities": false };

1.1.3

• Get/Set options
• No more info calls

1.1.0

• User may specify the number of retries and the microsecond interval to use for responding to 429s

1.0.0

• To send a file to the Rosette API, the nodejs binding now depends on an npm module called multipart-stream. Run npm install to install this to the node modules folder.
• The /matched-name and /translated-name endpoints have been renamed to /name-similarity and /name-translation in the Rosette API, so previous API users will need to change these calls in their node.js code. See https://developer.rosette.com/release-notes for more detailed API changes that will affect the functionality of your app.

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 (Develop)

• Updated Api.js to call topics
• Created topics.js
• Created topics unit test

1.7.0

• Added examples and unit tests for nameDeduplication and transliteration
• Updated the name_* endpoints to not accept documentFile (they never should have)

1.4.0

• removed 429 check and retry
• removed parameters._maxRetries
• removed parameters._msinterval

1.3.0

• HTTP client reuse
• Max connections set to response concurrency

1.2.0

• Added filter to prevent internal-only parameters from being passed to the server

1.1.0

• Removed mock-data files
• Updated unit tests to be more specific to operation
• Centralized the request operation to rosetteRequest.js
• Added handling for 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.