#[non_exhaustive]pub struct ChatSyncOutputBuilder { /* private fields */ }Expand description
A builder for ChatSyncOutput.
Implementations§
Source§impl ChatSyncOutputBuilder
impl ChatSyncOutputBuilder
Sourcepub fn conversation_id(self, input: impl Into<String>) -> Self
pub fn conversation_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q Business conversation.
Sourcepub fn set_conversation_id(self, input: Option<String>) -> Self
pub fn set_conversation_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q Business conversation.
Sourcepub fn get_conversation_id(&self) -> &Option<String>
pub fn get_conversation_id(&self) -> &Option<String>
The identifier of the Amazon Q Business conversation.
Sourcepub fn system_message(self, input: impl Into<String>) -> Self
pub fn system_message(self, input: impl Into<String>) -> Self
An AI-generated message in a conversation.
Sourcepub fn set_system_message(self, input: Option<String>) -> Self
pub fn set_system_message(self, input: Option<String>) -> Self
An AI-generated message in a conversation.
Sourcepub fn get_system_message(&self) -> &Option<String>
pub fn get_system_message(&self) -> &Option<String>
An AI-generated message in a conversation.
Sourcepub fn system_message_id(self, input: impl Into<String>) -> Self
pub fn system_message_id(self, input: impl Into<String>) -> Self
The identifier of an Amazon Q Business AI generated message within the conversation.
Sourcepub fn set_system_message_id(self, input: Option<String>) -> Self
pub fn set_system_message_id(self, input: Option<String>) -> Self
The identifier of an Amazon Q Business AI generated message within the conversation.
Sourcepub fn get_system_message_id(&self) -> &Option<String>
pub fn get_system_message_id(&self) -> &Option<String>
The identifier of an Amazon Q Business AI generated message within the conversation.
Sourcepub fn user_message_id(self, input: impl Into<String>) -> Self
pub fn user_message_id(self, input: impl Into<String>) -> Self
The identifier of an Amazon Q Business end user text input message within the conversation.
Sourcepub fn set_user_message_id(self, input: Option<String>) -> Self
pub fn set_user_message_id(self, input: Option<String>) -> Self
The identifier of an Amazon Q Business end user text input message within the conversation.
Sourcepub fn get_user_message_id(&self) -> &Option<String>
pub fn get_user_message_id(&self) -> &Option<String>
The identifier of an Amazon Q Business end user text input message within the conversation.
Sourcepub fn action_review(self, input: ActionReview) -> Self
pub fn action_review(self, input: ActionReview) -> Self
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
Sourcepub fn set_action_review(self, input: Option<ActionReview>) -> Self
pub fn set_action_review(self, input: Option<ActionReview>) -> Self
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
Sourcepub fn get_action_review(&self) -> &Option<ActionReview>
pub fn get_action_review(&self) -> &Option<ActionReview>
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
Sourcepub fn auth_challenge_request(self, input: AuthChallengeRequest) -> Self
pub fn auth_challenge_request(self, input: AuthChallengeRequest) -> Self
An authentication verification event activated by an end user request to use a custom plugin.
Sourcepub fn set_auth_challenge_request(
self,
input: Option<AuthChallengeRequest>,
) -> Self
pub fn set_auth_challenge_request( self, input: Option<AuthChallengeRequest>, ) -> Self
An authentication verification event activated by an end user request to use a custom plugin.
Sourcepub fn get_auth_challenge_request(&self) -> &Option<AuthChallengeRequest>
pub fn get_auth_challenge_request(&self) -> &Option<AuthChallengeRequest>
An authentication verification event activated by an end user request to use a custom plugin.
Sourcepub fn source_attributions(self, input: Option<SourceAttribution>) -> Self
pub fn source_attributions(self, input: Option<SourceAttribution>) -> Self
Appends an item to source_attributions.
To override the contents of this collection use set_source_attributions.
The source documents used to generate the conversation response.
Sourcepub fn set_source_attributions(
self,
input: Option<Vec<Option<SourceAttribution>>>,
) -> Self
pub fn set_source_attributions( self, input: Option<Vec<Option<SourceAttribution>>>, ) -> Self
The source documents used to generate the conversation response.
Sourcepub fn get_source_attributions(&self) -> &Option<Vec<Option<SourceAttribution>>>
pub fn get_source_attributions(&self) -> &Option<Vec<Option<SourceAttribution>>>
The source documents used to generate the conversation response.
Sourcepub fn failed_attachments(self, input: AttachmentOutput) -> Self
pub fn failed_attachments(self, input: AttachmentOutput) -> Self
Appends an item to failed_attachments.
To override the contents of this collection use set_failed_attachments.
A list of files which failed to upload during chat.
Sourcepub fn set_failed_attachments(
self,
input: Option<Vec<AttachmentOutput>>,
) -> Self
pub fn set_failed_attachments( self, input: Option<Vec<AttachmentOutput>>, ) -> Self
A list of files which failed to upload during chat.
Sourcepub fn get_failed_attachments(&self) -> &Option<Vec<AttachmentOutput>>
pub fn get_failed_attachments(&self) -> &Option<Vec<AttachmentOutput>>
A list of files which failed to upload during chat.
Sourcepub fn build(self) -> ChatSyncOutput
pub fn build(self) -> ChatSyncOutput
Consumes the builder and constructs a ChatSyncOutput.
Trait Implementations§
Source§impl Clone for ChatSyncOutputBuilder
impl Clone for ChatSyncOutputBuilder
Source§fn clone(&self) -> ChatSyncOutputBuilder
fn clone(&self) -> ChatSyncOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ChatSyncOutputBuilder
impl Debug for ChatSyncOutputBuilder
Source§impl Default for ChatSyncOutputBuilder
impl Default for ChatSyncOutputBuilder
Source§fn default() -> ChatSyncOutputBuilder
fn default() -> ChatSyncOutputBuilder
Source§impl PartialEq for ChatSyncOutputBuilder
impl PartialEq for ChatSyncOutputBuilder
impl StructuralPartialEq for ChatSyncOutputBuilder
Auto Trait Implementations§
impl Freeze for ChatSyncOutputBuilder
impl RefUnwindSafe for ChatSyncOutputBuilder
impl Send for ChatSyncOutputBuilder
impl Sync for ChatSyncOutputBuilder
impl Unpin for ChatSyncOutputBuilder
impl UnwindSafe for ChatSyncOutputBuilder
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);