Merge branch 'develop'

Author: Chris Park

examples/text_embedding.rb

@@ -0,0 +1,14 @@
+require 'rosette_api'
+
+api_key, url = ARGV
+
+if !url
+  rosette_api = RosetteAPI.new(api_key)
+else
+  rosette_api = RosetteAPI.new(api_key, url)
+end
+
+embeddings_data = 'Cambridge, Massachusetts'
+params = DocumentParameters.new(content: embeddings_data)
+response = rosette_api.get_text_embedding(params)
+puts JSON.pretty_generate(response)

lib/request_builder.rb

@@ -9,19 +9,24 @@
 class RequestBuilder
   # Alternate Rosette API URL
   attr_reader :alternate_url
+  # Rosette API HTTP client
+  attr_reader :http_client
   # Parameters to build the body of the request from
   attr_accessor :params
   # Rosette API key
   attr_accessor :user_key
   # Rosette API binding version
   attr_accessor :binding_version
 
-  def initialize(user_key, alternate_url, params = {}, binding_version) #:notnew:
+
+  def initialize(user_key, alternate_url, http_client, params = {}, binding_version) #:notnew:
     @user_key = user_key
     @alternate_url = alternate_url
+    @http_client = http_client
     @params = params
     @retries = 5
     @binding_version = binding_version
+
   end
 
   # Prepares a plain POST request for Rosette API.
@@ -34,8 +39,6 @@ def initialize(user_key, alternate_url, params = {}, binding_version) #:notnew:
   def prepare_plain_request(params)
     begin
       uri = URI.parse @alternate_url
-      http = Net::HTTP.new uri.host, uri.port
-      http.use_ssl = uri.scheme == 'https'
       request = Net::HTTP::Post.new uri.request_uri
     rescue
       raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
@@ -60,7 +63,7 @@ def prepare_plain_request(params)
     request['X-RosetteAPI-Binding-Version'] = @binding_version
     request.body = params.to_json
 
-    [http, request]
+    [@http_client, request]
   end
 
   # Prepares a multipart/form-data POST request for Rosette API.
@@ -99,8 +102,6 @@ def prepare_multipart_request(params)
     # Create the HTTP objects
     begin
       uri = URI.parse @alternate_url
-      http = Net::HTTP.new uri.host, uri.port
-      http.use_ssl = uri.scheme == 'https'
       request = Net::HTTP::Post.new uri.request_uri
     rescue
       raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
@@ -125,7 +126,7 @@ def prepare_multipart_request(params)
     request.add_field 'X-RosetteAPI-Binding-Version', @binding_version
     request.body = post_body.join
 
-    [http, request]
+    [@http_client, request]
   end
 
   # Sends a GET request to Rosette API.
@@ -134,16 +135,14 @@ def prepare_multipart_request(params)
   def send_get_request
     begin
       uri = URI.parse @alternate_url
-      http = Net::HTTP.new uri.host, uri.port
-      http.use_ssl = uri.scheme == 'https'
 
       request = Net::HTTP::Get.new uri.request_uri
     rescue
       raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
     end
     request['X-RosetteAPI-Key'] = @user_key
 
-    self.get_response http, request
+    self.get_response @http_client, request
   end
 
   # Sends a POST request to Rosette API.

lib/rosette_api.rb

@@ -9,7 +9,7 @@
 # This class allows you to access all Rosette API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.2.0'
+  BINDING_VERSION = '1.3.0'
   # Rosette API language endpoint
   LANGUAGE_ENDPOINT = '/language'
   # Rosette API morphology endpoint
@@ -34,6 +34,8 @@ class RosetteAPI
   INFO = '/info'
   # Rosette API ping endpoint
   PING = '/ping'
+  # Text Embedding endpoint
+  TEXT_EMBEDDING = '/text-embedding'
 
   # Rosette API key
   attr_accessor :user_key
@@ -49,6 +51,10 @@ def initialize(user_key, alternate_url = 'https://api.rosette.com/rest/v1') #:no
     if @alternate_url.to_s.end_with?('/')
       @alternate_url = alternate_url.to_s.slice(0..-2)
     end
+
+    uri = URI.parse alternate_url
+    @http_client = Net::HTTP.new uri.host, uri.port
+    @http_client.use_ssl = uri.scheme == 'https'
   end
 
   # Identifies in which language(s) the input is written.
@@ -63,7 +69,7 @@ def get_language(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + LANGUAGE_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + LANGUAGE_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -81,7 +87,7 @@ def get_morphology_complete(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/complete', params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/complete', @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -98,7 +104,7 @@ def get_compound_components(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/compound-components', params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/compound-components', @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -115,7 +121,7 @@ def get_han_readings(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/han-readings', params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/han-readings', @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -131,7 +137,7 @@ def get_lemmas(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/lemmas', params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/lemmas', @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -148,7 +154,7 @@ def get_parts_of_speech(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/parts-of-speech', params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + MORPHOLOGY_ENDPOINT + '/parts-of-speech', @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -168,7 +174,7 @@ def get_entities(params, resolve_entities = false)
     params = params.load_params
 
     endpoint = resolve_entities ? (ENTITIES_ENDPOINT + '/linked') : ENTITIES_ENDPOINT
-    RequestBuilder.new(@user_key, @alternate_url + endpoint, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -200,7 +206,7 @@ def get_categories(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + CATEGORIES_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + CATEGORIES_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -216,7 +222,7 @@ def get_relationships(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + RELATIONSHIPS_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + RELATIONSHIPS_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -232,7 +238,7 @@ def get_sentiment(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + SENTIMENT_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + SENTIMENT_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -248,7 +254,7 @@ def name_translation(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + NAME_TRANSLATION_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + NAME_TRANSLATION_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -265,7 +271,7 @@ def name_similarity(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + NAME_SIMILARITY_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + NAME_SIMILARITY_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -281,7 +287,7 @@ def get_tokens(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + TOKENS_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + TOKENS_ENDPOINT, @http_client, params, BINDING_VERSION)
                   .send_post_request
   end
 
@@ -297,21 +303,37 @@ def get_sentences(params)
 
     params = params.load_params
 
-    RequestBuilder.new(@user_key, @alternate_url + SENTENCES_ENDPOINT, params, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + SENTENCES_ENDPOINT, @http_client, params, BINDING_VERSION)
+                  .send_post_request
+  end
+  #
+  # Returns the vectors associated with the text
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of linguistic sentences 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, BINDING_VERSION)
                   .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, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + INFO, @http_client, BINDING_VERSION)
                   .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, BINDING_VERSION)
+    RequestBuilder.new(@user_key, @alternate_url + PING, @http_client, BINDING_VERSION)
                   .send_get_request
   end