Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams
- 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
-
#boost_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpec
Boost specification to boost certain documents.
-
#data_store_specs ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>
Specs defining dataStores to filter on in a search call and configurations for those dataStores.
-
#filter ⇒ String
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
-
#max_return_results ⇒ Fixnum
Number of search results to return.
-
#order_by ⇒ String
The order in which documents are returned.
-
#search_result_mode ⇒ String
Specifies the search result mode.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams
constructor
A new instance of GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams
Returns a new instance of GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams.
869 870 871 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 869 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
822 823 824 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 822 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
830 831 832 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 830 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
846 847 848 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 846 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
851 852 853 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 851 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
860 861 862 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 860 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
867 868 869 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 867 def search_result_mode @search_result_mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
874 875 876 877 878 879 880 881 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 874 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 |