Class AutoSuggestionServiceClient (1.0.0-alpha03)

public abstract class AutoSuggestionServiceClient

AutoSuggestionService client wrapper, for convenient use.

Inheritance

Object > AutoSuggestionServiceClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

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: &quot;locations/us/projects/my-project&quot;
scopes:
&quot;//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table&quot;
query: &quot;top it&quot;
})

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: &quot;top item by sum of usd_revenue_net&quot;
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: &quot;item&quot;
markups {
type: DIMENSION
start_char_index: 4
length: 2
}
}
query_matches {
start_char_index: 0
length: 6
}
}
suggestion_type: ENTITY
ranking_score: 0.8
}

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AutoSuggestionService service, which is a host of "dataqna.googleapis.com" and a port of 443.

Property Value
Type	Description
`String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AutoSuggestionService scopes.

Property Value
Type	Description
`IReadOnlyList<String>`

Remarks

The default AutoSuggestionService scopes are:

https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual AutoSuggestionService.AutoSuggestionServiceClient GrpcClient { get; }

The underlying gRPC AutoSuggestionService client

Property Value
Type	Description
`AutoSuggestionService.AutoSuggestionServiceClient`

Methods

Create()

public static AutoSuggestionServiceClient Create()

Synchronously creates a AutoSuggestionServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AutoSuggestionServiceClientBuilder.

Returns
Type	Description
`AutoSuggestionServiceClient`	The created AutoSuggestionServiceClient.

CreateAsync(CancellationToken)

public static Task<AutoSuggestionServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a AutoSuggestionServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AutoSuggestionServiceClientBuilder.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`Task<AutoSuggestionServiceClient>`	The task representing the created AutoSuggestionServiceClient.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

SuggestQueries(SuggestQueriesRequest, CallSettings)

public virtual 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.

Example

// Create client
AutoSuggestionServiceClient autoSuggestionServiceClient = AutoSuggestionServiceClient.Create();
// Initialize request argument(s)
SuggestQueriesRequest request = new SuggestQueriesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Scopes = { "", },
    Query = "",
    SuggestionTypes =
    {
        SuggestionType.Unspecified,
    },
};
// Make the request
SuggestQueriesResponse response = autoSuggestionServiceClient.SuggestQueries(request);

SuggestQueriesAsync(SuggestQueriesRequest, CallSettings)

public virtual 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
`Task<SuggestQueriesResponse>`	A Task containing the RPC response.

Example

// Create client
AutoSuggestionServiceClient autoSuggestionServiceClient = await AutoSuggestionServiceClient.CreateAsync();
// Initialize request argument(s)
SuggestQueriesRequest request = new SuggestQueriesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Scopes = { "", },
    Query = "",
    SuggestionTypes =
    {
        SuggestionType.Unspecified,
    },
};
// Make the request
SuggestQueriesResponse response = await autoSuggestionServiceClient.SuggestQueriesAsync(request);

SuggestQueriesAsync(SuggestQueriesRequest, CancellationToken)

public virtual Task<SuggestQueriesResponse> SuggestQueriesAsync(SuggestQueriesRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<SuggestQueriesResponse>`	A Task containing the RPC response.

Example

// Create client
AutoSuggestionServiceClient autoSuggestionServiceClient = await AutoSuggestionServiceClient.CreateAsync();
// Initialize request argument(s)
SuggestQueriesRequest request = new SuggestQueriesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Scopes = { "", },
    Query = "",
    SuggestionTypes =
    {
        SuggestionType.Unspecified,
    },
};
// Make the request
SuggestQueriesResponse response = await autoSuggestionServiceClient.SuggestQueriesAsync(request);