BigQuery Data QnA V1alpha API - Class Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client (v0.2.6)

Reference documentation and code samples for the BigQuery Data QnA V1alpha API 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 }

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AutoSuggestionService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all AutoSuggestionService clients
::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

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

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new AutoSuggestionService client object.

Yields
  • (config) — Configure the AutoSuggestionService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
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

#suggest_queries

def suggest_queries(request, options = nil) -> ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse
def suggest_queries(parent: nil, scopes: nil, query: nil, suggestion_types: nil) -> ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse

Gets a list of suggestions based on a prefix string. AutoSuggestion tolerance should be less than 1 second.

Overloads 
def suggest_queries(request, options = nil) -> ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse
Pass arguments to suggest_queries via a request object, either of type SuggestQueriesRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def suggest_queries(parent: nil, scopes: nil, query: nil, suggestion_types: nil) -> ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse
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).
Parameters
  • parent (::String) — Required. The parent of the suggestion query is the resource denoting the project and location.
  • 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}.
  • 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.
  • 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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