google-cloud-dataqna-v1alpha 0.13.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f81be9ddc8a976652592fb835663333da7db6552ee9f19bcccd6c6f224913811
-  data.tar.gz: c0f1e469bbec3a208f0775cacead8c04407781224876f3f4c692e20c5d3d825e
+  metadata.gz: ae6725b19074a40da890a18ca073bed6113b0a318c804e4ea4937cce25da0dac
+  data.tar.gz: 0faccbb6c7bf31e3dca1b11434488da0e1d35b1588ef6501827c5790851637b3
 SHA512:
-  metadata.gz: 8f007e773bc1084718862c9150256288232928d88f1e1d8a6df76bb02efc458a1fccb5f96d912890b0c9944c1659e8a0bbce4ce353d1f86c19a5ef02d39f6a32
-  data.tar.gz: d16697471270d53f9a66f4003b58b36db65cbfcbdb091edbe811dc80e7b1755f540170f5b7e078edb4fe4222bcd0ee9431e37d784f24d6fa2a6ef8a22f83bbc2
+  metadata.gz: b79b724d9c58271ef465605c0638a4a7347ee18d4b7ed0204864d36fbf8ab91d8e773dfa9401dc786d7c6b0b315ced47d9e29b2887c06384c79eb7d7a113e30c
+  data.tar.gz: 337d8de87838009acabd6e9a952d9fe3a0a91297ddfc860500ee97518f01e43550553a5786dff406633e6acef2837196481b12189ea00d52ab01b70d8634cbce

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title="BigQuery Data QnA V1alpha API"
+--title="Data QnA V1ALPHA API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/README.md

@@ -1,4 +1,4 @@
-# Ruby Client for the BigQuery Data QnA V1alpha API
+# Ruby Client for the Data QnA V1ALPHA API
 
 Data QnA is a natural language question and answer service for BigQuery data.
 
@@ -6,7 +6,7 @@ Data QnA is a natural language question and answer service for BigQuery data.
 https://github.com/googleapis/google-cloud-ruby
 
 This gem is a _versioned_ client. It provides basic client classes for a
