Retail v2 API - Class CompleteQueryResponse (2.8.0)

Version latest

• 2.8.0 (latest)
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

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

Reference documentation and code samples for the Retail v2 API class CompleteQueryResponse.

Response of the autocomplete query.

Inheritance

object > CompleteQueryResponse

Implements

IMessageCompleteQueryResponse, IEquatableCompleteQueryResponse, IDeepCloneableCompleteQueryResponse, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CompleteQueryResponse()

public CompleteQueryResponse()

CompleteQueryResponse(CompleteQueryResponse)

public CompleteQueryResponse(CompleteQueryResponse other)

Parameter
Name	Description
other	CompleteQueryResponse

Properties

AttributionToken

public string AttributionToken { get; set; }

A unique complete token. This should be included in the [UserEvent.completion_detail][google.cloud.retail.v2.UserEvent.completion_detail] for search events resulting from this completion, which enables accurate attribution of complete model performance.

Property Value
Type	Description
string

CompletionResults

public RepeatedField<CompleteQueryResponse.Types.CompletionResult> CompletionResults { get; }

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

Property Value
Type	Description
RepeatedFieldCompleteQueryResponseTypesCompletionResult

RecentSearchResults

public RepeatedField<CompleteQueryResponse.Types.RecentSearchResult> RecentSearchResults { get; }

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when [CompleteQueryRequest.visitor_id][google.cloud.retail.v2.CompleteQueryRequest.visitor_id] field is set and [UserEvent][google.cloud.retail.v2.UserEvent] is imported. The recent searches satisfy the follow rules:

• They are ordered from latest to oldest.

• They are matched with [CompleteQueryRequest.query][google.cloud.retail.v2.CompleteQueryRequest.query] case insensitively.

• They are transformed to lower case.

• They are UTF-8 safe.

Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

Property Value
Type	Description
RepeatedFieldCompleteQueryResponseTypesRecentSearchResult