#[non_exhaustive]pub struct KnowledgeBaseFlowNodeConfigurationBuilder { /* private fields */ }
Expand description
A builder for KnowledgeBaseFlowNodeConfiguration
.
Implementations§
Source§impl KnowledgeBaseFlowNodeConfigurationBuilder
impl KnowledgeBaseFlowNodeConfigurationBuilder
Sourcepub fn knowledge_base_id(self, input: impl Into<String>) -> Self
pub fn knowledge_base_id(self, input: impl Into<String>) -> Self
The unique identifier of the knowledge base to query.
This field is required.Sourcepub fn set_knowledge_base_id(self, input: Option<String>) -> Self
pub fn set_knowledge_base_id(self, input: Option<String>) -> Self
The unique identifier of the knowledge base to query.
Sourcepub fn get_knowledge_base_id(&self) -> &Option<String>
pub fn get_knowledge_base_id(&self) -> &Option<String>
The unique identifier of the knowledge base to query.
Sourcepub fn model_id(self, input: impl Into<String>) -> Self
pub fn model_id(self, input: impl Into<String>) -> Self
The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
Sourcepub fn set_model_id(self, input: Option<String>) -> Self
pub fn set_model_id(self, input: Option<String>) -> Self
The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
Sourcepub fn get_model_id(&self) -> &Option<String>
pub fn get_model_id(&self) -> &Option<String>
The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
Sourcepub fn guardrail_configuration(self, input: GuardrailConfiguration) -> Self
pub fn guardrail_configuration(self, input: GuardrailConfiguration) -> Self
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Sourcepub fn set_guardrail_configuration(
self,
input: Option<GuardrailConfiguration>,
) -> Self
pub fn set_guardrail_configuration( self, input: Option<GuardrailConfiguration>, ) -> Self
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Sourcepub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>
pub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Sourcepub fn number_of_results(self, input: i32) -> Self
pub fn number_of_results(self, input: i32) -> Self
The number of results to retrieve from the knowledge base.
Sourcepub fn set_number_of_results(self, input: Option<i32>) -> Self
pub fn set_number_of_results(self, input: Option<i32>) -> Self
The number of results to retrieve from the knowledge base.
Sourcepub fn get_number_of_results(&self) -> &Option<i32>
pub fn get_number_of_results(&self) -> &Option<i32>
The number of results to retrieve from the knowledge base.
Sourcepub fn prompt_template(self, input: KnowledgeBasePromptTemplate) -> Self
pub fn prompt_template(self, input: KnowledgeBasePromptTemplate) -> Self
A custom prompt template to use with the knowledge base for generating responses.
Sourcepub fn set_prompt_template(
self,
input: Option<KnowledgeBasePromptTemplate>,
) -> Self
pub fn set_prompt_template( self, input: Option<KnowledgeBasePromptTemplate>, ) -> Self
A custom prompt template to use with the knowledge base for generating responses.
Sourcepub fn get_prompt_template(&self) -> &Option<KnowledgeBasePromptTemplate>
pub fn get_prompt_template(&self) -> &Option<KnowledgeBasePromptTemplate>
A custom prompt template to use with the knowledge base for generating responses.
Sourcepub fn inference_configuration(
self,
input: PromptInferenceConfiguration,
) -> Self
pub fn inference_configuration( self, input: PromptInferenceConfiguration, ) -> Self
Contains inference configurations for the prompt.
Sourcepub fn set_inference_configuration(
self,
input: Option<PromptInferenceConfiguration>,
) -> Self
pub fn set_inference_configuration( self, input: Option<PromptInferenceConfiguration>, ) -> Self
Contains inference configurations for the prompt.
Sourcepub fn get_inference_configuration(
&self,
) -> &Option<PromptInferenceConfiguration>
pub fn get_inference_configuration( &self, ) -> &Option<PromptInferenceConfiguration>
Contains inference configurations for the prompt.
Sourcepub fn reranking_configuration(
self,
input: VectorSearchRerankingConfiguration,
) -> Self
pub fn reranking_configuration( self, input: VectorSearchRerankingConfiguration, ) -> Self
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Sourcepub fn set_reranking_configuration(
self,
input: Option<VectorSearchRerankingConfiguration>,
) -> Self
pub fn set_reranking_configuration( self, input: Option<VectorSearchRerankingConfiguration>, ) -> Self
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Sourcepub fn get_reranking_configuration(
&self,
) -> &Option<VectorSearchRerankingConfiguration>
pub fn get_reranking_configuration( &self, ) -> &Option<VectorSearchRerankingConfiguration>
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Sourcepub fn orchestration_configuration(
self,
input: KnowledgeBaseOrchestrationConfiguration,
) -> Self
pub fn orchestration_configuration( self, input: KnowledgeBaseOrchestrationConfiguration, ) -> Self
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Sourcepub fn set_orchestration_configuration(
self,
input: Option<KnowledgeBaseOrchestrationConfiguration>,
) -> Self
pub fn set_orchestration_configuration( self, input: Option<KnowledgeBaseOrchestrationConfiguration>, ) -> Self
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Sourcepub fn get_orchestration_configuration(
&self,
) -> &Option<KnowledgeBaseOrchestrationConfiguration>
pub fn get_orchestration_configuration( &self, ) -> &Option<KnowledgeBaseOrchestrationConfiguration>
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Sourcepub fn build(self) -> KnowledgeBaseFlowNodeConfiguration
pub fn build(self) -> KnowledgeBaseFlowNodeConfiguration
Consumes the builder and constructs a KnowledgeBaseFlowNodeConfiguration
.
Trait Implementations§
Source§impl Clone for KnowledgeBaseFlowNodeConfigurationBuilder
impl Clone for KnowledgeBaseFlowNodeConfigurationBuilder
Source§fn clone(&self) -> KnowledgeBaseFlowNodeConfigurationBuilder
fn clone(&self) -> KnowledgeBaseFlowNodeConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for KnowledgeBaseFlowNodeConfigurationBuilder
impl Default for KnowledgeBaseFlowNodeConfigurationBuilder
Source§fn default() -> KnowledgeBaseFlowNodeConfigurationBuilder
fn default() -> KnowledgeBaseFlowNodeConfigurationBuilder
Source§impl PartialEq for KnowledgeBaseFlowNodeConfigurationBuilder
impl PartialEq for KnowledgeBaseFlowNodeConfigurationBuilder
Source§fn eq(&self, other: &KnowledgeBaseFlowNodeConfigurationBuilder) -> bool
fn eq(&self, other: &KnowledgeBaseFlowNodeConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for KnowledgeBaseFlowNodeConfigurationBuilder
Auto Trait Implementations§
impl Freeze for KnowledgeBaseFlowNodeConfigurationBuilder
impl RefUnwindSafe for KnowledgeBaseFlowNodeConfigurationBuilder
impl Send for KnowledgeBaseFlowNodeConfigurationBuilder
impl Sync for KnowledgeBaseFlowNodeConfigurationBuilder
impl Unpin for KnowledgeBaseFlowNodeConfigurationBuilder
impl UnwindSafe for KnowledgeBaseFlowNodeConfigurationBuilder
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);