rosette_api 1.14.4 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38b4872ea8951d43abf562f7feed44bf672e2508ec78e34c6e05327293b8c35
-  data.tar.gz: 5608e8136b43a67a771fe860f51deee5c14da58aefa90211d6bb0be77a14834a
+  metadata.gz: 648715b05a66f8b54708e36ae3a6548d8a07c0e06f5c225060a1a7c02fea6208
+  data.tar.gz: 15a9eb85d4df30ee6b6de01fb2f0b4ca48863b3da492c95793784b46a514c58d
 SHA512:
-  metadata.gz: 85f6244f0c40958eabe5165b85dc2ee13e849924f9a500404391541bfb490291e46b8461dcc4f3bfd90ca54ff04ba5585d3b9654d4df8b9b3d2d7c72a4f031ae
-  data.tar.gz: 2dea9f348e81a32fa8f6e692f66385fe0b4143b34902d03765d027087f0b83f670bb428845d77afded27a12bfa013a52b806d042e233266e3cd5924a805bcd64
+  metadata.gz: d9f43d9d0333720b3ad08e7460ea92fbeffbd22b3e4f445b21b51f50a74b14ee3b5eb7677a0af8a444f0aa3f718d0e7ca8ad59ff3f3187ae665b2f81f0a83adf
+  data.tar.gz: 5b404dd299bc6e06964d19cbe51c71b3f1efa266d631ac462d31be85f058dfbdba130964092572df5596988b97367f605377f0ab31a17da689ead9ba04e34fe0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2019 Basis Technology Corporation.
+Copyright (c) 2016-2026 Babel Street Rosette Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,18 +1,26 @@
-<a href="https://www.rosette.com"><img src="https://s3.amazonaws.com/styleguide.basistech.com/logos/rosette-logo.png" width="181" height="47" /></a>
+<a href="https://www.babelstreet.com/modules">
+    <img src="https://charts.babelstreet.com/icon.png" width="48" height="48" alt="Babel Street Logo"/>
+</a>
 
----
+# Analytics by Babel Street
 
