rosette_api 1.9.2 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '099d4aad3982ea728506df650f76cc052e73cb1f5a961400ee222a099383a673'
-  data.tar.gz: '09a4b93c15d4e3529eac7729c4b0f2746bfa1f440fdc354bd94357818623b6c1'
+  metadata.gz: d65a80d194b5956cf0a742db19a6076b05aace36a082697ab01a27fb9be14a2a
+  data.tar.gz: 22f92f9b67f0533c042d32a5c1ee249b5ac4034ba1abab66d317b3ee8658c78c
 SHA512:
-  metadata.gz: 5004bb4bb96f6e1019b866734bcfbc4d3d02620461fded2f047bc024bb2f1b1eeea7fcc9ea9a90f5e37de061be254207d3baf8abfbb57661982b42bbd3a2bb46
-  data.tar.gz: 65453989036aaba78ebcad11bb9c56b8657cba64df94cf3295c6dc502c21d587ef13ab68c0b2111c7543e13e3186157d34c7382ae6f3c0fcdf28db81c37dbe40
+  metadata.gz: ca25172ef0ef615051922a8a849c3d7d11755b806f004df9eb2c0c6a131a8a203cac560aeb72c88224e0078c759553048548883cf74640f4c63168618380cf92
+  data.tar.gz: a3d64fd9539dbacb98489e60ac19d45b6eac4e1f80edf2e8bfc433d3f8713a966448d2ddbbaf87e62a86b6fe76f23189c794a9984a957bfdf207968463882acd

data/lib/rosette_api.rb

@@ -10,7 +10,7 @@ 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.9.2'
+  BINDING_VERSION = '1.12.1'
   # Rosette API language endpoint
   LANGUAGE_ENDPOINT = '/language'.freeze
   # Rosette API morphology endpoint
@@ -37,8 +37,12 @@ class RosetteAPI
   INFO = '/info'.freeze
   # Rosette API ping endpoint
   PING = '/ping'.freeze
-  # Text Embedding endpoint
+  # Text Embedding endpoint (deprecated)
   TEXT_EMBEDDING = '/text-embedding'.freeze
+  # Semantic Vectors endpoint (replaces /text-embedding)
+  SEMANTIC_VECTORS = '/semantics/vector'.freeze
+  # Similar Terms endpoint
+  SIMILAR_TERMS_ENDPOINT = '/semantics/similar'.freeze
   # Syntactic Dependencies endpoint
   SYNTACTIC_DEPENDENCIES_ENDPOINT = '/syntax/dependencies'.freeze
   # Transliteration endpoint
@@ -320,11 +324,13 @@ class RosetteAPI
   #
   # 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.
   #
-  # Returns list of linguistic sentences of the input.
+  # Returns the text embedding representation of the input.
   def get_text_embedding(params)
     check_params params
 
@@ -341,6 +347,21 @@ class RosetteAPI
   #
   # * +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, params, @url_parameters, BINDING_VERSION)
+                  .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)
     check_params params
@@ -384,6 +405,22 @@ class RosetteAPI
                   .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, params, @url_parameters, BINDING_VERSION)
+                  .send_post_request
+  end
+
   # Gets information about the Rosette API, returns name, build number
   # and build time.
   def info

data/tests/tests_spec.rb

@@ -29,7 +29,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "language"}', headers: {})
     end
     it 'test language' do
@@ -63,7 +63,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "morphology/complete"}', headers: {})
     end
     it 'test morphology complete' do
@@ -84,7 +84,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "morphology/compound-components"}', headers: {})
     end
     it 'test morphology compound components' do
@@ -105,7 +105,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "morphology/han-readings"}', headers: {})
     end
     it 'test morphology han readings' do
@@ -126,7 +126,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "morphology/parts-of-speech"}', headers: {})
     end
     it 'test morphology parts of speech' do
@@ -147,7 +147,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "morphology/lemmas"}', headers: {})
     end
     it 'test morphology lemmas' do
@@ -168,7 +168,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "entities"}', headers: {})
     end
     it 'test entities' do
@@ -190,7 +190,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "entities"}', headers: {})
     end
     it 'test entities without qids' do
@@ -221,7 +221,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "categories"}', headers: {})
     end
     it 'test categories' do
