google-cloud-language 0.27.1 → 0.28.0

data/lib/google/cloud/language/v1/language_service_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2017, Google Inc. All rights reserved.
+# Copyright 2017, Google LLC 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.
@@ -28,6 +28,7 @@ require "pathname"
 require "google/gax"
 
 require "google/cloud/language/v1/language_service_pb"
+require "google/cloud/language/credentials"
 
 module Google
   module Cloud
@@ -55,21 +56,24 @@ module Google
             "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 updater_proc [Proc]
-          #   A function that transforms the metadata for requests, e.g., to give
-          #   OAuth credentials.
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
           # @param scopes [Array<String>]
           #   The OAuth scopes for this service. This parameter is ignored if
           #   an updater_proc is supplied.
-          # @param client_config[Hash]
+          # @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
@@ -82,11 +86,10 @@ module Google
               channel: nil,
               chan_creds: nil,
               updater_proc: nil,
+              credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
-              app_name: nil,
-              app_version: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -95,14 +98,38 @@ module Google
             require "google/gax/grpc"
             require "google/cloud/language/v1/language_service_services_pb"
 
+            if channel || chan_creds || updater_proc
+              warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
+                "on 2017/09/08"
+              credentials ||= channel
+              credentials ||= chan_creds
+              credentials ||= updater_proc
+            end
+            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
+              warn "`service_path` and `port` parameters are deprecated and will be removed"
+            end
 
-            if app_name || app_version
-              warn "`app_name` and `app_version` are no longer being used in the request headers."
+            credentials ||= Google::Cloud::Language::Credentials.default
+
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::Language::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
             end
 
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name
-            google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
+            google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
             google_api_client << " grpc/#{GRPC::VERSION}"
             google_api_client.freeze
 
@@ -139,10 +166,18 @@ module Google
               @language_service_stub.method(:analyze_entities),
               defaults["analyze_entities"]
             )
+            @analyze_entity_sentiment = Google::Gax.create_api_call(
+              @language_service_stub.method(:analyze_entity_sentiment),
+              defaults["analyze_entity_sentiment"]
+            )
             @analyze_syntax = Google::Gax.create_api_call(
               @language_service_stub.method(:analyze_syntax),
               defaults["analyze_syntax"]
             )
