rosette_api 1.14.4 → 1.37.0

data/lib/rosette_api.rb

@@ -5,73 +5,76 @@ require_relative 'document_parameters'
 require_relative 'name_deduplication_parameters'
 require_relative 'name_translation_parameters'
 require_relative 'name_similarity_parameters'
+require_relative 'record_similarity_parameters'
 require_relative 'address_similarity_parameters'
 require_relative 'rosette_api_error'
 require_relative 'bad_request_error'
 require_relative 'bad_request_format_error'
+require 'logger'
 
-# This class allows you to access all Rosette API endpoints.
+# This class allows you to access all Analytics API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.14.4'
-  # Rosette API language endpoint
+  BINDING_VERSION = '1.37.0'
+  # API address-similarity endpoint
+  ADDRESS_SIMILARITY_ENDPOINT = '/address-similarity'
+  # API categories endpoint
+  CATEGORIES_ENDPOINT = '/categories'
+  # API entities endpoint
+  ENTITIES_ENDPOINT = '/entities'
+  # API events endpoint
+  EVENTS_ENDPOINT = '/events'
+  # API info endpoint
+  INFO = '/info'
+  # API language endpoint
   LANGUAGE_ENDPOINT = '/language'
-  # Rosette API morphology endpoint
+  # API morphology endpoint
   MORPHOLOGY_ENDPOINT = '/morphology'
-  # Rosette API entities endpoint
-  ENTITIES_ENDPOINT = '/entities'
-  # Rosette API categories endpoint
-  CATEGORIES_ENDPOINT = '/categories'
-  # Rosette API relationships endpoint
-  RELATIONSHIPS_ENDPOINT = '/relationships'
-  # Rosette API sentiment endpoint
-  SENTIMENT_ENDPOINT = '/sentiment'
   # Name Deduplication endpoint
   NAME_DEDUPLICATION_ENDPOINT = '/name-deduplication'
-  # Rosette API name-translation endpoint
-  NAME_TRANSLATION_ENDPOINT = '/name-translation'
-  # Rosette API name-similarity endpoint
+  # API name-similarity endpoint
   NAME_SIMILARITY_ENDPOINT = '/name-similarity'
-  # Rosette API address-similarity endpoint
-  ADDRESS_SIMILARITY_ENDPOINT = '/address-similarity'
-  # Rosette API tokens endpoint
-  TOKENS_ENDPOINT = '/tokens'
-  # Rosette API sentences endpoint
-  SENTENCES_ENDPOINT = '/sentences'
-  # Rosette API info endpoint
-  INFO = '/info'
-  # Rosette API ping endpoint
+  # API name-translation endpoint
+  NAME_TRANSLATION_ENDPOINT = '/name-translation'
+  # API ping endpoint
   PING = '/ping'
-  # Text Embedding endpoint (deprecated)
-  TEXT_EMBEDDING = '/text-embedding'
-  # Semantic Vectors endpoint (replaces /text-embedding)
+  # Record Similarity endpoint
+  RECORD_SIMILARITY_ENDPOINT = '/record-similarity'
+  # API relationships endpoint
+  RELATIONSHIPS_ENDPOINT = '/relationships'
+  # Semantic Vectors endpoint (replaces deprecated /text-embedding)
   SEMANTIC_VECTORS = '/semantics/vector'
+  # API sentences endpoint
+  SENTENCES_ENDPOINT = '/sentences'
+  # API sentiment endpoint
+  SENTIMENT_ENDPOINT = '/sentiment'
   # Similar Terms endpoint
   SIMILAR_TERMS_ENDPOINT = '/semantics/similar'
   # Syntactic Dependencies endpoint
   SYNTACTIC_DEPENDENCIES_ENDPOINT = '/syntax/dependencies'
-  # Transliteration endpoint
-  TRANSLITERATION_ENDPOINT = '/transliteration'
+  # API tokens endpoint
+  TOKENS_ENDPOINT = '/tokens'
   # Topics endpoint
   TOPICS_ENDPOINT = '/topics'
+  # Transliteration endpoint
+  TRANSLITERATION_ENDPOINT = '/transliteration'
 
-  # Rosette API key
+  # API key
   attr_accessor :user_key
-  # Alternate Rosette API URL
+  # Alternate API URL
   attr_accessor :alternate_url
-  # custom Rosette API headers
+  # custom API headers
   attr_accessor :custom_headers
   # URL query parameter(s)
   attr_accessor :url_parameters
 
-  def initialize(user_key, alternate_url = 'https://api.rosette.com/rest/v1')
+  def initialize(user_key, alternate_url = 'https://analytics.babelstreet.com/rest/v1')
+    @log = Logger.new($stdout)
     @user_key = user_key
     @alternate_url = alternate_url
     @url_parameters = nil
 
-    if @alternate_url.to_s.end_with?('/')
-      @alternate_url = alternate_url.to_s.slice(0..-2)
-    end
+    @alternate_url = alternate_url.to_s.slice(0..-2) if @alternate_url.to_s.end_with?('/')
 
     uri = URI.parse alternate_url
     @http_client = Net::HTTP.new uri.host, uri.port
@@ -111,7 +114,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/complete'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/complete"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -131,7 +134,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/compound-components'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/compound-components"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -151,7 +154,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/han-readings'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/han-readings"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -170,7 +173,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/lemmas'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/lemmas"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -190,7 +193,7 @@ class RosetteAPI
 
     params = params.load_params
 
