Release Notes

API Changes

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

1.31.0 (15 November 2024)

• Rebranding Rosette -> Analytics
• Use new url and api key header.
• New artifact, rosette-api-all, for resolving jar hell errors generated during ES plugin compilation.

1.30.0 (17 July 2024)

• FieldedAddress and FieldedDate fields are expanded
• Added info messages to RecordSimilarityResponse and RecordSimilarityResult
• RecordSimilarityProperties supports sending parameters or parameterUniverse
• RecordSimilarityFieldInfo now have a scoreIfNull field, to specify a value for when a field is missing in a record
• Upgrade to Open Source Parent pom 19.0.0

Breaking changes:

• Response will deserialize fields to UnknownField objects
• Changed error to be a list of String in RecordSimilarityResult
• FieldedAddress no longer has an address field
• RecordFieldType changed from an enum to a class with public static String values

1.29.0 (19 April 2024)

• /name-translation can now, optionally, return a list of results.
• Add support and example for /record-similarity
• Add support for Indoc Coref Server for /entities
• Website, logo, email address and other branding updates.
• Library upgrades

1.28.0 (10 January 2024)

• Add thread pool for supporting concurrent requests. Includes an example to demonstrate usage. (RCB-597)
• Events requests support negation option (WS-2853)
• Upgrade to Open Source Parent pom 17.0.0

1.26.0 (11 July 2023)

• Upgrade to Open Source Parent Pom 15.0.0
• The Semantics endpoints have a new option called embeddingsMode to select which model you want to use. See the release notes for 1.26.0 for a more thorough description of the change.

1.25.1 (31 March 2023)

• Restore genre but ignore it.
• Restore numCategories in CategoriesOptions.

1.25.0 (27 March 2023)

• Removed all instances of genre in JSON structures.
• Removed the Address class.
• Removed numCategories in CategoriesOptions.
• Removed dbpediaType in Entity.
• Removed includeDBpediaType in EntitiesOptions.

1.24.0 (30 December 2022)

• Marking the genre field for /entities as deprecated
• Adding regexCurrencySplit option

1.23.0 (30 September 2022)

• Added linkMentionMode request option for /entities
• Compiled with Java 17, targeting Java 11.

1.21.0 (28 March 2022)

• Added DNN model type to /morphology endpoints.

1.20.0 (20 December 2021)

• /events support the plan option.
• /events options validation removed.
• In PoolingHttpClientConnectionManager override the default value of DefaultMaxPerRoute and set it to the connection concurrency.
• Use new open source parent to deploy to new OSS server.

1.19.3 (13 August 2021)

• Make /events workspaceId non-nullable.
• Add a structuredRegionProcessingType flag.
• Add a "Generic Response" to the API model.

1.19.1 (4 June 2021)

• enableStructuredRegion property for /entities. Default value is false.
• Add support for /events endpoint.
• Add workspaceId option for /events
• Upgrade to version 2.7.2 of Annotated Data Model.
• Upgrade to version 4.5.13 of Apache HTTP Components.

1.18.0 (8 December, 2020)

• Response payload on calls to /info now include licenseExpiration string. Requires minimum Server version of 1.18.0.

1.17.2 (September 21, 2020)

• Parameters option for /address-similarity and /name-similarity
• RTS decoder option for /entities
• Case Sensitivity option for /entities

1.16.1 (June 16, 2020)

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

1.16.0 (April 8, 2020)

• Added a boolean field licensed to the SupportedLanguagePair class where true indicates that you are licensed for the particular language. See HttpRosetteAPI.getSupportedLanguages and SupportedLanguagesResponse

1.15.0 (December 11, 2019)

• Custom Regex entry support (On-Prem only)

1.14.3 (October 17, 2019)

• New Address Similarity endpoint /address-similarity

1.14.0 (August 27, 2019)

• added new includePermID option for /entities and associated response field, permId.
• added new includeDBpediaTypes option for /entities and associated response field, dbpediaTypes.
• deprecated includeDBpediaType option for /entities and associated response field, dbpediaType.

1.13.0 (April 2, 2019)

• added PERCEPTRON to DisambiguatorType

1.12.1 (February 5, 2019)

• 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.12.0 (December 12, 2018)

• removed java 7 compatibility
• added morpho option for disambiguator
• removed dependency on guava

1.11.0 (August 27, 2018)

For all endpoints (excluding Name Similarity, Name Translation, Name Deduplication, info, and ping)

