Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Request message for CompletionService.AdvancedCompleteQuery method. .

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest

Returns a new instance of GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest.



9696
9697
9698
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9696

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec

Specification to boost suggestions based on the condtion of the suggestion. Corresponds to the JSON property boostSpec

Returns:



9640
9641
9642
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9640

def boost_spec
  @boost_spec
end

#include_tail_suggestions ⇒ Boolean Also known as: include_tail_suggestions?

Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. Corresponds to the JSON property includeTailSuggestions

Returns:

  • (Boolean) 


9647
9648
9649
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9647

def include_tail_suggestions
  @include_tail_suggestions
end

#query ⇒ String

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an INVALID_ARGUMENT error is returned. The exception is when the suggestion_types contains only the type RECENT_SEARCH, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. Corresponds to the JSON property query

Returns:

  • (String) 


9658
9659
9660
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9658

def query
  @query
end

#query_model ⇒ String

Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * document - Using suggestions generated from user- imported documents. * search-history - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * user-event - Using suggestions generated from user- imported search events. * document-completable - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * document is the default model for regular dataStores. * search- history is the default model for site search dataStores. Corresponds to the JSON property queryModel

Returns:

  • (String) 


9672
9673
9674
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9672

def query_model
  @query_model
end

#suggestion_types ⇒ Array<String>

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. Corresponds to the JSON property suggestionTypes

Returns:

  • (Array<String>) 


9678
9679
9680
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9678

def suggestion_types
  @suggestion_types
end

#user_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserInfo

Information of an end user. Corresponds to the JSON property userInfo

Returns:



9683
9684
9685
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9683

def 
  @user_info
end

#user_pseudo_id ⇒ String

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as unknown_visitor. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 Corresponds to the JSON property userPseudoId

Returns:

  • (String) 


9694
9695
9696
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9694

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9701
9702
9703
9704
9705
9706
9707
9708
9709
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9701

def update!(**args)
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
  @include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
  @query = args[:query] if args.key?(:query)
  @query_model = args[:query_model] if args.key?(:query_model)
  @suggestion_types = args[:suggestion_types] if args.key?(:suggestion_types)
  @user_info = args[:user_info] if args.key?(:user_info)
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
end