Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchParams (v1.1.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchParams.

Search parameters.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boost_spec

def boost_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec
Returns

#boost_spec=

def boost_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec
Parameter
Returns

#data_store_specs

def data_store_specs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — 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.

#data_store_specs=

def data_store_specs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>
Parameter
  • value (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — 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.
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — 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.

#filter

def filter() -> ::String
Returns
  • (::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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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

Returns
  • (::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

#max_return_results

def max_return_results() -> ::Integer
Returns
  • (::Integer) — Number of search results to return. The default value is 10.

#max_return_results=

def max_return_results=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of search results to return. The default value is 10.
Returns
  • (::Integer) — Number of search results to return. The default value is 10.

#order_by

def order_by() -> ::String
Returns
  • (::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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#search_result_mode

def search_result_mode() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode
Returns

#search_result_mode=

def search_result_mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode
Parameter
Returns