google-cloud-language 0.20.0

data/lib/google/cloud/language/service.rb

@@ -0,0 +1,112 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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.
+
+
+require "google/cloud/errors"
+require "google/cloud/language/credentials"
+require "google/cloud/language/version"
+require "google/cloud/language/v1beta1/language_service_api"
+
+module Google
+  module Cloud
+    module Language
+      ##
+      # @private Represents the gRPC Language service, including all the API
+      # methods.
+      class Service
+        attr_accessor :project, :credentials, :host, :retries, :timeout
+
+        ##
+        # Creates a new Service instance.
+        def initialize project, credentials, host: nil, retries: nil,
+                       timeout: nil
+          @project = project
+          @credentials = credentials
+          @host = host || V1beta1::LanguageServiceApi::SERVICE_ADDRESS
+          @retries = retries
+          @timeout = timeout
+        end
+
+        def channel
+          GRPC::Core::Channel.new host, nil, chan_creds
+        end
+
+        def chan_creds
+          return credentials if insecure?
+          GRPC::Core::ChannelCredentials.new.compose \
+            GRPC::Core::CallCredentials.new credentials.client.updater_proc
+        end
+
+        def service
+          return mocked_service if mocked_service
+          @service ||= V1beta1::LanguageServiceApi.new(
+            service_path: host,
+            channel: channel,
+            timeout: timeout,
+            app_name: "google-cloud-language",
+            app_version: Google::Cloud::Language::VERSION)
+          # TODO: Get retries configured
+        end
+        attr_accessor :mocked_service
+
+        def insecure?
+          credentials == :this_channel_is_insecure
+        end
+
+        ##
+        # Returns API::BatchAnnotateImagesResponse
+        def annotate doc_grpc, syntax: false, entities: false, sentiment: false,
+                     encoding: nil
+          if syntax == false && entities == false && sentiment == false
+            syntax = true
+            entities = true
+            sentiment = true
+          end
+          features = V1beta1::AnnotateTextRequest::Features.new(
+            extract_syntax: syntax, extract_entities: entities,
+            extract_document_sentiment: sentiment)
+          encoding = verify_encoding! encoding
+          execute { service.annotate_text doc_grpc, features, encoding }
+        end
+
+        def entities doc_grpc, encoding: nil
+          encoding = verify_encoding! encoding
+          execute { service.analyze_entities doc_grpc, encoding }
+        end
+
+        def sentiment doc_grpc
+          execute { service.analyze_sentiment doc_grpc }
+        end
+
+        def inspect
+          "#{self.class}(#{@project})"
+        end
+
+        protected
+
+        def verify_encoding! encoding
+          # TODO: verify encoding against V1beta1::EncodingType
+          return :UTF8 if encoding.nil?
+          encoding
+        end
+
+        def execute
+          yield
+        rescue GRPC::BadStatus => e
+          raise Google::Cloud::Error.from_error(e)
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/language/v1beta1/language_service_api.rb

