class RosetteAPI

This class allows you to access all Analytics API endpoints.

Constants

ADDRESS_SIMILARITY_ENDPOINT: API address-similarity endpoint
BINDING_VERSION: Version of Ruby binding
CATEGORIES_ENDPOINT: API categories endpoint
ENTITIES_ENDPOINT: API entities endpoint
EVENTS_ENDPOINT: API events endpoint
INFO: API info endpoint
LANGUAGE_ENDPOINT: API language endpoint
MORPHOLOGY_ENDPOINT: API morphology endpoint
NAME_DEDUPLICATION_ENDPOINT: Name Deduplication endpoint
NAME_SIMILARITY_ENDPOINT: API name-similarity endpoint
NAME_TRANSLATION_ENDPOINT: API name-translation endpoint
PING: API ping endpoint
RECORD_SIMILARITY_ENDPOINT: Record Similarity endpoint
RELATIONSHIPS_ENDPOINT: API relationships endpoint
SEMANTIC_VECTORS: Semantic Vectors endpoint (replaces deprecated /text-embedding)
SENTENCES_ENDPOINT: API sentences endpoint
SENTIMENT_ENDPOINT: API sentiment endpoint
SIMILAR_TERMS_ENDPOINT: Similar Terms endpoint
SYNTACTIC_DEPENDENCIES_ENDPOINT: Syntactic Dependencies endpoint
TOKENS_ENDPOINT: API tokens endpoint
TOPICS_ENDPOINT: Topics endpoint
TRANSLITERATION_ENDPOINT: Transliteration endpoint

Attributes

alternate_url [RW]

Alternate API URL

custom_headers [RW]

custom API headers

url_parameters [RW]

URL query parameter(s)

user_key [RW]

API key

Public Class Methods

new (user_key, alternate_url = 'https://analytics.babelstreet.com/rest/v1')

Source

# File rosette_api.rb, line 71
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

  @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
  @http_client.use_ssl = uri.scheme == 'https'
end

Public Instance Methods

get_address_similarity (params)

Source

# File rosette_api.rb, line 344
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

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.

get_categories (params)

Source

