Struct RetrieveOptions 

pub struct RetrieveOptions {
    pub query: String,
    pub scope_ids: ScopeIds,
    pub token_budget: Option<u32>,
    pub max_candidates: Option<u32>,
    pub include_redacted: Option<bool>,
}

Options for a retrieval request.

Fields

query: String

scope_ids: ScopeIds

token_budget: Option<u32>

Deprecated: token-budget assembly is a downstream-system responsibility. Prefer max_candidates for bounded result sets.

max_candidates: Option<u32>

include_redacted: Option<bool>

Trait Implementations

impl Clone for RetrieveOptions

fn clone(&self) -> RetrieveOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RetrieveOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RetrieveOptions

fn eq(&self, other: &RetrieveOptions) -> 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 Serialize for RetrieveOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RetrieveOptions