embulk-filter-azure_text_analytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cac630a471bf5e67125d08e80f149d46eeccfcc3
+  data.tar.gz: f1194a27bd82b07d1571fc555045e04c2abc96d2
+SHA512:
+  metadata.gz: fdc16277d95fad436d178c78cc391d89e948ebf39236440fa9263ee6c992e4e3ee953ddcd5aa3f414bf168e31edbcbea02d077cd3008246b51d21a09f9c157bf
+  data.tar.gz: 73f376ee3f09ec3ad0f355108f7c5a922d28d8d28b19ae84c9843164532aa55e22aa93159fa97e0e2bcf202ebe8d7d650dda48504d9588846e6d70129c4146f4

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.5.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org/'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Azure Text Analytics filter plugin for Embulk
+
+Azure Text Analytics filter plugin for Embulk.
+
+## Azure Text Analytics Documentation
+
+* [Microsoft Cognitive Services \- Documentation](https://www.microsoft.com/cognitive-services/en-us/text-analytics/documentation)
+* [azure\-docs/cognitive\-services\-text\-analytics\-quick\-start\.md at master · Microsoft/azure\-docs](https://github.com/Microsoft/azure-docs/blob/master/articles/cognitive-services/cognitive-services-text-analytics-quick-start.md)
+
+## Overview
+
+* **Plugin type**: filter
+
+## Configuration
+
+- **api_type**: api_type(string),
+- **language**: language(string, default: nil),
+- **out_key_name**: out_key_name(string),
+- **key_name**: key_name(string),
+- **body_params**: body_params(hash, default: {}),
+- **params**: params(hash, default: {}),
+- **delay**: delay(integer, default: 0),
+- **per_request**: per_request(integer, default: 1),
+- **bulk_size**: bulk_size(integer, default: 100),
+- **subscription_key**: subscription_key(string),
+
+## Example
+### sentiment
+
+```yaml
+  # en,es,fr,pt
+  - type: azure_text_analytics
+    api_type: sentiment
+    key_name: target_key
+    out_key_name: target_key_sentiment
+    language: en
+    delay: 2
+    subscription_key: XXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+* sentiment support language
+  * en
+  * es
+  * fr
+  * pt
+
+
+### languages
+
+```yaml
+  - type: azure_text_analytics
+    api_type: languages
+    out_key_name: target_key_languages
+    language: en
+    key_name: target_key
+    delay: 2
+    subscription_key: XXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+### keyPhrases
+
+```yaml
+  - type: azure_text_analytics
+    api_type: keyPhrases
+    out_key_name: target_key_keyPhrases
+    key_name: target_key
+    delay: 2
+    subscription_key: XXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+### keyPhrases
+
+```yaml
+    # en,es,fr,pt
+  - type: azure_text_analytics_topics
+    out_key_name: _parsed
+    key_name: pr
+    params:
+      minDocumentsPerWord: 3
+      maxDocumentsPerWord: 10
+    subscription_key: {{ env.AZURE_TEXT_SUBSCRIPTION_KEY }}
+
+```
+* required, over 100 documents.
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :build

data/embulk-filter-azure_text_analytics.gemspec

@@ -0,0 +1,19 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-filter-azure_text_analytics"
+  spec.version       = "0.1.0"
+  spec.authors       = ["toyama0919"]
+  spec.summary       = "Azure Text Analytics filter plugin for Embulk"
+  spec.description   = "Azure Text Analytics"
+  spec.email         = ["toyama0919@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/toyama0919/embulk-filter-azure_text_analytics"
+
+  spec.files         = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'embulk', ['>= 0.8.15']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+end

data/lib/embulk/filter/azure_text_analytics.rb

@@ -0,0 +1,114 @@
+require "json"
+require "net/http"
+require "uri"
+
+module Embulk
+  module Filter
+
+    class AzureTextAnalytics < FilterPlugin
+      Plugin.register_filter("azure_text_analytics", self)
+      ENDPOINT_PREFIX = "https://westus.api.cognitive.microsoft.com/text/analytics/v2.0"
+
+      def self.transaction(config, in_schema, &control)
+        task = {
+          "api_type" => config.param("api_type", :string),
+          "language" => config.param("language", :string, default: nil),
+          "out_key_name" => config.param("out_key_name", :string),
+          "key_name" => config.param("key_name", :string),
+          "body_params" => config.param("body_params", :hash, default: {}),
+          "params" => config.param("params", :hash, default: {}),
+          "delay" => config.param("delay", :integer, default: 0),
+          "per_request" => config.param("per_request", :integer, default: 1),
+          "bulk_size" => config.param("bulk_size", :integer, default: 100),
+          "subscription_key" => config.param("subscription_key", :string),
+        }
+
+        if task['api_type'] == 'topics'
+          raise ConfigError.new "Not support type topics API. use azure_text_analytics_topics."
+        end
+
+        add_columns = [
+          Column.new(nil, task["out_key_name"], :json)
+        ]
+
+        out_columns = in_schema + add_columns
+
+        yield(task, out_columns)
+      end
+
+      def init
+        uri_string = "#{ENDPOINT_PREFIX}/#{task['api_type']}"
+        @uri = URI.parse(uri_string)
+        @uri.query = URI.encode_www_form(task['params'])
+        @http = Net::HTTP.new(@uri.host, @uri.port)
+        @http.use_ssl = true
+        @request = Net::HTTP::Post.new(@uri.request_uri)
+        @request['Content-Type'] = 'application/json'
+        @request['Ocp-Apim-Subscription-Key'] = task['subscription_key']
+
+        @body_params = task['body_params']
+        @per_request = task['per_request']
+        @delay = task['delay']
+        @key_name = task['key_name']
+        @language = task['language']
+        @out_key_name = task['out_key_name']
+        @bulk_size = task['bulk_size']
+        @records = []
+      end
+
+      def close
+      end
+
+      def add(page)
+        page.each do |record|
+          @records << Hash[in_schema.names.zip(record)]
+          if @records.size == @bulk_size
+            proc_records(@records)
+            @records = []
+          end
+        end
+      end
+
+      def finish
+        if @records.size > 0
+          proc_records(@records)
+        end
+        page_builder.finish
+      end
+
+      private
+      def proc_records(records)
+        documents = {}
+        records.each do |record|
+          document = {}
+          uuid = SecureRandom.uuid
+          document["language"] = @language if @language
+          document["id"] = uuid
+          document["text"] = record[@key_name]
+          documents[uuid] = document
+        end
+
+        @request.body = @body_params.merge({ documents: documents.values }).to_json
+        Embulk.logger.debug "request body => #{@request.body}"
+        response_hash = @http.start do |h|
+          response = h.request(@request)
+          JSON.parse(response.body)
+        end
+
+        if response_hash.key?('innerError')
+          Embulk.logger.error "response body => #{response_hash}"
+        end
+
+        records.each_with_index do |record, i|
+          record[@out_key_name] = if response_hash.key?('innerError')
+            response_hash
+          else
+            response_hash['documents'][i]
+          end
+          page_builder.add(record.values)
+        end
+        sleep @delay
+      end
+    end
+  end
+end

data/lib/embulk/filter/azure_text_analytics_topics.rb

@@ -0,0 +1,128 @@
+require "json"
+require "net/http"
+require "uri"
+require "pp"
+
+module Embulk
+  module Filter
+
+    class AzureTextAnalyticsTopics < FilterPlugin
+      Plugin.register_filter("azure_text_analytics_topics", self)
+      ENDPOINT_PREFIX = "https://westus.api.cognitive.microsoft.com/text/analytics/v2.0"
+
+      def self.transaction(config, in_schema, &control)
+        task = {
+          "language" => config.param("language", :string, default: nil),
+          "out_key_name" => config.param("out_key_name", :string),
+          "key_name" => config.param("key_name", :string),
+          "body_params" => config.param("body_params", :hash, default: {}),
+          "params" => config.param("params", :hash, default: {}),
+          "subscription_key" => config.param("subscription_key", :string),
+          "stop_words" => config.param("stop_words", :array, default: nil),
+          "stop_phrases" => config.param("stop_phrases", :array, default: nil),
+        }
+
+        out_columns = [
+          Column.new(nil, task["out_key_name"], :json)
+        ]
+
+        yield(task, out_columns)
+      end
+
+      def init
+        @subscription_key = task['subscription_key']
+        @body_params = task['body_params']
+        @key_name = task['key_name']
+        @language = task['language']
+        @out_key_name = task['out_key_name']
+        @stop_words = task['stop_words']
+        @stop_phrases = task['stop_phrases']
+
+        uri_string = "#{ENDPOINT_PREFIX}/topics"
+        @uri = URI.parse(uri_string)
+        @uri.query = URI.encode_www_form(task['params'])
+        @http = Net::HTTP.new(@uri.host, @uri.port)
+        @http.use_ssl = true
+
+        @request = Net::HTTP::Post.new(@uri.request_uri)
+        @request['Content-Type'] = 'application/json'
+        @request['Ocp-Apim-Subscription-Key'] = @subscription_key
+
+        @records = []
+      end
+
+      def close
+      end
+
+      def add(page)
+        page.each do |record|
+          @records << Hash[in_schema.names.zip(record)]
+        end
+      end
+
+      def finish
+        if @records.size > 0
+          proc_records(@records)
+        end
+        page_builder.finish
+      end
+
+      private
+      def proc_records(records)
+        documents = []
+        records.each do |record|
+          document = {}
+          document_id = SecureRandom.uuid
+          document["language"] = @language if @language
+          document["id"] = document_id
+          document["text"] = record[@key_name]
+          documents << document
+        end
+
+        request_body_hash = @body_params.merge({ documents: documents })
+        request_body_hash[:stopWords] = @stop_words if @stop_words
+        request_body_hash[:stopPhrases] = @stop_phrases if @stop_phrases
+
+        @request.body = request_body_hash.to_json
+        Embulk.logger.debug "request body => #{@request.body}"
+        response_hash = @http.start do |h|
+          proc_http(h)
+        end
+
+        topics = response_hash["operationProcessingResult"]["topics"]
+
+        topics.each do |data|
+          page_builder.add([data])
+        end
+      end
+
+      def proc_http(h)
+        response = h.request(@request)
+        operation_location = response['operation-location']
+
+        if operation_location
+          Embulk.logger.info "operation_location => #{operation_location}"
+          topics_request = Net::HTTP::Get.new(operation_location)
+          topics_request['Ocp-Apim-Subscription-Key'] = @subscription_key
+          loop do
+            topics_response = h.request(topics_request)
+            topics_response_body = topics_response.body
+            topics_response_hash = JSON.parse(topics_response_body)
+            status = topics_response_hash['status']
+            Embulk.logger.info "status => #{status}"
+            if status == 'Succeeded'
+              Embulk.logger.debug "topics_response_hash => #{topics_response_hash}"
+              return topics_response_hash
+            end
+            if status == 'Failed'
+              raise "topics_response_hash => #{topics_response_hash}"
+            end
+            sleep 60
+          end
+        end
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: embulk-filter-azure_text_analytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- toyama0919
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Azure Text Analytics
+email:
+- toyama0919@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-filter-azure_text_analytics.gemspec
+- lib/embulk/filter/azure_text_analytics.rb
+- lib/embulk/filter/azure_text_analytics_topics.rb
+homepage: https://github.com/toyama0919/embulk-filter-azure_text_analytics
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.6
+signing_key:
+specification_version: 4
+summary: Azure Text Analytics filter plugin for Embulk
+test_files: []