Data QnA v1alpha API - Class AutoSuggestionServiceClientImpl (2.0.0-alpha02) 

public sealed class AutoSuggestionServiceClientImpl : AutoSuggestionServiceClient

Reference documentation and code samples for the Data QnA v1alpha API class AutoSuggestionServiceClientImpl.

AutoSuggestionService client wrapper implementation, for convenient use.

Inheritance

object > AutoSuggestionServiceClient > AutoSuggestionServiceClientImpl

Namespace

Google.Cloud.DataQnA.V1Alpha

Assembly

Google.Cloud.DataQnA.V1Alpha.dll

Remarks

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
}

Constructors

AutoSuggestionServiceClientImpl(AutoSuggestionServiceClient, AutoSuggestionServiceSettings, ILogger)

public AutoSuggestionServiceClientImpl(AutoSuggestionService.AutoSuggestionServiceClient grpcClient, AutoSuggestionServiceSettings settings, ILogger logger)

Constructs a client wrapper for the AutoSuggestionService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient AutoSuggestionServiceAutoSuggestionServiceClient

The underlying gRPC client.
settings AutoSuggestionServiceSettings

The base AutoSuggestionServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override AutoSuggestionService.AutoSuggestionServiceClient GrpcClient { get; }

The underlying gRPC AutoSuggestionService client

Property Value
Type Description
AutoSuggestionServiceAutoSuggestionServiceClient
Overrides

Methods

SuggestQueries(SuggestQueriesRequest, CallSettings)

public override SuggestQueriesResponse SuggestQueries(SuggestQueriesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SuggestQueriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SuggestQueriesResponse

The RPC response.
Overrides

SuggestQueriesAsync(SuggestQueriesRequest, CallSettings)

public override Task<SuggestQueriesResponse> SuggestQueriesAsync(SuggestQueriesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SuggestQueriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSuggestQueriesResponse

A Task containing the RPC response.
Overrides