#[non_exhaustive]pub struct ConverseInputBuilder { /* private fields */ }
Expand description
A builder for ConverseInput
.
Implementations§
Source§impl ConverseInputBuilder
impl ConverseInputBuilder
Sourcepub fn model_id(self, input: impl Into<String>) -> Self
pub fn model_id(self, input: impl Into<String>) -> Self
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.
The Converse API doesn't support imported models.
This field is required.Sourcepub fn set_model_id(self, input: Option<String>) -> Self
pub fn set_model_id(self, input: Option<String>) -> Self
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.
The Converse API doesn't support imported models.
Sourcepub fn get_model_id(&self) -> &Option<String>
pub fn get_model_id(&self) -> &Option<String>
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.
The Converse API doesn't support imported models.
Sourcepub fn messages(self, input: Message) -> Self
pub fn messages(self, input: Message) -> Self
Appends an item to messages
.
To override the contents of this collection use set_messages
.
The messages that you want to send to the model.
Sourcepub fn set_messages(self, input: Option<Vec<Message>>) -> Self
pub fn set_messages(self, input: Option<Vec<Message>>) -> Self
The messages that you want to send to the model.
Sourcepub fn get_messages(&self) -> &Option<Vec<Message>>
pub fn get_messages(&self) -> &Option<Vec<Message>>
The messages that you want to send to the model.
Sourcepub fn system(self, input: SystemContentBlock) -> Self
pub fn system(self, input: SystemContentBlock) -> Self
Appends an item to system
.
To override the contents of this collection use set_system
.
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
Sourcepub fn set_system(self, input: Option<Vec<SystemContentBlock>>) -> Self
pub fn set_system(self, input: Option<Vec<SystemContentBlock>>) -> Self
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
Sourcepub fn get_system(&self) -> &Option<Vec<SystemContentBlock>>
pub fn get_system(&self) -> &Option<Vec<SystemContentBlock>>
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
Sourcepub fn inference_config(self, input: InferenceConfiguration) -> Self
pub fn inference_config(self, input: InferenceConfiguration) -> Self
Inference parameters to pass to the model. Converse
and ConverseStream
support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields
request field.
Sourcepub fn set_inference_config(self, input: Option<InferenceConfiguration>) -> Self
pub fn set_inference_config(self, input: Option<InferenceConfiguration>) -> Self
Inference parameters to pass to the model. Converse
and ConverseStream
support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields
request field.
Sourcepub fn get_inference_config(&self) -> &Option<InferenceConfiguration>
pub fn get_inference_config(&self) -> &Option<InferenceConfiguration>
Inference parameters to pass to the model. Converse
and ConverseStream
support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields
request field.
Sourcepub fn tool_config(self, input: ToolConfiguration) -> Self
pub fn tool_config(self, input: ToolConfiguration) -> Self
Configuration information for the tools that the model can use when generating a response.
For information about models that support tool use, see Supported models and model features.
Sourcepub fn set_tool_config(self, input: Option<ToolConfiguration>) -> Self
pub fn set_tool_config(self, input: Option<ToolConfiguration>) -> Self
Configuration information for the tools that the model can use when generating a response.
For information about models that support tool use, see Supported models and model features.
Sourcepub fn get_tool_config(&self) -> &Option<ToolConfiguration>
pub fn get_tool_config(&self) -> &Option<ToolConfiguration>
Configuration information for the tools that the model can use when generating a response.
For information about models that support tool use, see Supported models and model features.
Sourcepub fn guardrail_config(self, input: GuardrailConfiguration) -> Self
pub fn guardrail_config(self, input: GuardrailConfiguration) -> Self
Configuration information for a guardrail that you want to use in the request. If you include guardContent
blocks in the content
field in the messages
field, the guardrail operates only on those messages. If you include no guardContent
blocks, the guardrail operates on all messages in the request body and in any included prompt resource.
Sourcepub fn set_guardrail_config(self, input: Option<GuardrailConfiguration>) -> Self
pub fn set_guardrail_config(self, input: Option<GuardrailConfiguration>) -> Self
Configuration information for a guardrail that you want to use in the request. If you include guardContent
blocks in the content
field in the messages
field, the guardrail operates only on those messages. If you include no guardContent
blocks, the guardrail operates on all messages in the request body and in any included prompt resource.
Sourcepub fn get_guardrail_config(&self) -> &Option<GuardrailConfiguration>
pub fn get_guardrail_config(&self) -> &Option<GuardrailConfiguration>
Configuration information for a guardrail that you want to use in the request. If you include guardContent
blocks in the content
field in the messages
field, the guardrail operates only on those messages. If you include no guardContent
blocks, the guardrail operates on all messages in the request body and in any included prompt resource.
Sourcepub fn additional_model_request_fields(self, input: Document) -> Self
pub fn additional_model_request_fields(self, input: Document) -> Self
Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse
and ConverseStream
support in the inferenceConfig
field. For more information, see Model parameters.
Sourcepub fn set_additional_model_request_fields(
self,
input: Option<Document>,
) -> Self
pub fn set_additional_model_request_fields( self, input: Option<Document>, ) -> Self
Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse
and ConverseStream
support in the inferenceConfig
field. For more information, see Model parameters.
Sourcepub fn get_additional_model_request_fields(&self) -> &Option<Document>
pub fn get_additional_model_request_fields(&self) -> &Option<Document>
Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse
and ConverseStream
support in the inferenceConfig
field. For more information, see Model parameters.
Sourcepub fn prompt_variables(
self,
k: impl Into<String>,
v: PromptVariableValues,
) -> Self
pub fn prompt_variables( self, k: impl Into<String>, v: PromptVariableValues, ) -> Self
Adds a key-value pair to prompt_variables
.
To override the contents of this collection use set_prompt_variables
.
Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId
field.
Sourcepub fn set_prompt_variables(
self,
input: Option<HashMap<String, PromptVariableValues>>,
) -> Self
pub fn set_prompt_variables( self, input: Option<HashMap<String, PromptVariableValues>>, ) -> Self
Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId
field.
Sourcepub fn get_prompt_variables(
&self,
) -> &Option<HashMap<String, PromptVariableValues>>
pub fn get_prompt_variables( &self, ) -> &Option<HashMap<String, PromptVariableValues>>
Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId
field.
Sourcepub fn additional_model_response_field_paths(
self,
input: impl Into<String>,
) -> Self
pub fn additional_model_response_field_paths( self, input: impl Into<String>, ) -> Self
Appends an item to additional_model_response_field_paths
.
To override the contents of this collection use set_additional_model_response_field_paths
.
Additional model parameters field paths to return in the response. Converse
and ConverseStream
return the requested fields as a JSON Pointer object in the additionalModelResponseFields
field. The following is example JSON for additionalModelResponseFieldPaths
.
\[ "/stop_sequence" \]
For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.
Converse
and ConverseStream
reject an empty JSON Pointer or incorrectly structured JSON Pointer with a 400
error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse
.
Sourcepub fn set_additional_model_response_field_paths(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_additional_model_response_field_paths( self, input: Option<Vec<String>>, ) -> Self
Additional model parameters field paths to return in the response. Converse
and ConverseStream
return the requested fields as a JSON Pointer object in the additionalModelResponseFields
field. The following is example JSON for additionalModelResponseFieldPaths
.
\[ "/stop_sequence" \]
For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.
Converse
and ConverseStream
reject an empty JSON Pointer or incorrectly structured JSON Pointer with a 400
error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse
.
Sourcepub fn get_additional_model_response_field_paths(&self) -> &Option<Vec<String>>
pub fn get_additional_model_response_field_paths(&self) -> &Option<Vec<String>>
Additional model parameters field paths to return in the response. Converse
and ConverseStream
return the requested fields as a JSON Pointer object in the additionalModelResponseFields
field. The following is example JSON for additionalModelResponseFieldPaths
.
\[ "/stop_sequence" \]
For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.
Converse
and ConverseStream
reject an empty JSON Pointer or incorrectly structured JSON Pointer with a 400
error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse
.
Sourcepub fn request_metadata(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn request_metadata( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to request_metadata
.
To override the contents of this collection use set_request_metadata
.
Key-value pairs that you can use to filter invocation logs.
Sourcepub fn set_request_metadata(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_request_metadata( self, input: Option<HashMap<String, String>>, ) -> Self
Key-value pairs that you can use to filter invocation logs.
Sourcepub fn get_request_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_request_metadata(&self) -> &Option<HashMap<String, String>>
Key-value pairs that you can use to filter invocation logs.
Sourcepub fn performance_config(self, input: PerformanceConfiguration) -> Self
pub fn performance_config(self, input: PerformanceConfiguration) -> Self
Model performance settings for the request.
Sourcepub fn set_performance_config(
self,
input: Option<PerformanceConfiguration>,
) -> Self
pub fn set_performance_config( self, input: Option<PerformanceConfiguration>, ) -> Self
Model performance settings for the request.
Sourcepub fn get_performance_config(&self) -> &Option<PerformanceConfiguration>
pub fn get_performance_config(&self) -> &Option<PerformanceConfiguration>
Model performance settings for the request.
Sourcepub fn build(self) -> Result<ConverseInput, BuildError>
pub fn build(self) -> Result<ConverseInput, BuildError>
Consumes the builder and constructs a ConverseInput
.
Source§impl ConverseInputBuilder
impl ConverseInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ConverseOutput, SdkError<ConverseError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ConverseOutput, SdkError<ConverseError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ConverseInputBuilder
impl Clone for ConverseInputBuilder
Source§fn clone(&self) -> ConverseInputBuilder
fn clone(&self) -> ConverseInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ConverseInputBuilder
impl Debug for ConverseInputBuilder
Source§impl Default for ConverseInputBuilder
impl Default for ConverseInputBuilder
Source§fn default() -> ConverseInputBuilder
fn default() -> ConverseInputBuilder
Source§impl PartialEq for ConverseInputBuilder
impl PartialEq for ConverseInputBuilder
impl StructuralPartialEq for ConverseInputBuilder
Auto Trait Implementations§
impl Freeze for ConverseInputBuilder
impl RefUnwindSafe for ConverseInputBuilder
impl Send for ConverseInputBuilder
impl Sync for ConverseInputBuilder
impl Unpin for ConverseInputBuilder
impl UnwindSafe for ConverseInputBuilder
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);