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.



763
764
765
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 763

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:



731
732
733
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 731

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


747
748
749
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 747

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) 


752
753
754
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 752

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) 


761
762
763
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 761

def order_by
  @order_by
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



768
769
770
771
772
773
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 768

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