google-cloud-language-v1 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce02946e1eb6e1e239238136d8b46fb679c37de9e70a13949e457ea61f4a515c
-  data.tar.gz: 4057d407ee8c631ed920b3b9abf0bf1ae2b477934877bf3843302d163a193c20
+  metadata.gz: aa9b3392a6c79b5a1467f83355581382dbf1de2b85235425f7323687cb0f6c54
+  data.tar.gz: 9499739748001e7af7d649ed3b377c4c98740725efddccca867e8055c6751f88
 SHA512:
-  metadata.gz: 54d28ee793371e80d16eb47745fee0eaa563abccff5e8bcfeedf8966b6d3edc9351acb999b0076e5983d636733c14321156d3f54eb2f916488171d529499dd66
-  data.tar.gz: 813c5bdd7356711a41da81761781d2a8e2826c6c440fc1d301e3aeee28638253db9ae8e170ab7722d38c48fd26e5c602edbc2b4f4d8466826f9e03eb5879774a
+  metadata.gz: 369c5a657a3e4e4b312fb8c8bc85568e1a1332353bca99a3b01279f4f772db34b968df36f5b839a45a449de0eb267b81299f5490ada8cca4b38f2ba0fbe5d822
+  data.tar.gz: d03a8dc9f2b7e479f1265a171ec59f5d308a0558c8cf65495b516358d3ce5950862150abbfe23967e0f42a0918811178f805822871cf9fa874643b8c75c3377e

data/README.md

