Retail v2 API - Class CompleteQueryResponse (2.12.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

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

AttributeResults

public MapField<string, CompleteQueryResponse.Types.AttributeResult> AttributeResults { get; }

A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:

  • brands

  • categories

Property Value
Type Description
MapFieldstringCompleteQueryResponseTypesAttributeResult

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

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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