rosette_api 1.8.0 → 1.14.4

data/lib/name_deduplication_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'bad_request_error'
 require_relative 'name_parameter'
 
@@ -23,13 +25,18 @@ class NameDeduplicationParameters
   # Validates the parameters by checking if name1 and name2 are instances of
   # a String or NameParameter.
   def validate_params
-    raise BadRequestError.new('names must be an array of name_parameter') unless @names.instance_of? Array
+    param_msg = 'names must be an array of name_parameter'
+    raise BadRequestError.new(param_msg) unless @names.instance_of? Array
+
+    float_msg = 'threshold must be a float'
+    thresh_msg = 'threshold must be in the range of 0 to 1'
     if @threshold
-      raise BadRequestError.new('threshold must be a float') unless @threshold.is_a?(Float)
-      raise BadRequestError.new('threshold must be in the range of 0 to 1') if @threshold.negative? || @threshold > 1
+      raise BadRequestError.new(float_msg) unless @threshold.is_a?(Float)
+      raise BadRequestError.new(thresh_msg) if @threshold.negative? || @threshold > 1
     end
+    opt_msg = 'rosette_options can only be an instance of a Hash'
     if @rosette_options
-      raise BadRequestError.new('rosette_options can only be an instance of a Hash') unless @rosette_options.is_a? Hash
+      raise BadRequestError.new(opt_msg) unless @rosette_options.is_a? Hash
     end
   end
 
@@ -38,9 +45,10 @@ class NameDeduplicationParameters
   # Returns the new Hash.
   def load_params
     validate_params
-    to_hash.select { |_key, value| value }
-           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-           .to_h
+    to_hash
+      .select { |_key, value| value }
+      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
+      .to_h
   end
 
   # Converts this class to Hash.

data/lib/name_parameter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class represents an entity name in Rosette API.
 class NameParameter
   # Name's entity type (PERSON, LOCATION, ORGANIZATION) (optional)
@@ -25,9 +27,10 @@ class NameParameter
   #
   # Returns the new Hash.
   def load_param
-    to_hash.select { |_key, value| value }
-           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-           .to_h
+    to_hash
+      .select { |_key, value| value }
+      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
+      .to_h
   end
 
   # Converts this class to Hash.

data/lib/name_similarity_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'bad_request_error'
 require_relative 'name_parameter'
 
@@ -27,10 +29,15 @@ class NameSimilarityParameters
   # Validates the parameters by checking if name1 and name2 are instances of
   # a String or NameParameter.
   def validate_params
-    raise BadRequestError.new('name1 option can only be an instance of a String or NameParameter') if [String, NameParameter].none? { |clazz| @name1.is_a? clazz }
-    raise BadRequestError.new('name2 option can only be an instance of a String or NameParameter') if [String, NameParameter].none? { |clazz| @name2.is_a? clazz }
+    n1_msg = 'name1 option can only be an instance of a String or NameParameter'
+    raise BadRequestError.new(n1_msg) if [String, NameParameter].none? { |clazz| @name1.is_a? clazz }
+
+    n2_msg = 'name2 option can only be an instance of a String or NameParameter'
+    raise BadRequestError.new(n2_msg) if [String, NameParameter].none? { |clazz| @name2.is_a? clazz }
+
+    opt_msg = 'rosette_options can only be an instance of a Hash'
     if @rosette_options
-      raise BadRequestError.new('rosette_options can only be an instance of a Hash') unless @rosette_options.is_a? Hash
+      raise BadRequestError.new(opt_msg) unless @rosette_options.is_a? Hash
     end
   end
 
@@ -39,9 +46,10 @@ class NameSimilarityParameters
   # Returns the new Hash.
   def load_params
     validate_params
-    to_hash.reject { |_key, value| value.nil? }
-           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-           .to_h
+    to_hash
+      .reject { |_key, value| value.nil? }
+      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
+      .to_h
   end
 
   # Converts this class to Hash.

data/lib/name_translation_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'rosette_api_error'
 
 # This class encapsulates parameters that are needed for name-translation in
@@ -11,7 +13,8 @@ class NameTranslationParameters
   attr_accessor :name
   # Rosette API options (optional, should be a hash)
   attr_accessor :rosette_options
-  # ISO 693-3 code of the name's native language the name originates in (optional)
+  # ISO 693-3 code of the name's native language the name originates in
+  # (optional)
   attr_accessor :source_language_of_origin
   # ISO 693-3 code of the name's language of use (optional)
   attr_accessor :source_language_of_use
