Release Notes

API Changes

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

1.27.1 (16 January 2024)

• Deprecate genre parameter for /entities endpoint (WS-2589)
• Minimal supported Ruby version is now 3.0.0.
• Address many rubocop complaints

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
• rubocop clean up
• Repository documentation updates

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.2

• Addressed missing files in published gem

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 name_deduplication endpoint
• Added transliteration endpoint
• Modified name_similarity and name_translation api calls to be prefixed with get_ in order to be consistent

1.5.0

• Added api.url_parameters to allow the setting of query parameters. Example: api.url_parameters = { "output" => "rosette" }
• Removed all references to entities/linked

1.4.0

• api.get_syntax_dependencies added

1.3.0

• api.get_text_embedding added

1.2.0

• Binding reflects unification of /entities and /entities/linked endpoints; /entities returns a new response model which includes QIDs by default
• get_linked_entities method and resolve_entities parameter are not available anymore (use get_entities instead)
• linkEntities option is available to turn off QIDs through api.rosette_options = { linkEntities: false }

1.1.0

• Get/Set options
• No more info calls to check version

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

1.8.0

• Added topics to api
• Added topics unit test

1.7.0

• Code cleanup
• Added examples for name_deduplication and transliteration endpoints
• Added unit tests for above endpoints

1.5.0 (Develop)

• initial round of internal code cleanup

1.4.0

• removed 429 test and retry
• removed retries internal variable

1.3.0

• Cleaned up unit tests - no more mock-data
• Moved http client to Api level to provide connection reuse

1.2.0

• Added filter to prevent internal-use parameters from being included in the JSON parameters being sent to the server