rosette_api 1.8.0 → 1.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c1f4e6645988fd741245aa36c5184ef0ad146fd
-  data.tar.gz: 4de158e6217545c6dbf806311689f7ba268481d4
+SHA256:
+  metadata.gz: b38b4872ea8951d43abf562f7feed44bf672e2508ec78e34c6e05327293b8c35
+  data.tar.gz: 5608e8136b43a67a771fe860f51deee5c14da58aefa90211d6bb0be77a14834a
 SHA512:
-  metadata.gz: 72078164616ffe28787dd17303c4839f2fe31e2cfb0293614aab4ceac70692144d10a9e0704deff1f8e0386a721cf9da65a60f1afb389164d9699f512f7e97da
-  data.tar.gz: 79f50f13ce4eeaf8e51bcb8b0096a207127d5955cefd0e5ff3606ae9f8fd4eb54cccae6544730f3e903d157b62aa9d95e07b1821b7588ef564c8dc38463521e1
+  metadata.gz: 85f6244f0c40958eabe5165b85dc2ee13e849924f9a500404391541bfb490291e46b8461dcc4f3bfd90ca54ff04ba5585d3b9654d4df8b9b3d2d7c72a4f031ae
+  data.tar.gz: 2dea9f348e81a32fa8f6e692f66385fe0b4143b34902d03765d027087f0b83f670bb428845d77afded27a12bfa013a52b806d042e233266e3cd5924a805bcd64

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,29 @@
+# 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 = '160 Pennsilvana Avenue, Washington, D.C., 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,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
+
+categories_url_data = 'https://onlocationvacations.com/2018/02/06/downton-abbey-exhibition-extended-april-2-nyc/'
+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,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
+
+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,25 @@
+# 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,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_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,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_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,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_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,25 @@
+# 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

data/examples/name_translation.rb

@@ -0,0 +1,26 @@
+# 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
+
+translated_name_data = 'معمر محمد أبو منيار القذاف'
+begin
+  params = NameTranslationParameters.new(
+    translated_name_data,
+    'eng',
+    target_script: 'Latn'
+  )
+  response = rosette_api.get_name_translation(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