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.



18693
18694
18695
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18693

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

Instance Attribute Details

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

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

Returns:



18626
18627
18628
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18626

def boost_spec
  @boost_spec
end

#experiment_ids ⇒ Array<String>

Optional. Experiment ids for this request. Corresponds to the JSON property experimentIds

Returns:

  • (Array<String>) 


18631
18632
18633
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18631

def experiment_ids
  @experiment_ids
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) 


18638
18639
18640
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18638

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) 


18649
18650
18651
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18649

def query
  @query
end

#query_model ⇒ String

Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. 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) 


18664
18665
18666
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18664

def query_model
  @query_model
end

#suggestion_type_specs ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec>

Optional. Specification of each suggestion type. Corresponds to the JSON property suggestionTypeSpecs

Returns:



18669
18670
18671
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18669

def suggestion_type_specs
  @suggestion_type_specs
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>) 


18675
18676
18677
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18675

def suggestion_types
  @suggestion_types
end

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

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

Returns:



18680
18681
18682
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18680

def 
  @user_info
end

#user_pseudo_id ⇒ String

Optional. 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) 


18691
18692
18693
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18691

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18698

def update!(**args)
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
  @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
  @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_type_specs = args[:suggestion_type_specs] if args.key?(:suggestion_type_specs)
  @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