Class: Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchParams

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb

Overview

Search parameters.

Instance Attribute Summary collapse

Instance Attribute Details

#boost_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec

Returns Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting.

Returns:



475
476
477
478
 
# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 475

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_store_specs ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>

Returns 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.



475
476
477
478
 
# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 475

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter ⇒ ::String

Returns 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



475
476
477
478
 
# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 475

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_return_results ⇒ ::Integer

Returns Number of search results to return. The default value is 10.

Returns:

  • (::Integer) —

    Number of search results to return. The default value is 10.



475
476
477
478
 
# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 475

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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.



475
476
477
478
 
# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 475

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#search_result_mode ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode

Returns Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS. See parse and chunk documents.

Returns:



475
476
477
478
 
# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 475

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end