@@ -242,7 +242,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "relationships"}', headers: {})
     end
     it 'test relationships' do
@@ -264,7 +264,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
           .to_return(status: 200, body: '{"test": "name-translation"}', headers: {})
     end
     it 'test name translation' do
@@ -291,7 +291,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "name-similarity"}', headers: {})
     end
     it 'test name similarity' do
@@ -329,7 +329,7 @@ describe RosetteAPI do
                         'User-Agent' => @user_agent,
                         'X-Rosetteapi-Key' => '0123456789',
                         'X-Rosetteapi-Binding' => 'ruby',
-                        'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                        'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "name-deduplication"}', headers: {})
 
       nothresh_json = { names: names.map(&:load_param) }.to_json
@@ -342,7 +342,7 @@ describe RosetteAPI do
                         'User-Agent' => @user_agent,
                         'X-Rosetteapi-Key' => '0123456789',
                         'X-Rosetteapi-Binding' => 'ruby',
-                        'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                        'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "name-deduplication"}', headers: {})
     end
     it 'test name deduplication' do
@@ -393,7 +393,7 @@ describe RosetteAPI do
                         'User-Agent' => @user_agent,
                         'X-Rosetteapi-Key' => '0123456789',
                         'X-Rosetteapi-Binding' => 'ruby',
-                        'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                        'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "transliteration"}', headers: {})
     end
     it 'test transliteration' do
@@ -426,7 +426,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "tokens"}', headers: {})
     end
     it 'test tokens' do
@@ -447,7 +447,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "topics"}', headers: {})
     end
     it 'test topics' do
@@ -468,7 +468,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "sentences"}', headers: {})
     end
     it 'test sentences' do
@@ -519,7 +519,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2',
+                         'X-Rosetteapi-Binding-Version' => '1.12.1',
                          'X-RosetteApi-App' => 'ruby-app' })
         .to_return(status: 200, body: '{"test": "language"}', headers: {})
     end
@@ -546,9 +546,9 @@ describe RosetteAPI do
     end
   end
 
-  describe '.get_text_embedding' do
+  describe '.get_similar_terms' do
     before do
-      stub_request(:post, 'https://api.rosette.com/rest/v1/text-embedding')
+      stub_request(:post, 'https://api.rosette.com/rest/v1/semantics/similar')
         .with(body: @json,
               headers: { 'Accept' => 'application/json',
                          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
@@ -556,13 +556,33 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "language"}', headers: {})
     end
-    it 'test text_embedding' do
+    it 'test similar_terms' do
+      params = DocumentParameters.new(content: @content, options: { "resultLanguages" => [ "spa", "deu", "jpn" ] })
+      response = RosetteAPI.new('0123456789').get_similar_terms(params)
+      expect(response).instance_of? Hash
+    end
+  end
+
+  describe '.get_semantic_vectors' do
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/semantics/vector')
+        .with(body: @json,
+              headers: { 'Accept' => 'application/json',
+                         'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                         'Content-Type' => 'application/json',
+                         'User-Agent' => @user_agent,
+                         'X-Rosetteapi-Key' => '0123456789',
+                         'X-Rosetteapi-Binding' => 'ruby',
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
+        .to_return(status: 200, body: '{"test": "language"}', headers: {})
+    end
+    it 'test semantic_vectors' do
       params = DocumentParameters.new
       params.content = @content
-      response = RosetteAPI.new('0123456789').get_text_embedding(params)
+      response = RosetteAPI.new('0123456789').get_semantic_vectors(params)
       expect(response).instance_of? Hash
     end
   end
@@ -577,7 +597,7 @@ describe RosetteAPI do
                          'User-Agent' => @user_agent,
                          'X-Rosetteapi-Key' => '0123456789',
                          'X-Rosetteapi-Binding' => 'ruby',
-                         'X-Rosetteapi-Binding-Version' => '1.9.2' })
+                         'X-Rosetteapi-Binding-Version' => '1.12.1' })
         .to_return(status: 200, body: '{"test": "language"}', headers: {})
     end
     it 'test syntax_dependencies' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rosette_api
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.12.1
 platform: ruby
 authors:
 - Basis Technology Corp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubysl-securerandom
@@ -62,8 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 2
 summary: Rosette API gem that supports multilingual text-analytics.