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

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

Overview

Search parameters.

Instance Attribute Summary collapse

Instance Attribute Details

#boost_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::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:



424
425
426
427
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 424

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



424
425
426
427
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 424

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.



424
425
426
427
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 424

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.



424
425
426
427
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 424

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