+            @classify_text = Google::Gax.create_api_call(
+              @language_service_stub.method(:classify_text),
+              defaults["classify_text"]
+            )
             @annotate_text = Google::Gax.create_api_call(
               @language_service_stub.method(:annotate_text),
               defaults["annotate_text"]
@@ -153,9 +188,10 @@ module Google
 
           # Analyzes the sentiment of the provided text.
           #
-          # @param document [Google::Cloud::Language::V1::Document]
-          #   Input document. Currently, +analyzeSentiment+ only supports English text
-          #   (Document#language="EN").
+          # @param document [Google::Cloud::Language::V1::Document | Hash]
+          #   Input document.
+          #   A hash of the same form as `Google::Cloud::Language::V1::Document`
+          #   can also be provided.
           # @param encoding_type [Google::Cloud::Language::V1::EncodingType]
           #   The encoding type used by the API to calculate sentence offsets.
           # @param options [Google::Gax::CallOptions]
@@ -166,21 +202,19 @@ module Google
           # @example
           #   require "google/cloud/language/v1"
           #
-          #   Document = Google::Cloud::Language::V1::Document
-          #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
-          #
-          #   language_service_client = LanguageServiceClient.new
-          #   document = Document.new
+          #   language_service_client = Google::Cloud::Language::V1.new
+          #   document = {}
           #   response = language_service_client.analyze_sentiment(document)
 
           def analyze_sentiment \
               document,
               encoding_type: nil,
               options: nil
-            req = Google::Cloud::Language::V1::AnalyzeSentimentRequest.new({
+            req = {
               document: document,
               encoding_type: encoding_type
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeSentimentRequest)
             @analyze_sentiment.call(req, options)
           end
 
@@ -188,8 +222,10 @@ module Google
           # along with entity types, salience, mentions for each entity, and
           # other properties.
           #
-          # @param document [Google::Cloud::Language::V1::Document]
+          # @param document [Google::Cloud::Language::V1::Document | Hash]
           #   Input document.
+          #   A hash of the same form as `Google::Cloud::Language::V1::Document`
+          #   can also be provided.
           # @param encoding_type [Google::Cloud::Language::V1::EncodingType]
           #   The encoding type used by the API to calculate offsets.
           # @param options [Google::Gax::CallOptions]
@@ -200,32 +236,63 @@ module Google
           # @example
           #   require "google/cloud/language/v1"
           #
-          #   Document = Google::Cloud::Language::V1::Document
-          #   EncodingType = Google::Cloud::Language::V1::EncodingType
-          #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
-          #
-          #   language_service_client = LanguageServiceClient.new
-          #   document = Document.new
-          #   encoding_type = EncodingType::NONE
-          #   response = language_service_client.analyze_entities(document, encoding_type)
+          #   language_service_client = Google::Cloud::Language::V1.new
+          #   document = {}
+          #   response = language_service_client.analyze_entities(document)
 
           def analyze_entities \
               document,
-              encoding_type,
+              encoding_type: nil,
               options: nil
-            req = Google::Cloud::Language::V1::AnalyzeEntitiesRequest.new({
+            req = {
               document: document,
               encoding_type: encoding_type
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeEntitiesRequest)
             @analyze_entities.call(req, options)
           end
 
+          # Finds entities, similar to {Google::Cloud::Language::V1::LanguageService::AnalyzeEntities AnalyzeEntities} in the text and analyzes
+          # sentiment associated with each entity and its mentions.
+          #
+          # @param document [Google::Cloud::Language::V1::Document | Hash]
+          #   Input document.
+          #   A hash of the same form as `Google::Cloud::Language::V1::Document`
+          #   can also be provided.
+          # @param encoding_type [Google::Cloud::Language::V1::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::V1::AnalyzeEntitySentimentResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/language/v1"
+          #
+          #   language_service_client = Google::Cloud::Language::V1.new
+          #   document = {}
+          #   response = language_service_client.analyze_entity_sentiment(document)
+
+          def analyze_entity_sentiment \
+              document,
+              encoding_type: nil,
+              options: nil
+            req = {
+              document: document,
+              encoding_type: encoding_type
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest)
+            @analyze_entity_sentiment.call(req, options)
+          end
+
           # Analyzes the syntax of the text and provides sentence boundaries and
           # tokenization along with part of speech tags, dependency trees, and other
           # properties.
           #
-          # @param document [Google::Cloud::Language::V1::Document]
+          # @param document [Google::Cloud::Language::V1::Document | Hash]
           #   Input document.
+          #   A hash of the same form as `Google::Cloud::Language::V1::Document`
+          #   can also be provided.
           # @param encoding_type [Google::Cloud::Language::V1::EncodingType]
           #   The encoding type used by the API to calculate offsets.
           # @param options [Google::Gax::CallOptions]
@@ -236,33 +303,61 @@ module Google
           # @example
           #   require "google/cloud/language/v1"
           #
-          #   Document = Google::Cloud::Language::V1::Document
-          #   EncodingType = Google::Cloud::Language::V1::EncodingType
-          #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
-          #
-          #   language_service_client = LanguageServiceClient.new
-          #   document = Document.new
-          #   encoding_type = EncodingType::NONE
-          #   response = language_service_client.analyze_syntax(document, encoding_type)
+          #   language_service_client = Google::Cloud::Language::V1.new
+          #   document = {}
+          #   response = language_service_client.analyze_syntax(document)
 
           def analyze_syntax \
               document,
-              encoding_type,
+              encoding_type: nil,
               options: nil
-            req = Google::Cloud::Language::V1::AnalyzeSyntaxRequest.new({
+            req = {
               document: document,
               encoding_type: encoding_type
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeSyntaxRequest)
             @analyze_syntax.call(req, options)
           end
 
+          # Classifies a document into categories.
+          #
+          # @param document [Google::Cloud::Language::V1::Document | Hash]
+          #   Input document.
+          #   A hash of the same form as `Google::Cloud::Language::V1::Document`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Language::V1::ClassifyTextResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/language/v1"
+          #
+          #   language_service_client = Google::Cloud::Language::V1.new
+          #   document = {}
+          #   response = language_service_client.classify_text(document)
+
+          def classify_text \
+              document,
+              options: nil
+            req = {
+              document: document
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::ClassifyTextRequest)
+            @classify_text.call(req, options)
+          end
+
           # A convenience method that provides all the features that analyzeSentiment,
           # analyzeEntities, and analyzeSyntax provide in one call.
           #
-          # @param document [Google::Cloud::Language::V1::Document]
+          # @param document [Google::Cloud::Language::V1::Document | Hash]
           #   Input document.
-          # @param features [Google::Cloud::Language::V1::AnnotateTextRequest::Features]
+          #   A hash of the same form as `Google::Cloud::Language::V1::Document`
+          #   can also be provided.
+          # @param features [Google::Cloud::Language::V1::AnnotateTextRequest::Features | Hash]
           #   The enabled features.
+          #   A hash of the same form as `Google::Cloud::Language::V1::AnnotateTextRequest::Features`
+          #   can also be provided.
           # @param encoding_type [Google::Cloud::Language::V1::EncodingType]
           #   The encoding type used by the API to calculate offsets.
           # @param options [Google::Gax::CallOptions]
@@ -273,27 +368,22 @@ module Google
           # @example
           #   require "google/cloud/language/v1"
           #
-          #   Document = Google::Cloud::Language::V1::Document
-          #   EncodingType = Google::Cloud::Language::V1::EncodingType
-          #   Features = Google::Cloud::Language::V1::AnnotateTextRequest::Features
-          #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
-          #
-          #   language_service_client = LanguageServiceClient.new
-          #   document = Document.new
-          #   features = Features.new
-          #   encoding_type = EncodingType::NONE
-          #   response = language_service_client.annotate_text(document, features, encoding_type)
+          #   language_service_client = Google::Cloud::Language::V1.new
+          #   document = {}
+          #   features = {}
+          #   response = language_service_client.annotate_text(document, features)
 
           def annotate_text \
               document,
               features,
-              encoding_type,
+              encoding_type: nil,
               options: nil
-            req = Google::Cloud::Language::V1::AnnotateTextRequest.new({
+            req = {
               document: document,
               features: features,
               encoding_type: encoding_type
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnnotateTextRequest)
             @annotate_text.call(req, options)
           end
         end

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

@@ -30,11 +30,21 @@
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
+        "AnalyzeEntitySentiment": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
         "AnalyzeSyntax": {
           "timeout_millis": 30000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
+        "ClassifyText": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
         "AnnotateText": {
           "timeout_millis": 30000,
           "retry_codes_name": "idempotent",

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

@@ -28,6 +28,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     map :metadata, :string, :string, 3
     optional :salience, :float, 4
     repeated :mentions, :message, 5, "google.cloud.language.v1.EntityMention"
+    optional :sentiment, :message, 6, "google.cloud.language.v1.Sentiment"
   end
   add_enum "google.cloud.language.v1.Entity.Type" do
     value :UNKNOWN, 0
@@ -251,10 +252,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :NUMC, 74
     value :COP, 75
     value :DISLOCATED, 76
+    value :ASP, 77
+    value :GMOD, 78
+    value :GOBJ, 79
+    value :INFMOD, 80
+    value :MES, 81
+    value :NCOMP, 82
   end
   add_message "google.cloud.language.v1.EntityMention" do
     optional :text, :message, 1, "google.cloud.language.v1.TextSpan"
     optional :type, :enum, 2, "google.cloud.language.v1.EntityMention.Type"
+    optional :sentiment, :message, 3, "google.cloud.language.v1.Sentiment"
   end
   add_enum "google.cloud.language.v1.EntityMention.Type" do
     value :TYPE_UNKNOWN, 0
@@ -265,6 +273,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :content, :string, 1
     optional :begin_offset, :int32, 2
   end
+  add_message "google.cloud.language.v1.ClassificationCategory" do
+    optional :name, :string, 1
+    optional :confidence, :float, 2
+  end
   add_message "google.cloud.language.v1.AnalyzeSentimentRequest" do
     optional :document, :message, 1, "google.cloud.language.v1.Document"
     optional :encoding_type, :enum, 2, "google.cloud.language.v1.EncodingType"
@@ -274,6 +286,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :language, :string, 2
     repeated :sentences, :message, 3, "google.cloud.language.v1.Sentence"
   end
+  add_message "google.cloud.language.v1.AnalyzeEntitySentimentRequest" do
+    optional :document, :message, 1, "google.cloud.language.v1.Document"
+    optional :encoding_type, :enum, 2, "google.cloud.language.v1.EncodingType"
+  end
+  add_message "google.cloud.language.v1.AnalyzeEntitySentimentResponse" do
+    repeated :entities, :message, 1, "google.cloud.language.v1.Entity"
+    optional :language, :string, 2
+  end
   add_message "google.cloud.language.v1.AnalyzeEntitiesRequest" do
     optional :document, :message, 1, "google.cloud.language.v1.Document"
     optional :encoding_type, :enum, 2, "google.cloud.language.v1.EncodingType"
@@ -291,6 +311,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :tokens, :message, 2, "google.cloud.language.v1.Token"
     optional :language, :string, 3
   end
+  add_message "google.cloud.language.v1.ClassifyTextRequest" do
+    optional :document, :message, 1, "google.cloud.language.v1.Document"
+  end
+  add_message "google.cloud.language.v1.ClassifyTextResponse" do
+    repeated :categories, :message, 1, "google.cloud.language.v1.ClassificationCategory"
+  end
   add_message "google.cloud.language.v1.AnnotateTextRequest" do
     optional :document, :message, 1, "google.cloud.language.v1.Document"
     optional :features, :message, 2, "google.cloud.language.v1.AnnotateTextRequest.Features"
@@ -300,6 +326,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :extract_syntax, :bool, 1
     optional :extract_entities, :bool, 2
     optional :extract_document_sentiment, :bool, 3
+    optional :extract_entity_sentiment, :bool, 4
+    optional :classify_text, :bool, 6
   end
   add_message "google.cloud.language.v1.AnnotateTextResponse" do
     repeated :sentences, :message, 1, "google.cloud.language.v1.Sentence"
@@ -307,6 +335,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :entities, :message, 3, "google.cloud.language.v1.Entity"
     optional :document_sentiment, :message, 4, "google.cloud.language.v1.Sentiment"
     optional :language, :string, 5
+    repeated :categories, :message, 6, "google.cloud.language.v1.ClassificationCategory"
   end
   add_enum "google.cloud.language.v1.EncodingType" do
     value :NONE, 0
@@ -345,12 +374,17 @@ module Google
         EntityMention = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.EntityMention").msgclass
         EntityMention::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.EntityMention.Type").enummodule
         TextSpan = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.TextSpan").msgclass
+        ClassificationCategory = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.ClassificationCategory").msgclass
         AnalyzeSentimentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeSentimentRequest").msgclass
         AnalyzeSentimentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeSentimentResponse").msgclass
+        AnalyzeEntitySentimentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeEntitySentimentRequest").msgclass
+        AnalyzeEntitySentimentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeEntitySentimentResponse").msgclass
         AnalyzeEntitiesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeEntitiesRequest").msgclass
         AnalyzeEntitiesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeEntitiesResponse").msgclass
         AnalyzeSyntaxRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeSyntaxRequest").msgclass
         AnalyzeSyntaxResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnalyzeSyntaxResponse").msgclass
+        ClassifyTextRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.ClassifyTextRequest").msgclass
+        ClassifyTextResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.ClassifyTextResponse").msgclass
         AnnotateTextRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnnotateTextRequest").msgclass
         AnnotateTextRequest::Features = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnnotateTextRequest.Features").msgclass
         AnnotateTextResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.language.v1.AnnotateTextResponse").msgclass