rosette_api 1.12.1 → 1.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d65a80d194b5956cf0a742db19a6076b05aace36a082697ab01a27fb9be14a2a
-  data.tar.gz: 22f92f9b67f0533c042d32a5c1ee249b5ac4034ba1abab66d317b3ee8658c78c
+  metadata.gz: 88f16158b8883961fecc410ce85c874914d8610a3e179955f5d2429fb2c4b7ab
+  data.tar.gz: 818932647be367d98c903e4487ba52bd8164f686f0c16be791a8cc54a3b30cc5
 SHA512:
-  metadata.gz: ca25172ef0ef615051922a8a849c3d7d11755b806f004df9eb2c0c6a131a8a203cac560aeb72c88224e0078c759553048548883cf74640f4c63168618380cf92
-  data.tar.gz: a3d64fd9539dbacb98489e60ac19d45b6eac4e1f80edf2e8bfc433d3f8713a966448d2ddbbaf87e62a86b6fe76f23189c794a9984a957bfdf207968463882acd
+  metadata.gz: c1cc5483c3e5e4ed59104c82a14c548b303f85d7be9bb74551b8dbec467de16b15b23fbc9bf7b4374aade07f41bd1d2ac2b16ec509293ceeccb4ca5f35922650
+  data.tar.gz: 0fa5063ae2d6765314df3b33c1a0620b974b24a8c0c3b627c5617b75ca9e13d1ac1d62a2d4522464004e654c24f4217c52e164d606690ff8697ccd83389fa2f2

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2016-2019 Basis Technology Corporation.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,38 @@
+<a href="https://www.rosette.com"><img src="https://s3.amazonaws.com/styleguide.basistech.com/logos/rosette-logo.png" width="181" height="47" /></a>
+
+---
+
+[![Build Status](https://travis-ci.org/rosette-api/ruby.svg?branch=develop)](https://travis-ci.org/rosette-api/ruby) [![Gem Version](https://badge.fury.io/rb/rosette_api.svg)](https://badge.fury.io/rb/rosette_api)
+
+## Rosette API
+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.
+
+## Rosette API Access
+- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
+- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
+
+## Quick Start
+
+#### Installation
+
+`gem install rosette_api`
+
+#### Examples
+View small example programs for each Rosette endpoint
+in the [examples](https://github.com/rosette-api/ruby/tree/develop/examples) directory.
+
+#### Documentation & Support
+- [Binding API](https://rosette-api.github.io/ruby/)
+- [Rosette Platform API](https://developer.rosette.com/features-and-functions)
+- [Binding Release Notes](https://github.com/rosette-api/ruby/wiki/Release-Notes)
+- [Rosette Platform Release Notes](https://support.rosette.com/hc/en-us/articles/360018354971-Release-Notes)
+- [Binding/Rosette Platform Compatibility](https://developer.rosette.com/features-and-functions?ruby#)
+- [Support](https://support.rosette.com)
+- [Binding License: Apache 2.0](https://github.com/rosette-api/ruby/blob/develop/LICENSE)
+
+## Binding Developer Information
+If you are modifying the binding code, please refer to the [developer README](https://github.com/rosette-api/ruby/tree/develop/DEVELOPER.md) file.
+

data/examples/README.md

@@ -0,0 +1,36 @@
+## Endpoint Examples
+
+These examples are scripts that can be run independently to demonstrate the Rosette API functionality.
+
+Each example file demonstrates one of the capabilities of the Rosette Platform. Each example, when run, prints its output to the console.
+
+Here are some methods for running the examples.  Each example will also accept an optional parameter for
+overriding the default URL.  To use, place the url parameter after the key parameter.
+
+A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolchain also supports it.
+
+#### Docker/Latest Version From RubyGems
+```
+git clone git@github.com:rosette-api/ruby.git
+cd ruby
+docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+
+gem install rosette_api
+
+cd /source/examples
+ruby ping.rb $API_KEY
+```
+
+#### Docker/Latest Source
+```
+git clone git@github.com:rosette-api/ruby.git
+cd ruby
+docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+
+cd /source
+gem build rosette_api.gemspec
+gem install rosette_api*.gem
+
+cd examples
+ruby ping.rb $API_KEY
+```

data/examples/address_similarity.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+begin
+  address1 = AddressParameter.new(
+    house_number: '1600',
+    road: 'Pennsylvania Ave NW',
+    city: 'Washington',
+    state: 'DC',
+    post_code: '20500'
+  )
+  address2 = AddressParameter.new(
+    house_number: '160',
+    road: 'Pennsilvana Avenue',
+    city: 'Washington',
+    state: 'D.C.',
+    post_code: '20500'
+  )
+  params = AddressSimilarityParameters.new(address1, address2)
+  response = rosette_api.get_address_similarity(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/categories.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+categories_url_data =
+  'https://onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-' \
+  'begins-filming-in-boston-in-june/'
+begin
+  params = DocumentParameters.new(content_uri: categories_url_data)
+  response = rosette_api.get_categories(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/entities.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+entities_text_data = 'The Securities and Exchange Commission today ' \
+  'announced the leadership of the agency\'s trial unit. Bridget Fitzpatrick ' \
+  'has been named Chief Litigation Counsel of the SEC and David Gottesman ' \
+  'will continue to serve as the agency\'s Deputy Chief Litigation Counsel. ' \
+  'Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as ' \
+  'Co-Acting Chief Litigation Counsel.  In that role, they were jointly ' \
+  'responsible for supervising the trial unit at the agency\'s Washington ' \
+  'D.C. headquarters as well as coordinating with litigators in the SEC\'s ' \
+  '11 regional offices around the country.'
+begin
+  params = DocumentParameters.new(content: entities_text_data,
+                                  genre: 'social-media')
+  response = rosette_api.get_entities(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/info.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+response = rosette_api.info
+begin
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/language.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+language_data = 'Por favor Señorita, says the man.'
+begin
+  params = DocumentParameters.new(content: language_data)
+  params.custom_headers = { 'X-RosetteAPI-App' => 'ruby-app' }
+  response = rosette_api.get_language(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/language_multilingual.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+language_multilingual_data = 'On Thursday, as protesters gathered in ' \
+  'Washington D.C., the United States Federal Communications Commission ' \
+  'under Chairman Ajit Pai voted 3-2 to overturn a 2015 decision, commonly ' \
+  'called Net Neutrality, that forbade Internet service providers (ISPs) ' \
+  'such as Verizon, Comcast, and AT&T from blocking individual websites or ' \
+  'charging websites or customers more for faster load times.  Quatre ' \
+  'femmes ont été nommées au Conseil de rédaction de la loi du Qatar. Jeudi, ' \
+  'le décret royal du Qatar a annoncé que 28 nouveaux membres ont été nommés ' \
+  'pour le Conseil de la Choura du pays.  ذكرت مصادر أمنية يونانية، أن 9 موقوفين من منظمة \"د هـ ك ب ج\" الذين كانت قد أوقفتهم الشرطة اليونانية في وقت سابق كانوا يخططون لاغتيال الرئيس التركي رجب طيب أردوغان.'
+
+begin
+  params = DocumentParameters.new(content: language_multilingual_data)
+  params.rosette_options = { 'multilingual' => 'true' }
+  params.custom_headers = { 'X-RosetteAPI-App' => 'ruby-app' }
+  response = rosette_api.get_language(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/morphology_complete.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+morphology_complete_data = 'The quick brown fox jumped over the lazy ' \
+  'dog. 👍🏾 Yes he did. B)'
+begin
+  params = DocumentParameters.new(content: morphology_complete_data)
+  response = rosette_api.get_morphology_complete(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/morphology_compound_components.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+morphology_compound_components_data = 'Rechtsschutzversicherungsgesellschaften'
+begin
+  params = DocumentParameters.new(
+    content: morphology_compound_components_data
+  )
+  response = rosette_api.get_compound_components(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/morphology_han_readings.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+morphology_han_readings_data = '北京大学生物系主任办公室内部会议'
+begin
+  params = DocumentParameters.new(content: morphology_han_readings_data)
+  response = rosette_api.get_han_readings(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/morphology_lemmas.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+morphology_lemmas_data =
+  'The fact is that the geese just went back to get a rest and I\'m not ' \
+  'banking on their return soon'
+begin
+  params = DocumentParameters.new(content: morphology_lemmas_data)
+  response = rosette_api.get_lemmas(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/morphology_parts_of_speech.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+morphology_parts_of_speech_data =
+  'The fact is that the geese just went back to get a rest and I\'m not ' \
+  'banking on their return soon'
+begin
+  params = DocumentParameters.new(content: morphology_parts_of_speech_data)
+  response = rosette_api.get_parts_of_speech(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/name_deduplication.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+name_dedupe_data = 'Alice Terry,Alice Thierry,Betty Grable,Betty Gable,' \
+  'Norma Shearer,Norm Shearer,Brigitte Helm,Bridget Helem,Judy Holliday,' \
+  'Julie Halliday'
+
+threshold = 0.75
+names = name_dedupe_data.split(',').map { |n| NameParameter.new(n) }
+begin
+  params = NameDeduplicationParameters.new(names, threshold)
+  response = rosette_api.get_name_deduplication(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end

data/examples/name_similarity.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rosette_api'
+
+api_key, url = ARGV
+
+rosette_api = if url
+                RosetteAPI.new(api_key, url)
+              else
+                RosetteAPI.new(api_key)
+              end
+
+matched_name_data1 = 'Michael Jackson'
+matched_name_data2 = '迈克尔·杰克逊'
+begin
+  name1 = NameParameter.new(
+    matched_name_data1,
+    entity_type: 'PERSON',
+    language: 'eng'
+  )
+  params = NameSimilarityParameters.new(name1, matched_name_data2)
+  response = rosette_api.get_name_similarity(params)
+  puts JSON.pretty_generate(response)
+rescue RosetteAPIError => e
+  printf('Rosette API Error (%<status_code>s): %<message>s',
+         status_code: e.status_code,
+         message: e.message)
+end