#[non_exhaustive]pub struct PromptConfigurationBuilder { /* private fields */ }
Expand description
A builder for PromptConfiguration
.
Implementations§
Source§impl PromptConfigurationBuilder
impl PromptConfigurationBuilder
Sourcepub fn prompt_type(self, input: PromptType) -> Self
pub fn prompt_type(self, input: PromptType) -> Self
The step in the agent sequence that this prompt configuration applies to.
Sourcepub fn set_prompt_type(self, input: Option<PromptType>) -> Self
pub fn set_prompt_type(self, input: Option<PromptType>) -> Self
The step in the agent sequence that this prompt configuration applies to.
Sourcepub fn get_prompt_type(&self) -> &Option<PromptType>
pub fn get_prompt_type(&self) -> &Option<PromptType>
The step in the agent sequence that this prompt configuration applies to.
Sourcepub fn prompt_creation_mode(self, input: CreationMode) -> Self
pub fn prompt_creation_mode(self, input: CreationMode) -> Self
Specifies whether to override the default prompt template for this promptType
. Set this value to OVERRIDDEN
to use the prompt that you provide in the basePromptTemplate
. If you leave it as DEFAULT
, the agent uses a default prompt template.
Sourcepub fn set_prompt_creation_mode(self, input: Option<CreationMode>) -> Self
pub fn set_prompt_creation_mode(self, input: Option<CreationMode>) -> Self
Specifies whether to override the default prompt template for this promptType
. Set this value to OVERRIDDEN
to use the prompt that you provide in the basePromptTemplate
. If you leave it as DEFAULT
, the agent uses a default prompt template.
Sourcepub fn get_prompt_creation_mode(&self) -> &Option<CreationMode>
pub fn get_prompt_creation_mode(&self) -> &Option<CreationMode>
Specifies whether to override the default prompt template for this promptType
. Set this value to OVERRIDDEN
to use the prompt that you provide in the basePromptTemplate
. If you leave it as DEFAULT
, the agent uses a default prompt template.
Sourcepub fn prompt_state(self, input: PromptState) -> Self
pub fn prompt_state(self, input: PromptState) -> Self
Specifies whether to allow the inline agent to carry out the step specified in the promptType
. If you set this value to DISABLED
, the agent skips that step. The default state for each promptType
is as follows.
-
PRE_PROCESSING
–ENABLED
-
ORCHESTRATION
–ENABLED
-
KNOWLEDGE_BASE_RESPONSE_GENERATION
–ENABLED
-
POST_PROCESSING
–DISABLED
Sourcepub fn set_prompt_state(self, input: Option<PromptState>) -> Self
pub fn set_prompt_state(self, input: Option<PromptState>) -> Self
Specifies whether to allow the inline agent to carry out the step specified in the promptType
. If you set this value to DISABLED
, the agent skips that step. The default state for each promptType
is as follows.
-
PRE_PROCESSING
–ENABLED
-
ORCHESTRATION
–ENABLED
-
KNOWLEDGE_BASE_RESPONSE_GENERATION
–ENABLED
-
POST_PROCESSING
–DISABLED
Sourcepub fn get_prompt_state(&self) -> &Option<PromptState>
pub fn get_prompt_state(&self) -> &Option<PromptState>
Specifies whether to allow the inline agent to carry out the step specified in the promptType
. If you set this value to DISABLED
, the agent skips that step. The default state for each promptType
is as follows.
-
PRE_PROCESSING
–ENABLED
-
ORCHESTRATION
–ENABLED
-
KNOWLEDGE_BASE_RESPONSE_GENERATION
–ENABLED
-
POST_PROCESSING
–DISABLED
Sourcepub fn base_prompt_template(self, input: impl Into<String>) -> Self
pub fn base_prompt_template(self, input: impl Into<String>) -> Self
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
Sourcepub fn set_base_prompt_template(self, input: Option<String>) -> Self
pub fn set_base_prompt_template(self, input: Option<String>) -> Self
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
Sourcepub fn get_base_prompt_template(&self) -> &Option<String>
pub fn get_base_prompt_template(&self) -> &Option<String>
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
Sourcepub fn inference_configuration(self, input: InferenceConfiguration) -> Self
pub fn inference_configuration(self, input: InferenceConfiguration) -> Self
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
Sourcepub fn set_inference_configuration(
self,
input: Option<InferenceConfiguration>,
) -> Self
pub fn set_inference_configuration( self, input: Option<InferenceConfiguration>, ) -> Self
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
Sourcepub fn get_inference_configuration(&self) -> &Option<InferenceConfiguration>
pub fn get_inference_configuration(&self) -> &Option<InferenceConfiguration>
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
Sourcepub fn parser_mode(self, input: CreationMode) -> Self
pub fn parser_mode(self, input: CreationMode) -> Self
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType
. If you set the field as OVERRIDDEN
, the overrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Sourcepub fn set_parser_mode(self, input: Option<CreationMode>) -> Self
pub fn set_parser_mode(self, input: Option<CreationMode>) -> Self
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType
. If you set the field as OVERRIDDEN
, the overrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Sourcepub fn get_parser_mode(&self) -> &Option<CreationMode>
pub fn get_parser_mode(&self) -> &Option<CreationMode>
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType
. If you set the field as OVERRIDDEN
, the overrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Sourcepub fn foundation_model(self, input: impl Into<String>) -> Self
pub fn foundation_model(self, input: impl Into<String>) -> Self
The foundation model to use.
Sourcepub fn set_foundation_model(self, input: Option<String>) -> Self
pub fn set_foundation_model(self, input: Option<String>) -> Self
The foundation model to use.
Sourcepub fn get_foundation_model(&self) -> &Option<String>
pub fn get_foundation_model(&self) -> &Option<String>
The foundation model to use.
Sourcepub fn additional_model_request_fields(self, input: Document) -> Self
pub fn additional_model_request_fields(self, input: Document) -> Self
If the Converse or ConverseStream operations support the model, additionalModelRequestFields
contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration
field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
Sourcepub fn set_additional_model_request_fields(
self,
input: Option<Document>,
) -> Self
pub fn set_additional_model_request_fields( self, input: Option<Document>, ) -> Self
If the Converse or ConverseStream operations support the model, additionalModelRequestFields
contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration
field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
Sourcepub fn get_additional_model_request_fields(&self) -> &Option<Document>
pub fn get_additional_model_request_fields(&self) -> &Option<Document>
If the Converse or ConverseStream operations support the model, additionalModelRequestFields
contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration
field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
Sourcepub fn build(self) -> PromptConfiguration
pub fn build(self) -> PromptConfiguration
Consumes the builder and constructs a PromptConfiguration
.
Trait Implementations§
Source§impl Clone for PromptConfigurationBuilder
impl Clone for PromptConfigurationBuilder
Source§fn clone(&self) -> PromptConfigurationBuilder
fn clone(&self) -> PromptConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PromptConfigurationBuilder
impl Debug for PromptConfigurationBuilder
Source§impl Default for PromptConfigurationBuilder
impl Default for PromptConfigurationBuilder
Source§fn default() -> PromptConfigurationBuilder
fn default() -> PromptConfigurationBuilder
impl StructuralPartialEq for PromptConfigurationBuilder
Auto Trait Implementations§
impl Freeze for PromptConfigurationBuilder
impl RefUnwindSafe for PromptConfigurationBuilder
impl Send for PromptConfigurationBuilder
impl Sync for PromptConfigurationBuilder
impl Unpin for PromptConfigurationBuilder
impl UnwindSafe for PromptConfigurationBuilder
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);