@@ -47,10 +50,12 @@ class NameTranslationParameters
     @target_script = options[:target_script]
   end
 
-  # Validates the parameters by checking if rosette_options is an instance of a Hash.
+  # Validates the parameters by checking if rosette_options is an instance
+  # of a Hash.
   def validate_params
+    msg = 'rosette_options can only be an instance of a Hash'
     if @rosette_options
-      raise BadRequestError.new('rosette_options can only be an instance of a Hash') unless @rosette_options.is_a? Hash
+      raise BadRequestError.new(msg) unless @rosette_options.is_a? Hash
     end
   end
 
@@ -59,9 +64,10 @@ class NameTranslationParameters
   # Returns the new Hash.
   def load_params
     validate_params
-    to_hash.select { |_key, value| value }
-           .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
-           .to_h
+    to_hash
+      .select { |_key, value| value }
+      .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
+      .to_h
   end
 
   # Converts this class to Hash.

data/lib/request_builder.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'net/http'
 require 'net/https'
 require 'json'
@@ -17,15 +18,20 @@ class RequestBuilder
   attr_accessor :user_key
   # Rosette API binding version
   attr_accessor :binding_version
+  # User-Agent string
+  attr_reader :user_agent
 
-  def initialize(user_key, alternate_url, http_client, params = {}, url_parameters = nil, binding_version)
+  def initialize(user_key, alternate_url, http_client, binding_version,
+                 params = {}, url_parameters = nil)
     @user_key = user_key
     @alternate_url = alternate_url
     @http_client = http_client
-    @params = params
     @binding_version = binding_version
+    @params = params
+    @user_agent = 'Ruby/' + binding_version + '/' + RUBY_VERSION
 
     return unless url_parameters
+
     @alternate_url = @alternate_url + '?' + URI.encode_www_form(url_parameters)
   end
 
@@ -40,19 +46,27 @@ class RequestBuilder
     begin
       uri = URI.parse @alternate_url
       request = Net::HTTP::Post.new uri.request_uri
-    rescue
-      raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
+    rescue StandardError
+      # Not ideal.  Consider switching to a different library.
+      # https://stackoverflow.com/a/11802674
+      raise RosetteAPIError.new(
+        'connectionError',
+        'Failed to establish connection with Rosette server.'
+      )
     end
 
     custom_headers = params['customHeaders']
 
     if custom_headers
       keys_array = custom_headers.keys
-      for key in keys_array
+      keys_array.each do |key|
         if key.to_s =~ /^X-RosetteAPI-/
           request[key] = custom_headers[key]
         else
-          raise RosetteAPIError.new 'invalidHeader', 'Custom header must begin with "X-RosetteAPI-"'
+          raise RosetteAPIError.new(
+            'invalidHeader',
+            'Custom header must begin with "X-RosetteAPI-"'
+          )
         end
       end
       params.delete 'customHeaders'
@@ -61,6 +75,7 @@ class RequestBuilder
     request['X-RosetteAPI-Key'] = @user_key
     request['Content-Type'] = 'application/json'
     request['Accept'] = 'application/json'
+    request['User-Agent'] = @user_agent
     request['X-RosetteAPI-Binding'] = 'ruby'
     request['X-RosetteAPI-Binding-Version'] = @binding_version
     request.body = params.to_json
@@ -79,8 +94,8 @@ class RequestBuilder
     begin
       file = File.open params['filePath'], 'r'
       text = file.read
-    rescue => err
-      raise err
+    rescue StandardError => e
+      raise RosetteAPIError.new('readMultipartError', e)
     end
 
     boundary = SecureRandom.hex
@@ -90,7 +105,8 @@ class RequestBuilder
 
     # Add the content data
     post_body << "--#{boundary}\r\n"
-    post_body << "Content-Disposition: form-data; name=\"content\"; filename=\"#{File.basename(file)}\"\r\n"
+    post_body << 'Content-Disposition: form-data; name="content"; ' \
+                 "filename=\"#{File.basename(file)}\"\r\n"
     post_body << "Content-Type: text/plain\r\n\r\n"
     post_body << text
 
@@ -105,24 +121,34 @@ class RequestBuilder
     begin
       uri = URI.parse @alternate_url
       request = Net::HTTP::Post.new uri.request_uri
-    rescue
-      raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
+    rescue StandardError
+      # Not ideal.  Consider switching to a different library.
+      # https://stackoverflow.com/a/11802674
+      raise RosetteAPIError.new(
+        'connectionError',
+        'Failed to establish connection with Rosette API server.'
+      )
     end
 
     # add any custom headers from the user
     unless params['customHeaders'].nil?
       keys_array = params['customHeaders'].keys
