Discovery Engine v1beta API - Class CompletionService.CompletionServiceBase (1.0.0-beta24)

[BindServiceMethod(typeof(CompletionService), "BindService")]
public abstract class CompletionService.CompletionServiceBase

Reference documentation and code samples for the Discovery Engine v1beta API class CompletionService.CompletionServiceBase.

Base class for server-side implementations of CompletionService

Inheritance

object > CompletionService.CompletionServiceBase

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Methods

AdvancedCompleteQuery(AdvancedCompleteQueryRequest, ServerCallContext)

public virtual Task<AdvancedCompleteQueryResponse> AdvancedCompleteQuery(AdvancedCompleteQueryRequest request, ServerCallContext context)

Completes the user input with advanced keyword suggestions.

Parameters
Name Description
request AdvancedCompleteQueryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskAdvancedCompleteQueryResponse

The response to send back to the client (wrapped by a task).

CompleteQuery(CompleteQueryRequest, ServerCallContext)

public virtual Task<CompleteQueryResponse> CompleteQuery(CompleteQueryRequest request, ServerCallContext context)

Completes the specified user input with keyword suggestions.

Parameters
Name Description
request CompleteQueryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCompleteQueryResponse

The response to send back to the client (wrapped by a task).

ImportCompletionSuggestions(ImportCompletionSuggestionsRequest, ServerCallContext)

public virtual Task<Operation> ImportCompletionSuggestions(ImportCompletionSuggestionsRequest request, ServerCallContext context)

Imports [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s for a DataStore.

Parameters
Name Description
request ImportCompletionSuggestionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest, ServerCallContext)

public virtual Task<Operation> ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest request, ServerCallContext context)

Imports all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] for a DataStore.

Parameters
Name Description
request ImportSuggestionDenyListEntriesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest, ServerCallContext)

public virtual Task<Operation> PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest request, ServerCallContext context)

Permanently deletes all [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s for a DataStore.

Parameters
Name Description
request PurgeCompletionSuggestionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest, ServerCallContext)

public virtual Task<Operation> PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest request, ServerCallContext context)

Permanently deletes all [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] for a DataStore.

Parameters
Name Description
request PurgeSuggestionDenyListEntriesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

RemoveSuggestion(RemoveSuggestionRequest, ServerCallContext)

public virtual Task<RemoveSuggestionResponse> RemoveSuggestion(RemoveSuggestionRequest request, ServerCallContext context)

Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the [AdvancedCompleteQueryResponse.recent_search_suggestions][google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.recent_search_suggestions] for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.

Parameters
Name Description
request RemoveSuggestionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRemoveSuggestionResponse

The response to send back to the client (wrapped by a task).