Retail V2 API - Class Google::Cloud::Retail::V2::CompleteQueryResponse (v1.1.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CompleteQueryResponse.

Response of the autocomplete query.

Inherits

def attribute_results() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CompleteQueryResponse::AttributeResult}

Returns

def attribute_results=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CompleteQueryResponse::AttributeResult}

Parameter

value (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CompleteQueryResponse::AttributeResult}) —
A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:
- brands
- categories

Returns

def attribution_token() -> ::String

Returns

(::String) — A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.

def attribution_token=(value) -> ::String

Parameter

value (::String) — A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.

Returns

(::String) — A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.

def completion_results() -> ::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>

Returns

(::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>) — Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

def completion_results=(value) -> ::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>

Parameter

value (::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>) — Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

Returns

(::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>) — Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

def recent_search_results() -> ::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>

Returns

def recent_search_results=(value) -> ::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>

Parameter

value (::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>) — 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 field is set and UserEvent is imported. The recent searches satisfy the follow rules:
- They are ordered from latest to oldest.
- They are matched with 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.

Returns