Module: Google::Cloud::DataQnA::V1alpha::AutoSuggestionService

Defined in:

lib/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb,
lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/paths.rb,
lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/client.rb,
lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/credentials.rb

Overview

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
}

Examples:

Load this service and instantiate a gRPC client

require "google/cloud/dataqna/v1alpha/auto_suggestion_service"
client = ::Google::Cloud::DataQnA::V1alpha::AutoSuggestionService::Client.new

Defined Under Namespace

Modules: Paths Classes: Client, Credentials