#[non_exhaustive]pub struct KnowledgeBaseOrchestrationConfiguration {
pub prompt_template: Option<KnowledgeBasePromptTemplate>,
pub inference_config: Option<PromptInferenceConfiguration>,
pub additional_model_request_fields: Option<HashMap<String, Document>>,
pub performance_config: Option<PerformanceConfiguration>,
}
Expand description
Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.prompt_template: Option<KnowledgeBasePromptTemplate>
A custom prompt template for orchestrating the retrieval and generation process.
inference_config: Option<PromptInferenceConfiguration>
Contains inference configurations for the prompt.
additional_model_request_fields: Option<HashMap<String, Document>>
The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
performance_config: Option<PerformanceConfiguration>
The performance configuration options for the knowledge base retrieval and generation process.
Implementations§
Source§impl KnowledgeBaseOrchestrationConfiguration
impl KnowledgeBaseOrchestrationConfiguration
Sourcepub fn prompt_template(&self) -> Option<&KnowledgeBasePromptTemplate>
pub fn prompt_template(&self) -> Option<&KnowledgeBasePromptTemplate>
A custom prompt template for orchestrating the retrieval and generation process.
Sourcepub fn inference_config(&self) -> Option<&PromptInferenceConfiguration>
pub fn inference_config(&self) -> Option<&PromptInferenceConfiguration>
Contains inference configurations for the prompt.
Sourcepub fn additional_model_request_fields(
&self,
) -> Option<&HashMap<String, Document>>
pub fn additional_model_request_fields( &self, ) -> Option<&HashMap<String, Document>>
The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
Sourcepub fn performance_config(&self) -> Option<&PerformanceConfiguration>
pub fn performance_config(&self) -> Option<&PerformanceConfiguration>
The performance configuration options for the knowledge base retrieval and generation process.
Source§impl KnowledgeBaseOrchestrationConfiguration
impl KnowledgeBaseOrchestrationConfiguration
Sourcepub fn builder() -> KnowledgeBaseOrchestrationConfigurationBuilder
pub fn builder() -> KnowledgeBaseOrchestrationConfigurationBuilder
Creates a new builder-style object to manufacture KnowledgeBaseOrchestrationConfiguration
.
Trait Implementations§
Source§impl Clone for KnowledgeBaseOrchestrationConfiguration
impl Clone for KnowledgeBaseOrchestrationConfiguration
Source§fn clone(&self) -> KnowledgeBaseOrchestrationConfiguration
fn clone(&self) -> KnowledgeBaseOrchestrationConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for KnowledgeBaseOrchestrationConfiguration
impl PartialEq for KnowledgeBaseOrchestrationConfiguration
Source§fn eq(&self, other: &KnowledgeBaseOrchestrationConfiguration) -> bool
fn eq(&self, other: &KnowledgeBaseOrchestrationConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for KnowledgeBaseOrchestrationConfiguration
Auto Trait Implementations§
impl Freeze for KnowledgeBaseOrchestrationConfiguration
impl RefUnwindSafe for KnowledgeBaseOrchestrationConfiguration
impl Send for KnowledgeBaseOrchestrationConfiguration
impl Sync for KnowledgeBaseOrchestrationConfiguration
impl Unpin for KnowledgeBaseOrchestrationConfiguration
impl UnwindSafe for KnowledgeBaseOrchestrationConfiguration
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
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>
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);