class Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client

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

} “`

Attributes

auto_suggestion_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the AutoSuggestionService Client class.

See {::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all AutoSuggestionService clients
::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb, line 121
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
new() { |config| ... } click to toggle source

Create a new AutoSuggestionService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the AutoSuggestionService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb, line 176
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/dataqna/v1alpha/auto_suggestion_service_services_pb"

  # 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 == Client.configure.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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

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::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb, line 155
def configure
  yield @config if block_given?
  @config
end
suggest_queries(request, options = nil) { |response, operation| ... } click to toggle source

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 [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb, line 260
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
  metadata = @config.rpcs.suggest_queries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  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
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.suggest_queries.timeout,
                         metadata:     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.call_rpc :suggest_queries, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end