google-cloud-dataqna 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7795678834b4a824a9b9ba83b5b9fdc29d560fc9afe35ccf5fb22edd7c40199e
-  data.tar.gz: acfbf984b7c1dcde6529b9a8ee4ea5a7aeb77b215c68b1e31764ae3175bc0205
+  metadata.gz: 52ede2cd35c3895408e9974373c86a24ed4d3fe7734474f2751cdbd61720eada
+  data.tar.gz: 8436272c6ab6c5c20e56974899884d3aa4dd77bfe72c0d77d83b7c1007455059
 SHA512:
-  metadata.gz: 2352f44d6ac647a47562ea1266e23ad15bf10e10332bc398e3cd5c74d20eb65ee024ca154dd08dc665ede9bc02dbf1957c89cd7f4239b2202d0d5f68bd94dda9
-  data.tar.gz: b9c58a2e15ecf95244392b8d4e57eb967b4c678d0f754328817db32c209843ba425667b64d1cf45a8640f8245828d24336c5fa2da1c091c273b8e18d8f3b1b51
+  metadata.gz: 5297639337b284a1d3d60545e628f52e7f80d69ddf97b15aad04ed4c946c13c8e5743d945b19544b68d06995b2f2360e4cd7bd8e36e44efe7afda040e3ed030f
+  data.tar.gz: a9b60b2678eeefa577e47733913987deb0db5bfd51accd1be440c32d8ef52a7f8f99cf3850077fe1c0613f584cec954388cf49ccd3da58adc47d2e1b02036056

data/README.md

@@ -7,7 +7,7 @@ Data QnA is a natural language question and answer service for BigQuery data.
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-dataqna-v*`.
 The gem `google-cloud-dataqna` is the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -31,35 +31,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/dataqna.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## 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/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/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
-```
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-dataqna-v1alpha](https://cloud.google.com/ruby/docs/reference/google-cloud-dataqna-v1alpha/latest).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/dataqna/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module DataQnA
-      VERSION = "0.5.1"
+      VERSION = "0.6.1"
     end
   end
 end

data/lib/google/cloud/dataqna.rb

@@ -56,6 +56,11 @@ module Google
       # supported by that API version, and the corresponding gem is available, the
       # appropriate versioned client will be returned.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the AutoSuggestionService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::DataQnA.auto_suggestion_service_available?}.
+      #
       # ## About AutoSuggestionService
       #
       # This stateless API provides automatic suggestions for natural language
@@ -140,6 +145,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the AutoSuggestionService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::DataQnA.auto_suggestion_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the AutoSuggestionService service,
+      # or if the versioned client gem needs an update to support the AutoSuggestionService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1alpha`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.auto_suggestion_service_available? version: :v1alpha
+        require "google/cloud/dataqna/#{version.to_s.downcase}"
+        package_name = Google::Cloud::DataQnA
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::DataQnA.const_get package_name
+        return false unless service_module.const_defined? :AutoSuggestionService
+        service_module = service_module.const_get :AutoSuggestionService
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for QuestionService.
       #
@@ -151,6 +182,11 @@ module Google
       # supported by that API version, and the corresponding gem is available, the
       # appropriate versioned client will be returned.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the QuestionService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::DataQnA.question_service_available?}.
+      #
       # ## About QuestionService
       #
       # Service to interpret natural language queries.
@@ -184,6 +220,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the QuestionService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::DataQnA.question_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the QuestionService service,
+      # or if the versioned client gem needs an update to support the QuestionService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1alpha`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.question_service_available? version: :v1alpha
+        require "google/cloud/dataqna/#{version.to_s.downcase}"
+        package_name = Google::Cloud::DataQnA
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::DataQnA.const_get package_name
+        return false unless service_module.const_defined? :QuestionService
+        service_module = service_module.const_get :QuestionService
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-dataqna library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataqna
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: API Client library for the BigQuery Data QnA API
 test_files: []