-    endpoint = MORPHOLOGY_ENDPOINT + '/parts-of-speech'
+    endpoint = "#{MORPHOLOGY_ENDPOINT}/parts-of-speech"
     RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                        BINDING_VERSION, params, @url_parameters)
                   .send_post_request
@@ -350,6 +353,26 @@ class RosetteAPI
                   .send_post_request
   end
 
+  # Compares records and returns similarity information.
+  #
+  # ==== Attributes
+  #
+  # * +params+ - RecordSimilarityParameters helps to build the request body in
+  #   RequestBuilder.
+  #
+  # Returns record similarity results.
+  def get_record_similarity(params)
+    check_params params,
+                 'Expects a RecordSimilarityParameters type as an argument',
+                 RecordSimilarityParameters
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + RECORD_SIMILARITY_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
+                  .send_post_request
+  end
+
   # Divides the input into tokens.
   #
   # ==== Attributes
@@ -398,13 +421,8 @@ class RosetteAPI
   #
   # 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,
-                       BINDING_VERSION, params, @url_parameters)
-                  .send_post_request
+    @log.warn('get_text_embedding is deprecated. Please use get_semantic_vectors instead.')
+    get_semantic_vectors(params)
   end
 
   #
@@ -501,7 +519,25 @@ class RosetteAPI
                   .send_post_request
   end
 
-  # Gets information about the Rosette API, returns name, build number
+  # Returns the events of the input
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in
+  #   RequestBuilder.
+  #
+  # Returns the events of the input
+  def get_events(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + EVENTS_ENDPOINT,
+                       @http_client, BINDING_VERSION, params, @url_parameters)
+                  .send_post_request
+  end
+
+  # Gets information about the API, returns name, build number
   # and build time.
   def info
     RequestBuilder.new(@user_key, @alternate_url + INFO, @http_client,
@@ -509,7 +545,7 @@ class RosetteAPI
                   .send_get_request
   end
 
-  # Pings the Rosette API for a response indicting that the service is
+  # Pings the API for a response indicting that the service is
   # available.
   def ping
     RequestBuilder.new(@user_key, @alternate_url + PING, @http_client,
@@ -530,5 +566,9 @@ class RosetteAPI
                    message = 'Expects a DocumentParameters type as an argument',
                    type = DocumentParameters)
     raise BadRequestError.new message unless params.is_a? type
+
+    return unless defined?(params.genre) && !params.genre.nil?
+
+    @log.warn('The genre parameter is deprecated and will be removed in a future release.')
   end
 end

data/lib/rosette_api_error.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-# This class encapsulates all Rosette API server errors encountered during
+# This class encapsulates all API server errors encountered during
 # requests.
 class RosetteAPIError < StandardError
-  # Rosette API error's status code
+  # API error's status code
   attr_accessor :status_code
-  # Rosette API error's message
+  # API error's message
   attr_accessor :message
 
-  def initialize(status_code, message) #:notnew:
+  def initialize(status_code, message) # :notnew:
     @status_code = status_code
     @message = message
+    super(message)
   end
 end

metadata

@@ -1,36 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rosette_api
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.37.0
 platform: ruby
 authors:
-- Basis Technology Corp
-autorequire: 
+- Analytics by Babel Street
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rubysl-securerandom
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-description: 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.
-email: support@rosette.com
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Our product is a full text processing pipeline from data preparation
+  to extracting the most relevant information andanalysis utilizing precise, focused
+  AI that has built-in human understanding. Text Analytics provides foundationallinguistic
+  analysis for identifying languages and relating words. The result is enriched and
+  normalized text forhigh-speed search and processing without translation.Text Analytics
+  extracts events and entities — people, organizations, and places — from unstructured
+  text and adds thestructure of associating those entities into events that deliver
+  only the necessary information for near real-timedecision 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 searchbeyond keywords to words with the same meaning, even in
+  other languages. Sentiment analysis and topic extraction helpfilter results to what’s
+  relevant.
+email: analyticssupport@babelstreet.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -41,6 +33,7 @@ files:
 - examples/address_similarity.rb
 - examples/categories.rb
 - examples/entities.rb
+- examples/events.rb
 - examples/info.rb
 - examples/language.rb
 - examples/language_multilingual.rb
@@ -49,10 +42,12 @@ files:
 - examples/morphology_han-readings.rb
 - examples/morphology_lemmas.rb
 - examples/morphology_parts-of-speech.rb
+- examples/multipart_language_file.rb
 - examples/name_deduplication.rb
 - examples/name_similarity.rb
 - examples/name_translation.rb
 - examples/ping.rb
+- examples/record_similarity.rb
 - examples/relationships.rb
 - examples/semantic_vectors.rb
 - examples/sentences.rb
@@ -71,14 +66,15 @@ files:
 - lib/name_parameter.rb
 - lib/name_similarity_parameters.rb
 - lib/name_translation_parameters.rb
+- lib/record_similarity_parameters.rb
 - lib/request_builder.rb
 - lib/rosette_api.rb
 - lib/rosette_api_error.rb
-homepage: https://developer.rosette.com/
+homepage: https://developer.babelstreet.com/
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -86,15 +82,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
-summary: A Ruby interface for Rosette Text Analytics Platform.
+summary: A Ruby interface for Babel Street Analytics Server and Hosted Services
 test_files: []