-      for k in keys_array
+      keys_array.each do |k|
         if k.to_s =~ /^X-RosetteAPI-/
           request.add_field k, params['customHeaders'][k]
         else
-          raise RosetteAPIError.new 'invalidHeader', 'Custom header must begin with "X-RosetteAPI-"'
+          raise RosetteAPIError.new(
+            'invalidHeader',
+            'Custom header must begin with "X-RosetteAPI-"'
+          )
         end
       end
       params.delete 'customHeaders'
     end
 
-    request.add_field 'Content-Type', "multipart/form-data; boundary=#{boundary}"
+    request.add_field 'Content-Type',
+                      "multipart/form-data; boundary=#{boundary}"
+    request.add_field 'User-Agent', @user_agent
     request.add_field 'X-RosetteAPI-Key', @user_key
     request.add_field 'X-RosetteAPI-Binding', 'ruby'
     request.add_field 'X-RosetteAPI-Binding-Version', @binding_version
@@ -137,12 +163,17 @@ class RequestBuilder
   def send_get_request
     begin
       uri = URI.parse @alternate_url
-
       request = Net::HTTP::Get.new uri.request_uri
-    rescue
-      raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
+    rescue StandardError
+      # Not ideal.  Consider switching to a different library.
+      # https://stackoverflow.com/a/11802674
+      raise RosetteAPIError.new(
+        'connectionError',
+        'Failed to establish connection with Rosette API server.'
+      )
     end
     request['X-RosetteAPI-Key'] = @user_key
+    request['User-Agent'] = @user_agent
 
     get_response @http_client, request
   end

data/lib/rosette_api.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'request_builder'
 require_relative 'document_parameters'
 require_relative 'name_deduplication_parameters'
 require_relative 'name_translation_parameters'
 require_relative 'name_similarity_parameters'
+require_relative 'address_similarity_parameters'
 require_relative 'rosette_api_error'
 require_relative 'bad_request_error'
 require_relative 'bad_request_format_error'
@@ -10,42 +13,47 @@ require_relative 'bad_request_format_error'
 # This class allows you to access all Rosette API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.8.0'
+  BINDING_VERSION = '1.14.4'
   # Rosette API language endpoint
-  LANGUAGE_ENDPOINT = '/language'.freeze
+  LANGUAGE_ENDPOINT = '/language'
   # Rosette API morphology endpoint
-  MORPHOLOGY_ENDPOINT = '/morphology'.freeze
+  MORPHOLOGY_ENDPOINT = '/morphology'
   # Rosette API entities endpoint
-  ENTITIES_ENDPOINT = '/entities'.freeze
+  ENTITIES_ENDPOINT = '/entities'
   # Rosette API categories endpoint
-  CATEGORIES_ENDPOINT = '/categories'.freeze
+  CATEGORIES_ENDPOINT = '/categories'
   # Rosette API relationships endpoint
-  RELATIONSHIPS_ENDPOINT = '/relationships'.freeze
+  RELATIONSHIPS_ENDPOINT = '/relationships'
   # Rosette API sentiment endpoint
-  SENTIMENT_ENDPOINT = '/sentiment'.freeze
+  SENTIMENT_ENDPOINT = '/sentiment'
   # Name Deduplication endpoint
-  NAME_DEDUPLICATION_ENDPOINT = '/name-deduplication'.freeze
+  NAME_DEDUPLICATION_ENDPOINT = '/name-deduplication'
   # Rosette API name-translation endpoint
-  NAME_TRANSLATION_ENDPOINT = '/name-translation'.freeze
+  NAME_TRANSLATION_ENDPOINT = '/name-translation'
   # Rosette API name-similarity endpoint
-  NAME_SIMILARITY_ENDPOINT = '/name-similarity'.freeze
+  NAME_SIMILARITY_ENDPOINT = '/name-similarity'
+  # Rosette API address-similarity endpoint
+  ADDRESS_SIMILARITY_ENDPOINT = '/address-similarity'
   # Rosette API tokens endpoint
-  TOKENS_ENDPOINT = '/tokens'.freeze
+  TOKENS_ENDPOINT = '/tokens'
   # Rosette API sentences endpoint
-  SENTENCES_ENDPOINT = '/sentences'.freeze
+  SENTENCES_ENDPOINT = '/sentences'
   # Rosette API info endpoint
-  INFO = '/info'.freeze
+  INFO = '/info'
   # Rosette API ping endpoint
