pub struct RetrieveAndGenerateStreamFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to RetrieveAndGenerateStream.
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
Implementations§
Source§impl RetrieveAndGenerateStreamFluentBuilder
impl RetrieveAndGenerateStreamFluentBuilder
Sourcepub fn as_input(&self) -> &RetrieveAndGenerateStreamInputBuilder
pub fn as_input(&self) -> &RetrieveAndGenerateStreamInputBuilder
Access the RetrieveAndGenerateStream as a reference.
Sourcepub async fn send(
self,
) -> Result<RetrieveAndGenerateStreamOutput, SdkError<RetrieveAndGenerateStreamError, HttpResponse>>
pub async fn send( self, ) -> Result<RetrieveAndGenerateStreamOutput, SdkError<RetrieveAndGenerateStreamError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<RetrieveAndGenerateStreamOutput, RetrieveAndGenerateStreamError, Self>
pub fn customize( self, ) -> CustomizableOperation<RetrieveAndGenerateStreamOutput, RetrieveAndGenerateStreamError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Sourcepub fn input(self, input: RetrieveAndGenerateInput) -> Self
pub fn input(self, input: RetrieveAndGenerateInput) -> Self
Contains the query to be made to the knowledge base.
Sourcepub fn set_input(self, input: Option<RetrieveAndGenerateInput>) -> Self
pub fn set_input(self, input: Option<RetrieveAndGenerateInput>) -> Self
Contains the query to be made to the knowledge base.
Sourcepub fn get_input(&self) -> &Option<RetrieveAndGenerateInput>
pub fn get_input(&self) -> &Option<RetrieveAndGenerateInput>
Contains the query to be made to the knowledge base.
Sourcepub fn retrieve_and_generate_configuration(
self,
input: RetrieveAndGenerateConfiguration,
) -> Self
pub fn retrieve_and_generate_configuration( self, input: RetrieveAndGenerateConfiguration, ) -> Self
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
Sourcepub fn set_retrieve_and_generate_configuration(
self,
input: Option<RetrieveAndGenerateConfiguration>,
) -> Self
pub fn set_retrieve_and_generate_configuration( self, input: Option<RetrieveAndGenerateConfiguration>, ) -> Self
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
Sourcepub fn get_retrieve_and_generate_configuration(
&self,
) -> &Option<RetrieveAndGenerateConfiguration>
pub fn get_retrieve_and_generate_configuration( &self, ) -> &Option<RetrieveAndGenerateConfiguration>
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
Sourcepub fn session_configuration(
self,
input: RetrieveAndGenerateSessionConfiguration,
) -> Self
pub fn session_configuration( self, input: RetrieveAndGenerateSessionConfiguration, ) -> Self
Contains details about the session with the knowledge base.
Sourcepub fn set_session_configuration(
self,
input: Option<RetrieveAndGenerateSessionConfiguration>,
) -> Self
pub fn set_session_configuration( self, input: Option<RetrieveAndGenerateSessionConfiguration>, ) -> Self
Contains details about the session with the knowledge base.
Sourcepub fn get_session_configuration(
&self,
) -> &Option<RetrieveAndGenerateSessionConfiguration>
pub fn get_session_configuration( &self, ) -> &Option<RetrieveAndGenerateSessionConfiguration>
Contains details about the session with the knowledge base.
Trait Implementations§
Source§impl Clone for RetrieveAndGenerateStreamFluentBuilder
impl Clone for RetrieveAndGenerateStreamFluentBuilder
Source§fn clone(&self) -> RetrieveAndGenerateStreamFluentBuilder
fn clone(&self) -> RetrieveAndGenerateStreamFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for RetrieveAndGenerateStreamFluentBuilder
impl !RefUnwindSafe for RetrieveAndGenerateStreamFluentBuilder
impl Send for RetrieveAndGenerateStreamFluentBuilder
impl Sync for RetrieveAndGenerateStreamFluentBuilder
impl Unpin for RetrieveAndGenerateStreamFluentBuilder
impl !UnwindSafe for RetrieveAndGenerateStreamFluentBuilder
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);