Struct SearchSource 

#[non_exhaustive]
pub struct SearchSource {
    pub serving_config: String,
    pub max_result_count: i32,
    pub filter: String,
    pub safe_search: bool,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Message to be used for grounding with Vertex AI Search.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

serving_config: String

The resource name of the Engine to use.

Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

max_result_count: i32

Number of search results to return.

The default value is 10. The maximumm allowed value is 10.

filter: String

Filter expression to be applied to the search.

The syntax is the same as SearchRequest.filter.

safe_search: bool

If set, safe search is enabled in Vertex AI Search requests.

Implementations

impl SearchSource

pub fn new() -> Self

pub fn set_serving_config<T: Into<String>>(self, v: T) -> Self

Sets the value of serving_config.

Example

let x = SearchSource::new().set_serving_config("example");

pub fn set_max_result_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_result_count.

Example

let x = SearchSource::new().set_max_result_count(42);

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = SearchSource::new().set_filter("example");

pub fn set_safe_search<T: Into<bool>>(self, v: T) -> Self

Sets the value of safe_search.

Example

let x = SearchSource::new().set_safe_search(true);

Trait Implementations

impl Clone for SearchSource

fn clone(&self) -> SearchSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchSource

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

Formats the value using the given formatter.

impl Default for SearchSource

fn default() -> SearchSource

Returns the “default value” for a type.

impl Message for SearchSource

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchSource

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SearchSource