-  PING = '/ping'.freeze
-  # Text Embedding endpoint
-  TEXT_EMBEDDING = '/text-embedding'.freeze
+  PING = '/ping'
+  # Text Embedding endpoint (deprecated)
+  TEXT_EMBEDDING = '/text-embedding'
+  # Semantic Vectors endpoint (replaces /text-embedding)
+  SEMANTIC_VECTORS = '/semantics/vector'
+  # Similar Terms endpoint
+  SIMILAR_TERMS_ENDPOINT = '/semantics/similar'
   # Syntactic Dependencies endpoint
-  SYNTACTIC_DEPENDENCIES_ENDPOINT = '/syntax/dependencies'.freeze
+  SYNTACTIC_DEPENDENCIES_ENDPOINT = '/syntax/dependencies'
   # Transliteration endpoint
-  TRANSLITERATION_ENDPOINT = '/transliteration'.freeze
+  TRANSLITERATION_ENDPOINT = '/transliteration'
   # Topics endpoint
-  TOPICS_ENDPOINT = '/topics'.freeze
-
+  TOPICS_ENDPOINT = '/topics'
 
   # Rosette API key
   attr_accessor :user_key
@@ -74,7 +82,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of candidate languages in order of descending confidence.
   def get_language(params)
@@ -82,7 +91,8 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + LANGUAGE_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + LANGUAGE_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -91,7 +101,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns the lemmas, compound components, Han-readings, and parts-of-speech
   # tags of the input for supported languages.
@@ -100,7 +111,9 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/complete', @http_client, params, @url_parameters, BINDING_VERSION)
+    endpoint = MORPHOLOGY_ENDPOINT + '/complete'
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -108,7 +121,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of components for each compound word of the input for supported
   # languages.
@@ -117,7 +131,9 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/compound-components', @http_client, params, @url_parameters, BINDING_VERSION)
+    endpoint = MORPHOLOGY_ENDPOINT + '/compound-components'
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -125,7 +141,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of Han-readings which provide pronunciation information for
   # Han script, in both Chinese and Japanese input text.
@@ -134,7 +151,9 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/han-readings', @http_client, params, @url_parameters, BINDING_VERSION)
+    endpoint = MORPHOLOGY_ENDPOINT + '/han-readings'
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -142,7 +161,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of lemmas for each token of the input for supported languages.
   def get_lemmas(params)
@@ -150,7 +170,9 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/lemmas', @http_client, params, @url_parameters, BINDING_VERSION)
+    endpoint = MORPHOLOGY_ENDPOINT + '/lemmas'
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -158,7 +180,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of part-of-speech (POS) tags for each of the words of the
   # input, depending on the context of how it is used.
@@ -167,7 +190,9 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/parts-of-speech', @http_client, params, @url_parameters, BINDING_VERSION)
+    endpoint = MORPHOLOGY_ENDPOINT + '/parts-of-speech'
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -175,7 +200,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns each entity extracted from the input.
   def get_entities(params)
@@ -184,7 +210,8 @@ class RosetteAPI
     params = params.load_params
 
     endpoint = ENTITIES_ENDPOINT
-    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -192,7 +219,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns the contextual categories identified in the input.
   def get_categories(params)
@@ -200,7 +228,8 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + CATEGORIES_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + CATEGORIES_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -208,7 +237,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns each relationship extracted from the input.
   def get_relationships(params)
@@ -216,7 +246,8 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + RELATIONSHIPS_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + RELATIONSHIPS_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -224,7 +255,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns sentiment analysis results.
   def get_sentiment(params)
@@ -232,7 +264,8 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + SENTIMENT_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + SENTIMENT_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -240,15 +273,19 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - NameDeduplicationParameters helps to build the request body in RequestBuilder.
+  # * +params+ - NameDeduplicationParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns the list of deduplicated names.
   def get_name_deduplication(params)
-    check_params params, 'Expects a NameDeduplicationParameters type as an argument', NameDeduplicationParameters
+    check_params params,
+                 'Expects a NameDeduplicationParameters type as an argument',
+                 NameDeduplicationParameters
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + NAME_DEDUPLICATION_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + NAME_DEDUPLICATION_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -256,15 +293,19 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - NameTranslationParameters helps to build the request body in RequestBuilder.
+  # * +params+ - NameTranslationParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns the translation of a name.
   def get_name_translation(params)
