Retail V2 API - Class Google::Cloud::Retail::V2::CompleteQueryResponse (v0.7.0)

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

Response of the auto-complete query.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attribution_token

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.

#attribution_token=

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.

#completion_results

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

#completion_results=

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

#recent_search_results

def recent_search_results() -> ::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>
Returns
  • (::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>) — 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 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 cases.
    • They are UTF-8 safe.

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

#recent_search_results=

def recent_search_results=(value) -> ::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>
Parameter
  • value (::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>) — 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 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 cases.
    • They are UTF-8 safe.

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

Returns
  • (::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>) — 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 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 cases.
    • They are UTF-8 safe.

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