@@ -0,0 +1,204 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/cloud/language/v1beta1/language_service.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+#
+# The only allowed edits are to method and file documentation. A 3-way
+# merge preserves those additions if the generated source changes.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+require "google/cloud/language/v1beta1/language_service_services_pb"
+
+module Google
+  module Cloud
+    module Language
+      module V1beta1
+        # Provides text analysis operations such as sentiment analysis and entity
+        # recognition.
+        #
+        # @!attribute [r] stub
+        #   @return [Google::Cloud::Language::V1beta1::LanguageService::Stub]
+        class LanguageServiceApi
+          attr_reader :stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "language.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze
+
+          DEFAULT_TIMEOUT = 30
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_SCOPES = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+
+          # @param service_path [String]
+          #   The domain name of the API remote host.
+          # @param port [Integer]
+          #   The port on which to connect to the remote host.
+          # @param channel [Channel]
+          #   A Channel object through which to make calls.
+          # @param chan_creds [Grpc::ChannelCredentials]
+          #   A ChannelCredentials for the setting up the RPC client.
+          # @param client_config[Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          # @param app_name [String]
+          #   The codename of the calling service.
+          # @param app_version [String]
+          #   The version of the calling service.
+          def initialize \
+              service_path: SERVICE_ADDRESS,
+              port: DEFAULT_SERVICE_PORT,
+              channel: nil,
+              chan_creds: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              app_name: "gax",
+              app_version: Google::Gax::VERSION
+            google_api_client = "#{app_name}/#{app_version} " \
+              "#{CODE_GEN_NAME_VERSION} ruby/#{RUBY_VERSION}".freeze
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "language_service_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.cloud.language.v1beta1.LanguageService",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+            @stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              scopes: scopes,
+              &Google::Cloud::Language::V1beta1::LanguageService::Stub.method(:new)
+            )
+
+            @analyze_sentiment = Google::Gax.create_api_call(
+              @stub.method(:analyze_sentiment),
+              defaults["analyze_sentiment"]
+            )
+            @analyze_entities = Google::Gax.create_api_call(
+              @stub.method(:analyze_entities),
+              defaults["analyze_entities"]
+            )
+            @annotate_text = Google::Gax.create_api_call(
+              @stub.method(:annotate_text),
+              defaults["annotate_text"]
+            )
+          end
+
+          # Service calls
+
+          # Analyzes the sentiment of the provided text.
+          #
+          # @param document [Google::Cloud::Language::V1beta1::Document]
+          #   Input document. Currently, +analyzeSentiment+ only supports English text
+          #   (Document#language="EN").
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Language::V1beta1::AnalyzeSentimentResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def analyze_sentiment \
+              document,
+              options: nil
+            req = Google::Cloud::Language::V1beta1::AnalyzeSentimentRequest.new(
+              document: document
+            )
+            @analyze_sentiment.call(req, options)
+          end
+
+          # Finds named entities (currently finds proper names) in the text,
+          # entity types, salience, mentions for each entity, and other properties.
+          #
+          # @param document [Google::Cloud::Language::V1beta1::Document]
+          #   Input document.
+          # @param encoding_type [Google::Cloud::Language::V1beta1::EncodingType]
+          #   The encoding type used by the API to calculate offsets.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Language::V1beta1::AnalyzeEntitiesResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def analyze_entities \
+              document,
+              encoding_type,
+              options: nil
+            req = Google::Cloud::Language::V1beta1::AnalyzeEntitiesRequest.new(
+              document: document,
+              encoding_type: encoding_type
+            )
+            @analyze_entities.call(req, options)
+          end
+
+          # Advanced API that analyzes the document and provides a full set of text
+          # annotations, including semantic, syntactic, and sentiment information. This
+          # API is intended for users who are familiar with machine learning and need
+          # in-depth text features to build upon.
+          #
+          # @param document [Google::Cloud::Language::V1beta1::Document]
+          #   Input document.
+          # @param features [Google::Cloud::Language::V1beta1::AnnotateTextRequest::Features]
+          #   The enabled features.
+          # @param encoding_type [Google::Cloud::Language::V1beta1::EncodingType]
+          #   The encoding type used by the API to calculate offsets.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Language::V1beta1::AnnotateTextResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def annotate_text \
+              document,
+              features,
+              encoding_type,
+              options: nil
+            req = Google::Cloud::Language::V1beta1::AnnotateTextRequest.new(
+              document: document,
+              features: features,
+              encoding_type: encoding_type
+            )
+            @annotate_text.call(req, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/language/v1beta1/language_service_client_config.json

@@ -0,0 +1,43 @@
+{
+  "interfaces": {
+    "google.cloud.language.v1beta1.LanguageService": {
+      "retry_codes": {
+        "retry_codes_def": {
+          "idempotent": [
+            "DEADLINE_EXCEEDED",
+            "UNAVAILABLE"
+          ],
+          "non_idempotent": []
+        }
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 60000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 60000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "AnalyzeSentiment": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "AnalyzeEntities": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "AnnotateText": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/cloud/language/v1beta1/language_service_pb.rb

@@ -0,0 +1,228 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/language/v1beta1/language_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.language.v1beta1.Document" do
+    optional :type, :enum, 1, "google.cloud.language.v1beta1.Document.Type"
+    optional :language, :string, 4
+    oneof :source do
+      optional :content, :string, 2
+      optional :gcs_content_uri, :string, 3
+    end
+  end
+  add_enum "google.cloud.language.v1beta1.Document.Type" do
+    value :TYPE_UNSPECIFIED, 0
+    value :PLAIN_TEXT, 1
+    value :HTML, 2
+  end
+  add_message "google.cloud.language.v1beta1.Sentence" do
+    optional :text, :message, 1, "google.cloud.language.v1beta1.TextSpan"
+  end
+  add_message "google.cloud.language.v1beta1.Entity" do
+    optional :name, :string, 1
+    optional :type, :enum, 2, "google.cloud.language.v1beta1.Entity.Type"
+    map :metadata, :string, :string, 3
+    optional :salience, :float, 4
+    repeated :mentions, :message, 5, "google.cloud.language.v1beta1.EntityMention"
+  end
+  add_enum "google.cloud.language.v1beta1.Entity.Type" do
+    value :UNKNOWN, 0
+    value :PERSON, 1
+    value :LOCATION, 2
+    value :ORGANIZATION, 3
+    value :EVENT, 4
+    value :WORK_OF_ART, 5
+    value :CONSUMER_GOOD, 6
+    value :OTHER, 7
+  end
+  add_message "google.cloud.language.v1beta1.Token" do
+    optional :text, :message, 1, "google.cloud.language.v1beta1.TextSpan"
+    optional :part_of_speech, :message, 2, "google.cloud.language.v1beta1.PartOfSpeech"
+    optional :dependency_edge, :message, 3, "google.cloud.language.v1beta1.DependencyEdge"
+    optional :lemma, :string, 4
+  end
+  add_message "google.cloud.language.v1beta1.Sentiment" do
+    optional :polarity, :float, 1
+    optional :magnitude, :float, 2
+  end
+  add_message "google.cloud.language.v1beta1.PartOfSpeech" do
+    optional :tag, :enum, 1, "google.cloud.language.v1beta1.PartOfSpeech.Tag"
+  end
+  add_enum "google.cloud.language.v1beta1.PartOfSpeech.Tag" do
+    value :UNKNOWN, 0
+    value :ADJ, 1
+    value :ADP, 2
+    value :ADV, 3
+    value :CONJ, 4
+    value :DET, 5
+    value :NOUN, 6
+    value :NUM, 7
+    value :PRON, 8
+    value :PRT, 9
+    value :PUNCT, 10
+    value :VERB, 11
+    value :X, 12
+    value :AFFIX, 13
+  end
+  add_message "google.cloud.language.v1beta1.DependencyEdge" do
+    optional :head_token_index, :int32, 1
+    optional :label, :enum, 2, "google.cloud.language.v1beta1.DependencyEdge.Label"
+  end
+  add_enum "google.cloud.language.v1beta1.DependencyEdge.Label" do
+    value :UNKNOWN, 0
+    value :ABBREV, 1
+    value :ACOMP, 2
+    value :ADVCL, 3
+    value :ADVMOD, 4
+    value :AMOD, 5
+    value :APPOS, 6
+    value :ATTR, 7
+    value :AUX, 8
+    value :AUXPASS, 9
+    value :CC, 10
+    value :CCOMP, 11
+    value :CONJ, 12
+    value :CSUBJ, 13
+    value :CSUBJPASS, 14
+    value :DEP, 15
+    value :DET, 16
+    value :DISCOURSE, 17
+    value :DOBJ, 18
+    value :EXPL, 19
+    value :GOESWITH, 20
+    value :IOBJ, 21
+    value :MARK, 22
+    value :MWE, 23
+    value :MWV, 24
+    value :NEG, 25
+    value :NN, 26
+    value :NPADVMOD, 27
+    value :NSUBJ, 28
+    value :NSUBJPASS, 29
+    value :NUM, 30
+    value :NUMBER, 31
+    value :P, 32
+    value :PARATAXIS, 33
+    value :PARTMOD, 34
+    value :PCOMP, 35
+    value :POBJ, 36
+    value :POSS, 37
+    value :POSTNEG, 38
+    value :PRECOMP, 39
+    value :PRECONJ, 40
+    value :PREDET, 41
+    value :PREF, 42
+    value :PREP, 43
+    value :PRONL, 44
+    value :PRT, 45
+    value :PS, 46
+    value :QUANTMOD, 47
+    value :RCMOD, 48
+    value :RCMODREL, 49
+    value :RDROP, 50
+    value :REF, 51
+    value :REMNANT, 52
+    value :REPARANDUM, 53
+    value :ROOT, 54
+    value :SNUM, 55
+    value :SUFF, 56
+    value :TMOD, 57
+    value :TOPIC, 58
+    value :VMOD, 59
+    value :VOCATIVE, 60
+    value :XCOMP, 61
+    value :SUFFIX, 62
+    value :TITLE, 63
+    value :ADVPHMOD, 64
+    value :AUXCAUS, 65
+    value :AUXVV, 66
+    value :DTMOD, 67
+    value :FOREIGN, 68
+    value :KW, 69
+    value :LIST, 70
+    value :NOMC, 71
+    value :NOMCSUBJ, 72
+    value :NOMCSUBJPASS, 73
+    value :NUMC, 74
+    value :COP, 75
+    value :DISLOCATED, 76
+  end
+  add_message "google.cloud.language.v1beta1.EntityMention" do
+    optional :text, :message, 1, "google.cloud.language.v1beta1.TextSpan"
+  end
+  add_message "google.cloud.language.v1beta1.TextSpan" do
+    optional :content, :string, 1
+    optional :begin_offset, :int32, 2
+  end
+  add_message "google.cloud.language.v1beta1.AnalyzeSentimentRequest" do
+    optional :document, :message, 1, "google.cloud.language.v1beta1.Document"
+  end
+  add_message "google.cloud.language.v1beta1.AnalyzeSentimentResponse" do
+    optional :document_sentiment, :message, 1, "google.cloud.language.v1beta1.Sentiment"
+    optional :language, :string, 2
+  end
+  add_message "google.cloud.language.v1beta1.AnalyzeEntitiesRequest" do
+    optional :document, :message, 1, "google.cloud.language.v1beta1.Document"
+    optional :encoding_type, :enum, 2, "google.cloud.language.v1beta1.EncodingType"
+  end
+  add_message "google.cloud.language.v1beta1.AnalyzeEntitiesResponse" do
+    repeated :entities, :message, 1, "google.cloud.language.v1beta1.Entity"
+    optional :language, :string, 2
+  end
+  add_message "google.cloud.language.v1beta1.AnnotateTextRequest" do
+    optional :document, :message, 1, "google.cloud.language.v1beta1.Document"
+    optional :features, :message, 2, "google.cloud.language.v1beta1.AnnotateTextRequest.Features"
+    optional :encoding_type, :enum, 3, "google.cloud.language.v1beta1.EncodingType"
+  end
+  add_message "google.cloud.language.v1beta1.AnnotateTextRequest.Features" do
+    optional :extract_syntax, :bool, 1
+    optional :extract_entities, :bool, 2
+    optional :extract_document_sentiment, :bool, 3
+  end
+  add_message "google.cloud.language.v1beta1.AnnotateTextResponse" do
+    repeated :sentences, :message, 1, "google.cloud.language.v1beta1.Sentence"
+    repeated :tokens, :message, 2, "google.cloud.language.v1beta1.Token"
+    repeated :entities, :message, 3, "google.cloud.language.v1beta1.Entity"
+    optional :document_sentiment, :message, 4, "google.cloud.language.v1beta1.Sentiment"
+    optional :language, :string, 5
+  end
+  add_enum "google.cloud.language.v1beta1.EncodingType" do
+    value :NONE, 0
+    value :UTF8, 1
+    value :UTF16, 2
+    value :UTF32, 3
+  end
+end
+
+module Google
+  module Cloud
+    module Language
+      module V1beta1
+        Document = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Document").msgclass
+        Document::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Document.Type").enummodule
+        Sentence = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Sentence").msgclass
+        Entity = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Entity").msgclass
+        Entity::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Entity.Type").enummodule
+        Token = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Token").msgclass
+        Sentiment = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.Sentiment").msgclass
+        PartOfSpeech = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.PartOfSpeech").msgclass
+        PartOfSpeech::Tag = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.PartOfSpeech.Tag").enummodule
+        DependencyEdge = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.DependencyEdge").msgclass
+        DependencyEdge::Label = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.DependencyEdge.Label").enummodule
+        EntityMention = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.EntityMention").msgclass
+        TextSpan = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.TextSpan").msgclass
+        AnalyzeSentimentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnalyzeSentimentRequest").msgclass
+        AnalyzeSentimentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnalyzeSentimentResponse").msgclass
+        AnalyzeEntitiesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnalyzeEntitiesRequest").msgclass
+        AnalyzeEntitiesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnalyzeEntitiesResponse").msgclass
+        AnnotateTextRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnnotateTextRequest").msgclass
+        AnnotateTextRequest::Features = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnnotateTextRequest.Features").msgclass
+        AnnotateTextResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.AnnotateTextResponse").msgclass
+        EncodingType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1beta1.EncodingType").enummodule
+      end
+    end
+  end
+end