-[![Build Status](https://travis-ci.org/rosette-api/ruby.svg?branch=develop)](https://travis-ci.org/rosette-api/ruby) [![Gem Version](https://badge.fury.io/rb/rosette_api.svg)](https://badge.fury.io/rb/rosette_api)
+[![Gem Version](https://badge.fury.io/rb/rosette_api.svg)](https://badge.fury.io/rb/rosette_api)
 
-## Rosette API
-The Rosette Text Analytics Platform uses natural language processing, statistical modeling, and machine learning to
-analyze unstructured and semi-structured text across 364 language-encoding-script combinations, revealing valuable
-information and actionable data. Rosette provides endpoints for extracting entities and relationships, translating and
-comparing the similarity of names, categorizing and adding linguistic tags to text and more.
+Our product is a full text processing pipeline from data preparation to extracting the most relevant information and
+analysis utilizing precise, focused AI that has built-in human understanding. Text Analytics provides foundational
+linguistic analysis for identifying languages and relating words. The result is enriched and normalized text for
+high-speed search and processing without translation.
 
-## Rosette API Access
-- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
-- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
+Text Analytics extracts events and entities — people, organizations, and places — from unstructured text and adds the
+structure of associating those entities into events that deliver only the necessary information for near real-time
+decision making. Accompanying tools shorten the process of training AI models to recognize domain-specific events.
+
+The product delivers a multitude of ways to sharpen and expand search results. Semantic similarity expands search
+beyond keywords to words with the same meaning, even in other languages. Sentiment analysis and topic extraction help
+filter results to what’s relevant.
+
+## Analytics API Access
+- Analytics Cloud [Sign Up](https://developer.babelstreet.com/signup)
 
 ## Quick Start
 
@@ -21,16 +29,15 @@ comparing the similarity of names, categorizing and adding linguistic tags to te
 `gem install rosette_api`
 
 #### Examples
-View small example programs for each Rosette endpoint
+View small example programs for each Analytics endpoint
 in the [examples](https://github.com/rosette-api/ruby/tree/develop/examples) directory.
 
 #### Documentation & Support
 - [Binding API](https://rosette-api.github.io/ruby/)
-- [Rosette Platform API](https://developer.rosette.com/features-and-functions)
+- [Analytics Platform API](https://documentation.babelstreet.com/analytics)
 - [Binding Release Notes](https://github.com/rosette-api/ruby/wiki/Release-Notes)
-- [Rosette Platform Release Notes](https://support.rosette.com/hc/en-us/articles/360018354971-Release-Notes)
-- [Binding/Rosette Platform Compatibility](https://developer.rosette.com/features-and-functions?ruby#)
-- [Support](https://support.rosette.com)
+- [Analytics Platform Release Notes](https://docs.babelstreet.com/r/Hosted-Services-Release-Notes)
+- [Support](https://babelstreet.my.site.com/support/s/contactsupport)
 - [Binding License: Apache 2.0](https://github.com/rosette-api/ruby/blob/develop/LICENSE)
 
 ## Binding Developer Information

data/examples/README.md

@@ -13,7 +13,7 @@ A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolcha
 ```
 git clone git@github.com:rosette-api/ruby.git
 cd ruby
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.4-slim
 
 gem install rosette_api
 
@@ -25,7 +25,7 @@ ruby ping.rb $API_KEY
 ```
 git clone git@github.com:rosette-api/ruby.git
 cd ruby
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.4-slim
 
 cd /source
 gem build rosette_api.gemspec

data/examples/address_similarity.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 begin
   address1 = AddressParameter.new(
@@ -20,7 +21,7 @@ begin
   )
   address2 = '160 Pennsilvana Avenue, Washington, D.C., 20500'
   params = AddressSimilarityParameters.new(address1, address2)
-  response = rosette_api.get_address_similarity(params)
+  response = analytics_api.get_address_similarity(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/categories.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
-categories_url_data = 'https://onlocationvacations.com/2018/02/06/downton-abbey-exhibition-extended-april-2-nyc/'
+categories_text_data = 'If you are a fan of the British television series Downton Abbey and you are planning to be in New York anytime before April 2nd, there is a perfect stop for you while in town.'
 begin
-  params = DocumentParameters.new(content_uri: categories_url_data)
-  response = rosette_api.get_categories(params)
+  params = DocumentParameters.new(content: categories_text_data)
+  response = analytics_api.get_categories(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/entities.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 entities_text_data = 'The Securities and Exchange Commission today announced the leadership of the agency\'s trial unit. Bridget Fitzpatrick has been named Chief Litigation Counsel of the SEC and David Gottesman will continue to serve as the agency\'s Deputy Chief Litigation Counsel. Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as Co-Acting Chief Litigation Counsel.  In that role, they were jointly responsible for supervising the trial unit at the agency\'s Washington D.C. headquarters as well as coordinating with litigators in the SEC\'s 11 regional offices around the country.'
 begin
-  params = DocumentParameters.new(content: entities_text_data,
-                                  genre: 'social-media')
-  response = rosette_api.get_entities(params)
+  params = DocumentParameters.new(content: entities_text_data)
+  response = analytics_api.get_entities(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/events.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rosette_api'
+
+api_key, url = ARGV
+
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
+
+events_text_data = 'Bill Gates went to the store.'
+begin
+  params = DocumentParameters.new(content: events_text_data)
+  response = analytics_api.get_events(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/info.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
-response = rosette_api.info
+response = analytics_api.info
 begin
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e

data/examples/language.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 language_data = 'Por favor Señorita, says the man.'
 begin
   params = DocumentParameters.new(content: language_data)
   params.custom_headers = { 'X-RosetteAPI-App' => 'ruby-app' }
-  response = rosette_api.get_language(params)
+  response = analytics_api.get_language(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/language_multilingual.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 language_multilingual_data = 'On Thursday, as protesters gathered in Washington D.C., the United States Federal Communications Commission under Chairman Ajit Pai voted 3-2 to overturn a 2015 decision, commonly called Net Neutrality, that forbade Internet service providers (ISPs) such as Verizon, Comcast, and AT&T from blocking individual websites or charging websites or customers more for faster load times.  Quatre femmes ont été nommées au Conseil de rédaction de la loi du Qatar. Jeudi, le décret royal du Qatar a annoncé que 28 nouveaux membres ont été nommés pour le Conseil de la Choura du pays.  ذكرت مصادر أمنية يونانية، أن 9 موقوفين من منظمة \"د هـ ك ب ج\" الذين كانت قد أوقفتهم الشرطة اليونانية في وقت سابق كانوا يخططون لاغتيال الرئيس التركي رجب طيب أردوغان.'
 
@@ -16,7 +17,7 @@ begin
   params = DocumentParameters.new(content: language_multilingual_data)
   params.rosette_options = { 'multilingual' => 'true' }
   params.custom_headers = { 'X-RosetteAPI-App' => 'ruby-app' }
-  response = rosette_api.get_language(params)
+  response = analytics_api.get_language(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/morphology_complete.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 morphology_complete_data = 'The quick brown fox jumped over the lazy dog. 👍🏾 Yes he did. B)'
 begin
   params = DocumentParameters.new(content: morphology_complete_data)
-  response = rosette_api.get_morphology_complete(params)
+  response = analytics_api.get_morphology_complete(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/morphology_compound-components.rb

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 morphology_compound_components_data = 'Rechtsschutzversicherungsgesellschaften'
 begin
   params = DocumentParameters.new(
     content: morphology_compound_components_data
   )
-  response = rosette_api.get_compound_components(params)
+  response = analytics_api.get_compound_components(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/morphology_han-readings.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 morphology_han_readings_data = '北京大学生物系主任办公室内部会议'
 begin
   params = DocumentParameters.new(content: morphology_han_readings_data)
-  response = rosette_api.get_han_readings(params)
+  response = analytics_api.get_han_readings(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/morphology_lemmas.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 morphology_lemmas_data = 'The fact is that the geese just went back to get a rest and I\'m not banking on their return soon'
 begin
   params = DocumentParameters.new(content: morphology_lemmas_data)
-  response = rosette_api.get_lemmas(params)
+  response = analytics_api.get_lemmas(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/morphology_parts-of-speech.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 morphology_parts_of_speech_data = 'The fact is that the geese just went back to get a rest and I\'m not banking on their return soon'
 begin
   params = DocumentParameters.new(content: morphology_parts_of_speech_data)
-  response = rosette_api.get_parts_of_speech(params)
+  response = analytics_api.get_parts_of_speech(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/multipart_language_file.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require 'rosette_api'
+
+api_key, url = ARGV
+
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
+
+begin
+  # Create a sample file to upload (so the example is runnable as-is).
+  file_path = File.expand_path('sample.txt', __dir__)
+  File.write(file_path, "Bonjour tout le monde.\n")
+
+  params = DocumentParameters.new(file_path: file_path)
+  response = analytics_api.get_language(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+ensure
+  FileUtils.rm_f(file_path)
+end

data/examples/name_deduplication.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 name_dedupe_data = 'Alice Terry,Alice Thierry,Betty Grable,Betty Gable,Norma Shearer,Norm Shearer,Brigitte Helm,Bridget Helem,Judy Holliday,Julie Halliday'
 
@@ -16,7 +17,7 @@ threshold = 0.75
 names = name_dedupe_data.split(',').map { |n| NameParameter.new(n) }
 begin
   params = NameDeduplicationParameters.new(names, threshold)
-  response = rosette_api.get_name_deduplication(params)
+  response = analytics_api.get_name_deduplication(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/name_similarity.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 matched_name_data1 = 'Michael Jackson'
 matched_name_data2 = '迈克尔·杰克逊'
@@ -18,8 +19,9 @@ begin
     entity_type: 'PERSON',
     language: 'eng'
   )
-  params = NameSimilarityParameters.new(name1, matched_name_data2)
-  response = rosette_api.get_name_similarity(params)
+  match_parameters = { conflictScore: '0.35' }
+  params = NameSimilarityParameters.new(name1, matched_name_data2, match_parameters)
+  response = analytics_api.get_name_similarity(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/name_translation.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 translated_name_data = 'معمر محمد أبو منيار القذاف'
 begin
@@ -17,7 +18,7 @@ begin
     'eng',
     target_script: 'Latn'
   )
-  response = rosette_api.get_name_translation(params)
+  response = analytics_api.get_name_translation(params)
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',

data/examples/ping.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rosette_api'
 
 api_key, url = ARGV
 
-rosette_api = if url
-                RosetteAPI.new(api_key, url)
-              else
-                RosetteAPI.new(api_key)
-              end
+analytics_api = if url
+                  RosetteAPI.new(api_key, url)
+                else
+                  RosetteAPI.new(api_key)
+                end
 
 begin
-  response = rosette_api.ping
+  response = analytics_api.ping
   puts JSON.pretty_generate(response)
 rescue RosetteAPIError => e
   printf('Rosette API Error (%<status_code>s): %<message>s',