#[non_exhaustive]pub struct ChatSyncInput {Show 13 fields
pub application_id: Option<String>,
pub user_id: Option<String>,
pub user_groups: Option<Vec<String>>,
pub user_message: Option<String>,
pub attachments: Option<Vec<AttachmentInput>>,
pub action_execution: Option<ActionExecution>,
pub auth_challenge_response: Option<AuthChallengeResponse>,
pub conversation_id: Option<String>,
pub parent_message_id: Option<String>,
pub attribute_filter: Option<AttributeFilter>,
pub chat_mode: Option<ChatMode>,
pub chat_mode_configuration: Option<ChatModeConfiguration>,
pub client_token: Option<String>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.application_id: Option<String>The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
user_id: Option<String>The identifier of the user attached to the chat input.
user_groups: Option<Vec<String>>The group names that a user associated with the chat input belongs to.
user_message: Option<String>A end user message in a conversation.
attachments: Option<Vec<AttachmentInput>>A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
action_execution: Option<ActionExecution>A request from an end user to perform an Amazon Q Business plugin action.
auth_challenge_response: Option<AuthChallengeResponse>An authentication verification event response by a third party authentication server to Amazon Q Business.
conversation_id: Option<String>The identifier of the Amazon Q Business conversation.
parent_message_id: Option<String>The identifier of the previous system message in a conversation.
attribute_filter: Option<AttributeFilter>Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
chat_mode: Option<ChatMode>The chatMode parameter determines the chat modes available to Amazon Q Business users:
-
RETRIEVAL_MODE- If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge -
CREATOR_MODE- By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge. -
PLUGIN_MODE- By selecting this mode, users can choose to use plugins in chat to get their responses.
If none of the modes are selected, Amazon Q will only respond using the information from the attached files.
For more information, see Admin controls and guardrails, Plugins, and Response sources.
chat_mode_configuration: Option<ChatModeConfiguration>The chat mode configuration for an Amazon Q Business application.
client_token: Option<String>A token that you provide to identify a chat request.
Implementations§
Source§impl ChatSyncInput
impl ChatSyncInput
Sourcepub fn application_id(&self) -> Option<&str>
pub fn application_id(&self) -> Option<&str>
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
Sourcepub fn user_groups(&self) -> &[String]
pub fn user_groups(&self) -> &[String]
The group names that a user associated with the chat input belongs to.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_groups.is_none().
Sourcepub fn user_message(&self) -> Option<&str>
pub fn user_message(&self) -> Option<&str>
A end user message in a conversation.
Sourcepub fn attachments(&self) -> &[AttachmentInput]
pub fn attachments(&self) -> &[AttachmentInput]
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments.is_none().
Sourcepub fn action_execution(&self) -> Option<&ActionExecution>
pub fn action_execution(&self) -> Option<&ActionExecution>
A request from an end user to perform an Amazon Q Business plugin action.
Sourcepub fn auth_challenge_response(&self) -> Option<&AuthChallengeResponse>
pub fn auth_challenge_response(&self) -> Option<&AuthChallengeResponse>
An authentication verification event response by a third party authentication server to Amazon Q Business.
Sourcepub fn conversation_id(&self) -> Option<&str>
pub fn conversation_id(&self) -> Option<&str>
The identifier of the Amazon Q Business conversation.
Sourcepub fn parent_message_id(&self) -> Option<&str>
pub fn parent_message_id(&self) -> Option<&str>
The identifier of the previous system message in a conversation.
Sourcepub fn attribute_filter(&self) -> Option<&AttributeFilter>
pub fn attribute_filter(&self) -> Option<&AttributeFilter>
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
Sourcepub fn chat_mode(&self) -> Option<&ChatMode>
pub fn chat_mode(&self) -> Option<&ChatMode>
The chatMode parameter determines the chat modes available to Amazon Q Business users:
-
RETRIEVAL_MODE- If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge -
CREATOR_MODE- By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge. -
PLUGIN_MODE- By selecting this mode, users can choose to use plugins in chat to get their responses.
If none of the modes are selected, Amazon Q will only respond using the information from the attached files.
For more information, see Admin controls and guardrails, Plugins, and Response sources.
Sourcepub fn chat_mode_configuration(&self) -> Option<&ChatModeConfiguration>
pub fn chat_mode_configuration(&self) -> Option<&ChatModeConfiguration>
The chat mode configuration for an Amazon Q Business application.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
A token that you provide to identify a chat request.
Source§impl ChatSyncInput
impl ChatSyncInput
Sourcepub fn builder() -> ChatSyncInputBuilder
pub fn builder() -> ChatSyncInputBuilder
Creates a new builder-style object to manufacture ChatSyncInput.
Trait Implementations§
Source§impl Clone for ChatSyncInput
impl Clone for ChatSyncInput
Source§fn clone(&self) -> ChatSyncInput
fn clone(&self) -> ChatSyncInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ChatSyncInput
impl Debug for ChatSyncInput
Source§impl PartialEq for ChatSyncInput
impl PartialEq for ChatSyncInput
impl StructuralPartialEq for ChatSyncInput
Auto Trait Implementations§
impl Freeze for ChatSyncInput
impl RefUnwindSafe for ChatSyncInput
impl Send for ChatSyncInput
impl Sync for ChatSyncInput
impl Unpin for ChatSyncInput
impl UnwindSafe for ChatSyncInput
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);