# File rosette_api.rb, line 229
def get_categories(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + CATEGORIES_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts Tier 1 contextual categories from the input.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns the contextual categories identified in the input.

get_compound_components (params)

Source

# File rosette_api.rb, line 132
def get_compound_components(params)
  check_params params

  params = params.load_params

  endpoint = "#{MORPHOLOGY_ENDPOINT}/compound-components"
  RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                     BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts compound-components from the input.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns list of components for each compound word of the input for supported languages.

get_entities (params)

Source

# File rosette_api.rb, line 210
def get_entities(params)
  check_params params

  params = params.load_params

  endpoint = ENTITIES_ENDPOINT
  RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                     BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts entities from the input.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns each entity extracted from the input.

get_events (params)

Source

# File rosette_api.rb, line 530
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

Returns the events of the input

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns the events of the input

get_han_readings (params)

Source

# File rosette_api.rb, line 152
def get_han_readings(params)
  check_params params

  params = params.load_params

  endpoint = "#{MORPHOLOGY_ENDPOINT}/han-readings"
  RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                     BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts Han-readings from the input.

Attributes

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.

get_language (params)

Source

# File rosette_api.rb, line 92
def get_language(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + LANGUAGE_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Identifies in which language(s) the input is written.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns list of candidate languages in order of descending confidence.

get_lemmas (params)

Source

# File rosette_api.rb, line 171
def get_lemmas(params)
  check_params params

  params = params.load_params

  endpoint = "#{MORPHOLOGY_ENDPOINT}/lemmas"
  RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                     BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts lemmas from the input.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns list of lemmas for each token of the input for supported languages.

get_morphology_complete (params)

Source

# File rosette_api.rb, line 112
def get_morphology_complete(params)
  check_params params

  params = params.load_params

  endpoint = "#{MORPHOLOGY_ENDPOINT}/complete"
  RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                     BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts parts-of-speech, lemmas (dictionary form), compound components, and Han-readings for each token in the input.

Attributes

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.

get_name_deduplication (params)

Source

# File rosette_api.rb, line 283
def get_name_deduplication(params)
  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, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

De-duplicates a list of names.

Attributes

params - NameDeduplicationParameters helps to build the request body in RequestBuilder.

Returns the list of deduplicated names.

get_name_similarity (params)

Source

# File rosette_api.rb, line 324
def get_name_similarity(params)
  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, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Compares two entity names (person, location, or organization) and returns a match score from 0 to 1.

Attributes

params - NameSimilarityParameters helps to build the request body in RequestBuilder.

Returns the confidence score of matching 2 names.

get_name_translation (params)

Source

# File rosette_api.rb, line 303
def get_name_translation(params)
  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, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Translates a given name to a supported specified language.

Attributes

params - NameTranslationParameters helps to build the request body in RequestBuilder.

Returns the translation of a name.

get_parts_of_speech (params)

Source

# File rosette_api.rb, line 191
def get_parts_of_speech(params)
  check_params params

  params = params.load_params

  endpoint = "#{MORPHOLOGY_ENDPOINT}/parts-of-speech"
  RequestBuilder.new(@user_key, @alternate_url + endpoint, @http_client,
                     BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts parts-of-speech from the input.

Attributes

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.

get_record_similarity (params)

Source

# File rosette_api.rb, line 364
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

Compares records and returns similarity information.

Attributes

params - RecordSimilarityParameters helps to build the request body in RequestBuilder.

Returns record similarity results.

get_relationships (params)

Source

# File rosette_api.rb, line 247
def get_relationships(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + RELATIONSHIPS_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Extracts relationships from the input.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns each relationship extracted from the input.

get_semantic_vectors (params)

Source

# File rosette_api.rb, line 437
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 vectors associated with the text

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns the text embedding representation of the input.

get_sentences (params)

Source

# File rosette_api.rb, line 402
def get_sentences(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + SENTENCES_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Divides the input into sentences.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns list of linguistic sentences of the input.

get_sentiment (params)

Source

# File rosette_api.rb, line 265
def get_sentiment(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + SENTIMENT_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Analyzes the positive and negative sentiment expressed by the input.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns sentiment analysis results.

get_similar_terms (params)

Source

# File rosette_api.rb, line 512
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

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

get_syntax_dependencies (params)

Source

# File rosette_api.rb, line 454
def get_syntax_dependencies(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key,
                     @alternate_url + SYNTACTIC_DEPENDENCIES_ENDPOINT,
                     @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.

get_text_embedding (params)

Source

# File rosette_api.rb, line 423
def get_text_embedding(params)
  @log.warn('get_text_embedding is deprecated. Please use get_semantic_vectors instead.')
  get_semantic_vectors(params)
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.

Returns the text embedding representation of the input.

get_tokens (params)

Source

# File rosette_api.rb, line 384
def get_tokens(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + TOKENS_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Divides the input into tokens.

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns list of tokens of the input.

get_topics (params)

Source

# File rosette_api.rb, line 494
def get_topics(params)
  check_params params

  params = params.load_params

  RequestBuilder.new(@user_key, @alternate_url + TOPICS_ENDPOINT,
                     @http_client, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Divides the input into topics (key phrases and concepts).

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns list of topics of the input.

get_transliteration (params)

Source

# File rosette_api.rb, line 474
def get_transliteration(params)
  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, BINDING_VERSION, params, @url_parameters)
                .send_post_request
end

Returns the transliteration of the content

Attributes

params - DocumentParameters helps to build the request body in RequestBuilder.

Returns the transliteration of the input.

info ()

Source

# File rosette_api.rb, line 542
def info
  RequestBuilder.new(@user_key, @alternate_url + INFO, @http_client,
                     BINDING_VERSION, @url_parameters)
                .send_get_request
end

Gets information about the API, returns name, build number and build time.

ping ()

Source

# File rosette_api.rb, line 550
def ping
  RequestBuilder.new(@user_key, @alternate_url + PING, @http_client,
                     BINDING_VERSION, @url_parameters)
                .send_get_request
end

Pings the API for a response indicting that the service is available.

user_agent ()

Source

# File rosette_api.rb, line 557
def user_agent
  RequestBuilder.new(@user_key, @alternate_url + PING, @http_client,
                     BINDING_VERSION, @url_parameters).user_agent
end

Gets the User-Agent string