@@ -1,4 +1,4 @@
-# Natural Language V1
+# Ruby Client for the Natural Language V1 API
 
 API Client library for the Natural Language V1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-language-v1
 ```
 
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/language/v1"
+
+client = Google::Cloud::Language::V1::LanguageService::Client.new
+request = my_create_request
+response = client.analyze_sentiment request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-language-v1/latest)
+for class and method documentation.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

data/lib/google/cloud/language/v1/language_service/client.rb

@@ -16,14 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/language/v1/version"
 require "google/cloud/language/v1/language_service_pb"
-require "google/cloud/language/v1/language_service/credentials"
 
 module Google
   module Cloud
@@ -200,18 +194,25 @@ module Google
             # Analyzes the sentiment of the provided text.
             #
             # @overload analyze_sentiment(request, options = nil)
-            #   @param request [Google::Cloud::Language::V1::AnalyzeSentimentRequest | Hash]
-            #     Analyzes the sentiment of the provided text.
+            #   Pass arguments to `analyze_sentiment` via a request object, either of type
+            #   {Google::Cloud::Language::V1::AnalyzeSentimentRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Language::V1::AnalyzeSentimentRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload analyze_sentiment(document: nil, encoding_type: nil)
-            #   @param document [Google::Cloud::Language::V1::Document | Hash]
+            #   Pass arguments to `analyze_sentiment` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param document [Google::Cloud::Language::V1::Document, Hash]
             #     Input document.
             #   @param encoding_type [Google::Cloud::Language::V1::EncodingType]
             #     The encoding type used by the API to calculate sentence offsets.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Language::V1::AnalyzeSentimentResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -257,20 +258,25 @@ module Google
             # other properties.
             #
             # @overload analyze_entities(request, options = nil)
-            #   @param request [Google::Cloud::Language::V1::AnalyzeEntitiesRequest | Hash]
-            #     Finds named entities (currently proper names and common nouns) in the text
-            #     along with entity types, salience, mentions for each entity, and
-            #     other properties.
+            #   Pass arguments to `analyze_entities` via a request object, either of type
+            #   {Google::Cloud::Language::V1::AnalyzeEntitiesRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Language::V1::AnalyzeEntitiesRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload analyze_entities(document: nil, encoding_type: nil)
-            #   @param document [Google::Cloud::Language::V1::Document | Hash]
+            #   Pass arguments to `analyze_entities` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param document [Google::Cloud::Language::V1::Document, Hash]
             #     Input document.
             #   @param encoding_type [Google::Cloud::Language::V1::EncodingType]
             #     The encoding type used by the API to calculate offsets.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Language::V1::AnalyzeEntitiesResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -315,19 +321,25 @@ module Google
             # sentiment associated with each entity and its mentions.
             #
             # @overload analyze_entity_sentiment(request, options = nil)
-            #   @param request [Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest | Hash]
-            #     Finds entities, similar to {Google::Cloud::Language::V1::LanguageService::Client#analyze_entities AnalyzeEntities} in the text and analyzes
-            #     sentiment associated with each entity and its mentions.
+            #   Pass arguments to `analyze_entity_sentiment` via a request object, either of type
+            #   {Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload analyze_entity_sentiment(document: nil, encoding_type: nil)
-            #   @param document [Google::Cloud::Language::V1::Document | Hash]
+            #   Pass arguments to `analyze_entity_sentiment` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param document [Google::Cloud::Language::V1::Document, Hash]
             #     Input document.
             #   @param encoding_type [Google::Cloud::Language::V1::EncodingType]
             #     The encoding type used by the API to calculate offsets.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -373,20 +385,25 @@ module Google
             # properties.
             #
             # @overload analyze_syntax(request, options = nil)
-            #   @param request [Google::Cloud::Language::V1::AnalyzeSyntaxRequest | Hash]
-            #     Analyzes the syntax of the text and provides sentence boundaries and
-            #     tokenization along with part of speech tags, dependency trees, and other
-            #     properties.
+            #   Pass arguments to `analyze_syntax` via a request object, either of type
+            #   {Google::Cloud::Language::V1::AnalyzeSyntaxRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Language::V1::AnalyzeSyntaxRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload analyze_syntax(document: nil, encoding_type: nil)
-            #   @param document [Google::Cloud::Language::V1::Document | Hash]
+            #   Pass arguments to `analyze_syntax` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param document [Google::Cloud::Language::V1::Document, Hash]
             #     Input document.
             #   @param encoding_type [Google::Cloud::Language::V1::EncodingType]
             #     The encoding type used by the API to calculate offsets.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Language::V1::AnalyzeSyntaxResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -430,15 +447,22 @@ module Google
             # Classifies a document into categories.
             #
             # @overload classify_text(request, options = nil)
-            #   @param request [Google::Cloud::Language::V1::ClassifyTextRequest | Hash]
-            #     Classifies a document into categories.
+            #   Pass arguments to `classify_text` via a request object, either of type
+            #   {Google::Cloud::Language::V1::ClassifyTextRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Language::V1::ClassifyTextRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload classify_text(document: nil)
-            #   @param document [Google::Cloud::Language::V1::Document | Hash]
-            #     Input document.
+            #   Pass arguments to `classify_text` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
             #
+            #   @param document [Google::Cloud::Language::V1::Document, Hash]
+            #     Input document.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Language::V1::ClassifyTextResponse]
@@ -484,21 +508,27 @@ module Google
             # analyzeEntities, and analyzeSyntax provide in one call.
             #
             # @overload annotate_text(request, options = nil)
-            #   @param request [Google::Cloud::Language::V1::AnnotateTextRequest | Hash]
-            #     A convenience method that provides all the features that analyzeSentiment,
-            #     analyzeEntities, and analyzeSyntax provide in one call.
+            #   Pass arguments to `annotate_text` via a request object, either of type
+            #   {Google::Cloud::Language::V1::AnnotateTextRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Language::V1::AnnotateTextRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload annotate_text(document: nil, features: nil, encoding_type: nil)
-            #   @param document [Google::Cloud::Language::V1::Document | Hash]
+            #   Pass arguments to `annotate_text` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param document [Google::Cloud::Language::V1::Document, Hash]
             #     Input document.
-            #   @param features [Google::Cloud::Language::V1::AnnotateTextRequest::Features | Hash]
+            #   @param features [Google::Cloud::Language::V1::AnnotateTextRequest::Features, Hash]
             #     The enabled features.
             #   @param encoding_type [Google::Cloud::Language::V1::EncodingType]
             #     The encoding type used by the API to calculate offsets.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Language::V1::AnnotateTextResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -726,13 +756,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/language/v1/language_service/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

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

@@ -16,5 +16,34 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/language/v1/language_service/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/language/v1/version"
+
 require "google/cloud/language/v1/language_service/credentials"
+require "google/cloud/language/v1/language_service/client"
+
+module Google
+  module Cloud
+    module Language
+      module V1
+        ##
+        # Provides text analysis operations such as sentiment analysis and entity
+        # recognition.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/language/v1/language_service"
+        #     client = Google::Cloud::Language::V1::LanguageService::Client.new
+        #
+        module LanguageService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "language_service", "helpers.rb"
+require "google/cloud/language/v1/language_service/helpers" if ::File.file? helper_path

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Language
       module V1
-        VERSION = "0.1.2"
+        VERSION = "0.1.3"
       end
     end
   end

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

@@ -17,3 +17,19 @@
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
 require "google/cloud/language/v1/language_service"
+require "google/cloud/language/v1/version"
+
+module Google
+  module Cloud
+    module Language
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/language/v1"
+      #     client = Google::Cloud::Language::V1::LanguageService::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

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

@@ -1 +1,21 @@
-require "google/cloud/language/v1/version"
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/language/v1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-language-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common