Discovery Engine v1beta API - Class RemoveSuggestionRequest (1.0.0-beta24)

public sealed class RemoveSuggestionRequest : IMessage<RemoveSuggestionRequest>, IEquatable<RemoveSuggestionRequest>, IDeepCloneable<RemoveSuggestionRequest>, IBufferMessage, IMessage

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

Request message for [CompletionService.RemoveSuggestion][google.cloud.discoveryengine.v1beta.CompletionService.RemoveSuggestion] method.

Inheritance

object > RemoveSuggestionRequest

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

RemoveSuggestionRequest()

public RemoveSuggestionRequest()

RemoveSuggestionRequest(RemoveSuggestionRequest)

public RemoveSuggestionRequest(RemoveSuggestionRequest other)
Parameter
Name Description
other RemoveSuggestionRequest

Properties

CompletionConfig

public string CompletionConfig { get; set; }

Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Property Value
Type Description
string

CompletionConfigAsCompletionConfigName

public CompletionConfigName CompletionConfigAsCompletionConfigName { get; set; }

CompletionConfigName-typed view over the CompletionConfig resource name property.

Property Value
Type Description
CompletionConfigName

HasRemoveAllSearchHistorySuggestions

public bool HasRemoveAllSearchHistorySuggestions { get; }

Gets whether the "remove_all_search_history_suggestions" field is set

Property Value
Type Description
bool

HasSearchHistorySuggestion

public bool HasSearchHistorySuggestion { get; }

Gets whether the "search_history_suggestion" field is set

Property Value
Type Description
bool

RemoveAllSearchHistorySuggestions

public bool RemoveAllSearchHistorySuggestions { get; set; }

Remove all search history suggestions for the user.

Property Value
Type Description
bool

RemoveTime

public Timestamp RemoveTime { get; set; }

Required. Time at which the suggestion was removed. If not set, the current time will be used.

Property Value
Type Description
Timestamp

SearchHistorySuggestion

public string SearchHistorySuggestion { get; set; }

The search history suggestion to be removed.

Property Value
Type Description
string

SuggestionCase

public RemoveSuggestionRequest.SuggestionOneofCase SuggestionCase { get; }
Property Value
Type Description
RemoveSuggestionRequestSuggestionOneofCase

UserInfo

public UserInfo UserInfo { get; set; }

Optional. Information about the end user.

This should be the same identifier information as [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info] and [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].

Property Value
Type Description
UserInfo

UserPseudoId

public string UserPseudoId { get; set; }

Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor.

This should be the same identifier as [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] and [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

The field must be a UTF-8 encoded string with a length limit of 128.

Property Value
Type Description
string