Struct google_api_proto::google::cloud::discoveryengine::v1alpha::answer_query_request::search_spec::SearchParams

pub struct SearchParams {
    pub max_return_results: i32,
    pub filter: String,
    pub boost_spec: Option<BoostSpec>,
    pub order_by: String,
    pub search_result_mode: i32,
    pub custom_fine_tuning_spec: Option<CustomFineTuningSpec>,
    pub data_store_specs: Vec<DataStoreSpec>,
}

Search parameters.

Fields

max_return_results: i32

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

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

boost_spec: Option<BoostSpec>

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

order_by: String

The order in which documents are returned. Documents can be ordered by a field in an [Document][google.cloud.discoveryengine.v1alpha.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: i32

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

custom_fine_tuning_spec: Option<CustomFineTuningSpec>

Custom fine tuning configs.

data_store_specs: Vec<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.

Implementations

impl SearchParams

pub fn search_result_mode(&self) -> SearchResultMode

Returns the enum value of search_result_mode, or the default if the field is set to an invalid enum value.

pub fn set_search_result_mode(&mut self, value: SearchResultMode)

Sets search_result_mode to the provided enum value.

Trait Implementations

impl Clone for SearchParams

fn clone(&self) -> SearchParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SearchParams

fn eq(&self, other: &SearchParams) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SearchParams