• Added a method to get supported languages per endpoint: HttpRosetteAPI.getSupportedLanguages(String endpoint). This method will return a SupportedLanguageResponse containing information about the supported languages and scripts.

Language Identification

• LanguageOptions now includes the Boolean field koreanDialects to control whether North and South Korean should be returned instead of Korean.

Categorization

• CategoriesOptions class now includes Boolean singleLabel and Float scoreThreshold parameters. Additionally, the numCategories option has been deprecated. Users should instead use the scoreThreshold option to control the returned results. The default mode for the /categories endpoint is now multilabel, and users should set the singleLabel option to true to return to the old (pre 1.11.0) behavior.
• CategoriesResponse class now contains a list of CategoryLabels. A CategoryLabel class contains the same fields as the previously used Label class, but also includes a Double score field representing the label's raw score. This value can be between negative infinity and infinity.

Text Embedding

• There is a new TextEmbeddingOptions class, which allows users to request per-token embeddings from the /text-embedding endpoint. This can be enabled by setting perToken to true.
• The TextEmbeddingResponse class embedding field has been renamed to documentEmbedding. Additionally, two fields, tokens and tokenEmbeddings, have been added to the class in order to reflect the /text-embedding endpoint's new support for per-token embeddings.

Entity Extraction and Linking

• There’s a new option in EntitiesOptions, includeDBpediaType (off by default), that, when enabled, returns both the new DBpedia entity types as well as the extended range of possible macro entity types. See the Rosette Cloud/Enterprise release notes for additional information.

1.10.1 (June 1, 2018)

• Expose /morphology model type option

1.10.0 (April 17, 2018)

• EntitiesOptions class now includes a String modelType parameter.

1.2.7 (July 21, 2016)

• RosetteAPI class constructors have been deprecated. API objects can be instantiated with Builder class.
• Parameters genre, language, options, and httpClient are linked to the API object and apply to all calls made with the object.
• The following methods now only have input text, URL, or a stream and content type passed as a parameter:
  • getLanguage
  • getEntities
  • getCategories
  • getRelationships
  • getSentiment
  • getTokens
  • getSentences
• Method getMorphology only accepts parameters Morphological Feature and the input text, URL, or InputStream and content type
• Method getNameSimilarity accepts two names instead of NameSimilarityRequest
• Unified /entities endpoint. getLinkedEntities method has been deprecated. getEntities now by default returns linked entities with the option to disable this feature through a EntitiesOptions object
• Request is now parent to all request classes. Categories, Entities, Language, Morphology, Relationships, and Sentiment have been consolidated into DocumentRequest.

1.1.0 (May 3, 2016)

• genre added to Request. Setting genre="social-media" will return analyses from components optimized for tweet-length text.

1.0.0 (April 6, 2016)

• Method matchName has been renamed to getNameSimilarity along with its corresponding request and response data model classes, from NameMatching to NameSimilarity
• Method translateName has been renamed to getNameTranslation
• The confidence score field has been removed from 'getEntities'
• Method getSentiment now returns a sentiment for each resolved entity in addition to a document level sentiment
• Method getSentiment can return neu (neutral) in addition to pos and neg
• Enum MorphologicalFeature has been separated from the main API class
• A new Label class has been added to represent sentiment and categories result elements, previously Sentiment and Category
• Other removed data model classes:
  • InputUnit
  • ScriptResponse
  • PartOfSpeech
  • Lemma
  • HanReadings
  • CompoundComponents
  • CategoryTaxonomy
  • SentimentModel
  • NameMatchingResult
  • NameTranslationResult
  • SchemesResponse

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.10.0 (April 17, 2018)

• Updates to jackson

1.9.0 (January 22, 2018)

• Multilingual language identification example
• User Agent includes runtime version

1.5.6 (January 5, 2017)

• Fixed null pointer error when using the builder with no url() step. Now defaults to https://api.rosette.com/rest/v1
• Modified sentiment example to use UTF-8 instead US-ASCII
• Example pom updated to remove sl4j log warnings

1.2.8 (August 8, 2016)

• RosetteAPI's maximum concurrent connections set by pinging the server at initialization time.

1.1.0 (May 3, 2016)

• The X-RosetteAPI-Request-Id and X-RosetteAPI-ProcessedLanguage values have been added as response headers.

1.0.0 (April 6, 2016)

• The unit, contentType, and contentBytes input parameters have been removed. Base64-encoded input should be sent in as an InputStream without any encoding.
• Requests now use a builder pattern.