Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams

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

Overview

Search parameters.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams

Returns a new instance of GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams.



884
885
886
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 884

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

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpec

Boost specification to boost certain documents. Corresponds to the JSON property boostSpec

Returns:



837
838
839
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 837

def boost_spec
  @boost_spec
end

#data_store_specs ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. Corresponds to the JSON property dataStoreSpecs

Returns:



845
846
847
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 845

def data_store_specs
  @data_store_specs
end

#filter ⇒ String

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter Corresponds to the JSON property filter

Returns:

  • (String) 


861
862
863
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 861

def filter
  @filter
end

#max_return_results ⇒ Fixnum

Number of search results to return. The default value is 10. Corresponds to the JSON property maxReturnResults

Returns:

  • (Fixnum) 


866
867
868
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 866

def max_return_results
  @max_return_results
end

#order_by ⇒ String

The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. order_by expression is case-sensitive. For more information on ordering, see Ordering If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property orderBy

Returns:

  • (String) 


875
876
877
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 875

def order_by
  @order_by
end

#search_result_mode ⇒ String

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS. See parse and chunk documents Corresponds to the JSON property searchResultMode

Returns:

  • (String) 


882
883
884
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 882

def search_result_mode
  @search_result_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



889
890
891
892
893
894
895
896
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 889

def update!(**args)
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
  @filter = args[:filter] if args.key?(:filter)
  @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
  @order_by = args[:order_by] if args.key?(:order_by)
  @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
end