Package google.cloud.discoveryengine.v1

Index

CompletionService

Service for Auto-Completion.

CompleteQuery

rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse)

Completes the specified user input with keyword suggestions.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataStore resource:

  • discoveryengine.dataStores.completeQuery

For more information, see the IAM documentation.

ImportCompletionSuggestions

rpc ImportCompletionSuggestions(ImportCompletionSuggestionsRequest) returns (Operation)

Imports CompletionSuggestions for a DataStore.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ImportSuggestionDenyListEntries

rpc ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest) returns (Operation)

Imports all SuggestionDenyListEntry for a DataStore.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.suggestionDenyListEntries.import

For more information, see the IAM documentation.

PurgeCompletionSuggestions

rpc PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest) returns (Operation)

Permanently deletes all CompletionSuggestions for a DataStore.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

PurgeSuggestionDenyListEntries

rpc PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest) returns (Operation)

Permanently deletes all SuggestionDenyListEntry for a DataStore.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.suggestionDenyListEntries.purge

For more information, see the IAM documentation.

ControlService

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

CreateControl

rpc CreateControl(CreateControlRequest) returns (Control)

Creates a Control.

By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.controls.create

For more information, see the IAM documentation.

DeleteControl

rpc DeleteControl(DeleteControlRequest) returns (Empty)

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.controls.delete

For more information, see the IAM documentation.

GetControl

rpc GetControl(GetControlRequest) returns (Control)

Gets a Control.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.controls.get

For more information, see the IAM documentation.

ListControls

rpc ListControls(ListControlsRequest) returns (ListControlsResponse)

Lists all Controls by their parent DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https