Struct googapis::google::cloud::dataqna::v1alpha::auto_suggestion_service_client::AutoSuggestionServiceClient

pub struct AutoSuggestionServiceClient<T> { /* fields omitted */ }

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
}

Implementations

impl<T> AutoSuggestionServiceClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor<F>(
    inner: T,
    interceptor: F
) -> AutoSuggestionServiceClient<InterceptedService<T, F>> where
    F: Interceptor,
    T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
    <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync, 

pub fn send_gzip(self) -> Self

Compress requests with gzip.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_gzip(self) -> Self

Enable decompressing responses with gzip.

pub async fn suggest_queries(
    &mut self,
    request: impl IntoRequest<SuggestQueriesRequest>
) -> Result<Response<SuggestQueriesResponse>, Status>

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

Trait Implementations

impl<T: Clone> Clone for AutoSuggestionServiceClient<T>

fn clone(&self) -> AutoSuggestionServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for AutoSuggestionServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.