-    check_params params, 'Expects a NameTranslationParameters type as an argument', NameTranslationParameters
+    check_params params,
+                 'Expects a NameTranslationParameters type as an argument',
+                 NameTranslationParameters
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + NAME_TRANSLATION_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + NAME_TRANSLATION_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -273,15 +314,39 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - NameSimilarityParameters helps to build the request body in RequestBuilder.
+  # * +params+ - NameSimilarityParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns the confidence score of matching 2 names.
   def get_name_similarity(params)
-    check_params params, 'Expects a NameSimilarityParameters type as an argument', NameSimilarityParameters
+    check_params params,
+                 'Expects a NameSimilarityParameters type as an argument',
+                 NameSimilarityParameters
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + NAME_SIMILARITY_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + NAME_SIMILARITY_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
+                  .send_post_request
+  end
+
+  # Compares two addresses and returns a match score from 0 to 1.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - AddressSimilarityParameters helps to build the request body in
+  #   RequestBuilder.
+  #
+  # Returns the confidence score of matching 2 addresses.
+  def get_address_similarity(params)
+    check_params params,
+                 'Expects a AddressSimilarityParameters type as an argument',
+                 AddressSimilarityParameters
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + ADDRESS_SIMILARITY_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -289,7 +354,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of tokens of the input.
   def get_tokens(params)
@@ -297,7 +363,8 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + TOKENS_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + TOKENS_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -305,7 +372,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of linguistic sentences of the input.
   def get_sentences(params)
@@ -313,24 +381,29 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + SENTENCES_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + SENTENCES_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
   #
   # Returns the vectors associated with the text
   #
+  # Deprecated.  Please use `get_semantic_vectors` instead
+  #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
-  # Returns list of linguistic sentences of the input.
+  # Returns the text embedding representation of the input.
   def get_text_embedding(params)
     check_params params
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + TEXT_EMBEDDING, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + TEXT_EMBEDDING, @http_client,
+                       BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -339,7 +412,25 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
+  #
+  # Returns the text embedding representation of the input.
+  def get_semantic_vectors(params)
+    check_params params
+    params = params.load_params
+    RequestBuilder.new(@user_key, @alternate_url + SEMANTIC_VECTORS,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
+                  .send_post_request
+  end
+
+  #
+  # Returns the syntactic structure of the text
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of linguistic sentences of the input.
   def get_syntax_dependencies(params)
@@ -347,7 +438,9 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + SYNTACTIC_DEPENDENCIES_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key,
+                       @alternate_url + SYNTACTIC_DEPENDENCIES_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -356,15 +449,19 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns the transliteration of the input.
   def get_transliteration(params)
-    check_params params, 'Expects a DocumentParameters type as an argument', DocumentParameters
+    check_params params,
+                 'Expects a DocumentParameters type as an argument',
+                 DocumentParameters
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + TRANSLITERATION_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + TRANSLITERATION_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
@@ -372,7 +469,8 @@ class RosetteAPI
   #
   # ==== Attributes
   #
-  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
   #
   # Returns list of topics of the input.
   def get_topics(params)
@@ -380,28 +478,57 @@ class RosetteAPI
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + TOPICS_ENDPOINT, @http_client, params, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + TOPICS_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
+                  .send_post_request
+  end
+
+  # Returns the terms similar to the input
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
+  #
+  # Returns a mapping of languageCode to similar terms
+  def get_similar_terms(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + SIMILAR_TERMS_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
                   .send_post_request
   end
 
   # Gets information about the Rosette API, returns name, build number
   # and build time.
   def info
-    RequestBuilder.new(@user_key, @alternate_url + INFO, @http_client, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + INFO, @http_client,
+                       BINDING_VERSION, @url_parameters)
                   .send_get_request
   end
 
   # Pings the Rosette API for a response indicting that the service is
   # available.
   def ping
-    RequestBuilder.new(@user_key, @alternate_url + PING, @http_client, @url_parameters, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + PING, @http_client,
+                       BINDING_VERSION, @url_parameters)
                   .send_get_request
   end
 
+  # Gets the User-Agent string
+  def user_agent
+    RequestBuilder.new(@user_key, @alternate_url + PING, @http_client,
+                       BINDING_VERSION, @url_parameters).user_agent
+  end
+
   private
 
   # Checks that the right parameter type is being passed in.
-  def check_params(params, message = 'Expects a DocumentParameters type as an argument', type = DocumentParameters)
+  def check_params(params,
+                   message = 'Expects a DocumentParameters type as an argument',
+                   type = DocumentParameters)
     raise BadRequestError.new message unless params.is_a? type
   end
 end