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 } ``` v1alpha

v1alpha.QuestionServiceClient

Service to interpret natural language queries. The service allows to create Question resources that are interpreted and are filled with one or more interpretations if the question could be interpreted. Once a Question resource is created and has at least one interpretation, an interpretation can be chosen for execution, which triggers a query to the backend (for BigQuery, it will create a job). Upon successful execution of that interpretation, backend specific information will be returned so that the client can retrieve the results from the backend.

The Question resources are named projects/* /locations/* /questions/*.

The Question resource has a singletion sub-resource UserFeedback named projects/* /locations/* /questions/* /userFeedback, which allows access to user feedback. v1alpha

Variables

_default

_default: {
    v1alpha: typeof v1alpha;
    AutoSuggestionServiceClient: typeof v1alpha.AutoSuggestionServiceClient;
    QuestionServiceClient: typeof v1alpha.QuestionServiceClient;
}

AutoSuggestionServiceClient

AutoSuggestionServiceClient: typeof v1alpha.AutoSuggestionServiceClient

QuestionServiceClient

QuestionServiceClient: typeof v1alpha.QuestionServiceClient

Type Aliases

AutoSuggestionServiceClient

type AutoSuggestionServiceClient = v1alpha.AutoSuggestionServiceClient;

protos.google.cloud.dataqna.v1alpha.AutoSuggestionService.SuggestQueriesCallback

type SuggestQueriesCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.SuggestQueriesResponse) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.CreateQuestionCallback

type CreateQuestionCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.Question) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.ExecuteQuestionCallback

type ExecuteQuestionCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.Question) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.GetQuestionCallback

type GetQuestionCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.Question) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.GetUserFeedbackCallback

type GetUserFeedbackCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.UserFeedback) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.UpdateUserFeedbackCallback

type UpdateUserFeedbackCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.UserFeedback) => void;

Callback as used by .

QuestionServiceClient

type QuestionServiceClient = v1alpha.QuestionServiceClient;

Package @google-cloud/data-qna (2.1.2)

Classes

Interfaces