Class: Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/search_service.rb

Overview

Information describing query expansion including whether expansion has occurred.

Instance Attribute Summary

• #expanded_query ⇒ ::Boolean

  Bool describing whether query expansion has occurred.

• #pinned_result_count ⇒ ::Integer

  Number of pinned results.

Instance Attribute Details

#expanded_query ⇒ ::Boolean

Returns Bool describing whether query expansion has occurred.

Returns:

• (::Boolean) —

  Bool describing whether query expansion has occurred.

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1097

class QueryExpansionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pinned_result_count ⇒ ::Integer

Returns Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

Returns:

• (::Integer) —

  Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1097

class QueryExpansionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end