-specific version of the BigQuery Data QnA V1alpha API. Most users should consider using
+specific version of the Data QnA V1ALPHA API. Most users should consider using
 the main client gem,
 [google-cloud-dataqna](https://rubygems.org/gems/google-cloud-dataqna).
 See the section below titled *Which client should I use?* for more information.

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/credentials.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/paths.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/rest/client.rb

@@ -0,0 +1,510 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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!
+
+require "google/cloud/errors"
+require "google/cloud/dataqna/v1alpha/auto_suggestion_service_pb"
+require "google/cloud/dataqna/v1alpha/auto_suggestion_service/rest/service_stub"
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        module AutoSuggestionService
+          module Rest
+            ##
+            # REST client for the AutoSuggestionService service.
+            #
+            # This stateless API provides automatic suggestions for natural language
+            # queries for the data sources in the provided project and location.
+            #
+            # The service provides a resourceless operation `suggestQueries` that can be
+            # called to get a list of suggestions for a given incomplete query and scope
+            # (or list of scopes) under which the query is to be interpreted.
+            #
+            # There are two types of suggestions, ENTITY for single entity suggestions
+            # and TEMPLATE for full sentences. By default, both types are returned.
+            #
+            # Example Request:
+            # ```
+            # GetSuggestions({
+            #   parent: "locations/us/projects/my-project"
+            #   scopes:
+            #   "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table"
+            #   query: "top it"
+            # })
+            # ```
+            #
+            # The service will retrieve information based on the given scope(s) and give
+            # suggestions based on that (e.g. "top item" for "top it" if "item" is a known
+            # dimension for the provided scope).
+            # ```
+            # suggestions {
+            #   suggestion_info {
+            #     annotated_suggestion {
+            #       text_formatted: "top item by sum of usd_revenue_net"
+            #       markups {
+            #         type: DIMENSION
+            #         start_char_index: 4
+            #         length: 4
+            #       }
+            #       markups {
+            #         type: METRIC
+            #         start_char_index: 19
+            #         length: 15
+            #       }
+            #     }
+            #     query_matches {
+            #       start_char_index: 0
+            #       length: 6
+            #     }
+            #   }
+            #   suggestion_type: TEMPLATE
+            #   ranking_score: 0.9
+            # }
+            # suggestions {
+            #   suggestion_info {
+            #     annotated_suggestion {
+            #       text_formatted: "item"
+            #       markups {
+            #         type: DIMENSION
+            #         start_char_index: 4
+            #         length: 2
+            #       }
+            #     }
+            #     query_matches {
+            #       start_char_index: 0
+            #       length: 6
+            #     }
+            #   }
+            #   suggestion_type: ENTITY
+            #   ranking_score: 0.8
+            # }
+            # ```
+            #
+            class Client
+              # @private
+              API_VERSION = ""
+
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "dataqna.$UNIVERSE_DOMAIN$"
+
+              include Paths
+
+              # @private
+              attr_reader :auto_suggestion_service_stub
+
+              ##
+              # Configure the AutoSuggestionService Client class.
+              #
+              # See {::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @example
+              #
+              #   # Modify the configuration for all AutoSuggestionService clients
+              #   ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  namespace = ["Google", "Cloud", "DataQnA", "V1alpha"]
+                  parent_config = while namespace.any?
+                                    parent_name = namespace.join "::"
+                                    parent_const = const_get parent_name
+                                    break parent_const.configure if parent_const.respond_to? :configure
+                                    namespace.pop
+                                  end
+                  default_config = Client::Configuration.new parent_config
+
+                  default_config.timeout = 2.0
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the AutoSuggestionService Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @auto_suggestion_service_stub.universe_domain
+              end
+
+              ##
+              # Create a new AutoSuggestionService REST client object.
+              #
+              # @example
+              #
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client.new
+              #
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the AutoSuggestionService client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                # Use self-signed JWT if the endpoint is unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
+                credentials ||= Credentials.default scope: @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                  credentials = Credentials.new credentials, scope: @config.scope
+                end
+
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @auto_suggestion_service_stub = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials,
+                  logger: @config.logger
+                )
+
+                @auto_suggestion_service_stub.logger(stub: true)&.info do |entry|
+                  entry.set_system_name
+                  entry.set_service
+                  entry.message = "Created client for #{entry.service}"
+                  entry.set_credentials_fields credentials
+                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                  entry.set "defaultTimeout", @config.timeout if @config.timeout
+                  entry.set "quotaProject", @quota_project_id if @quota_project_id
+                end
+              end
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @auto_suggestion_service_stub.logger
+              end
+
+              # Service calls
+
+              ##
+              # Gets a list of suggestions based on a prefix string.
+              # AutoSuggestion tolerance should be less than 1 second.
+              #
+              # @overload suggest_queries(request, options = nil)
+              #   Pass arguments to `suggest_queries` via a request object, either of type
+              #   {::Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest, ::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 suggest_queries(parent: nil, scopes: nil, query: nil, suggestion_types: nil)
+              #   Pass arguments to `suggest_queries` 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 parent [::String]
+              #     Required. The parent of the suggestion query is the resource denoting the project and
+              #     location.
+              #   @param scopes [::Array<::String>]
+              #     The scopes to which this search is restricted. The only supported scope
+              #     pattern is
+              #     `//bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}`.
+              #   @param query [::String]
+              #     User query for which to generate suggestions. If the query is empty, zero
+              #     state suggestions are returned. This allows UIs to display suggestions
+              #     right away, helping the user to get a sense of what a query might look
+              #     like.
+              #   @param suggestion_types [::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>]
+              #     The requested suggestion type. Multiple suggestion types can be
+              #     requested, but there is no guarantee that the service will return
+              #     suggestions for each type. Suggestions for a requested type might rank
+              #     lower than suggestions for other types and the service may decide to cut
+              #     these suggestions off.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/dataqna/v1alpha"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest.new
+              #
+              #   # Call the suggest_queries method.
+              #   result = client.suggest_queries request
+              #
+              #   # The returned object is of type Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse.
+              #   p result
+              #
+              def suggest_queries request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.suggest_queries.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::DataQnA::V1alpha::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.suggest_queries.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.suggest_queries.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @auto_suggestion_service_stub.suggest_queries request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Configuration class for the AutoSuggestionService REST API.
+              #
+              # This class represents the configuration for AutoSuggestionService REST,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # suggest_queries to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.suggest_queries.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.suggest_queries.timeout = 20.0
+              #   end
+              #
+              # @!attribute [rw] endpoint
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+              #    *  (`nil`) indicating no credentials
+              #
+              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   external source for authentication to Google Cloud, you must validate it before
+              #   providing it to a Google API client library. Providing an unvalidated credential
+              #   configuration to Google APIs can compromise the security of your systems and data.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
+                DEFAULT_ENDPOINT = "dataqna.googleapis.com"
+
+                config_attr :endpoint,      nil, ::String, nil
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration RPC class for the AutoSuggestionService API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `suggest_queries`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :suggest_queries
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    suggest_queries_config = parent_rpcs.suggest_queries if parent_rpcs.respond_to? :suggest_queries
+                    @suggest_queries = ::Gapic::Config::Method.new suggest_queries_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end