#[non_exhaustive]pub struct AgenticRetrieveConfigurationBuilder { /* private fields */ }Expand description
A builder for AgenticRetrieveConfiguration.
Implementations§
Source§impl AgenticRetrieveConfigurationBuilder
impl AgenticRetrieveConfigurationBuilder
Sourcepub fn foundation_model_type(self, input: FoundationModelType) -> Self
pub fn foundation_model_type(self, input: FoundationModelType) -> Self
The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
Sourcepub fn set_foundation_model_type(
self,
input: Option<FoundationModelType>,
) -> Self
pub fn set_foundation_model_type( self, input: Option<FoundationModelType>, ) -> Self
The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
Sourcepub fn get_foundation_model_type(&self) -> &Option<FoundationModelType>
pub fn get_foundation_model_type(&self) -> &Option<FoundationModelType>
The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
Sourcepub fn foundation_model_configuration(
self,
input: FoundationModelConfiguration,
) -> Self
pub fn foundation_model_configuration( self, input: FoundationModelConfiguration, ) -> Self
The foundation model configuration. Required when foundationModelType is CUSTOM.
Sourcepub fn set_foundation_model_configuration(
self,
input: Option<FoundationModelConfiguration>,
) -> Self
pub fn set_foundation_model_configuration( self, input: Option<FoundationModelConfiguration>, ) -> Self
The foundation model configuration. Required when foundationModelType is CUSTOM.
Sourcepub fn get_foundation_model_configuration(
&self,
) -> &Option<FoundationModelConfiguration>
pub fn get_foundation_model_configuration( &self, ) -> &Option<FoundationModelConfiguration>
The foundation model configuration. Required when foundationModelType is CUSTOM.
Sourcepub fn reranking_model_type(
self,
input: AgenticRetrieveRerankingModelType,
) -> Self
pub fn reranking_model_type( self, input: AgenticRetrieveRerankingModelType, ) -> Self
The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
Sourcepub fn set_reranking_model_type(
self,
input: Option<AgenticRetrieveRerankingModelType>,
) -> Self
pub fn set_reranking_model_type( self, input: Option<AgenticRetrieveRerankingModelType>, ) -> Self
The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
Sourcepub fn get_reranking_model_type(
&self,
) -> &Option<AgenticRetrieveRerankingModelType>
pub fn get_reranking_model_type( &self, ) -> &Option<AgenticRetrieveRerankingModelType>
The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
Sourcepub fn reranking_configuration(
self,
input: AgenticRetrieveRerankingConfiguration,
) -> Self
pub fn reranking_configuration( self, input: AgenticRetrieveRerankingConfiguration, ) -> Self
The reranking model configuration. Required when rerankingModelType is CUSTOM.
Sourcepub fn set_reranking_configuration(
self,
input: Option<AgenticRetrieveRerankingConfiguration>,
) -> Self
pub fn set_reranking_configuration( self, input: Option<AgenticRetrieveRerankingConfiguration>, ) -> Self
The reranking model configuration. Required when rerankingModelType is CUSTOM.
Sourcepub fn get_reranking_configuration(
&self,
) -> &Option<AgenticRetrieveRerankingConfiguration>
pub fn get_reranking_configuration( &self, ) -> &Option<AgenticRetrieveRerankingConfiguration>
The reranking model configuration. Required when rerankingModelType is CUSTOM.
Sourcepub fn max_agent_iteration(self, input: i32) -> Self
pub fn max_agent_iteration(self, input: i32) -> Self
The maximum number of agent iterations for retrieval.
Sourcepub fn set_max_agent_iteration(self, input: Option<i32>) -> Self
pub fn set_max_agent_iteration(self, input: Option<i32>) -> Self
The maximum number of agent iterations for retrieval.
Sourcepub fn get_max_agent_iteration(&self) -> &Option<i32>
pub fn get_max_agent_iteration(&self) -> &Option<i32>
The maximum number of agent iterations for retrieval.
Sourcepub fn build(self) -> AgenticRetrieveConfiguration
pub fn build(self) -> AgenticRetrieveConfiguration
Consumes the builder and constructs a AgenticRetrieveConfiguration.
Trait Implementations§
Source§impl Clone for AgenticRetrieveConfigurationBuilder
impl Clone for AgenticRetrieveConfigurationBuilder
Source§fn clone(&self) -> AgenticRetrieveConfigurationBuilder
fn clone(&self) -> AgenticRetrieveConfigurationBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for AgenticRetrieveConfigurationBuilder
impl Default for AgenticRetrieveConfigurationBuilder
Source§fn default() -> AgenticRetrieveConfigurationBuilder
fn default() -> AgenticRetrieveConfigurationBuilder
impl StructuralPartialEq for AgenticRetrieveConfigurationBuilder
Auto Trait Implementations§
impl Freeze for AgenticRetrieveConfigurationBuilder
impl RefUnwindSafe for AgenticRetrieveConfigurationBuilder
impl Send for AgenticRetrieveConfigurationBuilder
impl Sync for AgenticRetrieveConfigurationBuilder
impl Unpin for AgenticRetrieveConfigurationBuilder
impl UnsafeUnpin for AgenticRetrieveConfigurationBuilder
impl UnwindSafe for AgenticRetrieveConfigurationBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);