#[non_exhaustive]pub struct GetChatControlsConfigurationOutput {
pub response_scope: Option<ResponseScope>,
pub orchestration_configuration: Option<AppliedOrchestrationConfiguration>,
pub blocked_phrases: Option<BlockedPhrasesConfiguration>,
pub topic_configurations: Option<Vec<TopicConfiguration>>,
pub creator_mode_configuration: Option<AppliedCreatorModeConfiguration>,
pub next_token: Option<String>,
pub hallucination_reduction_configuration: Option<HallucinationReductionConfiguration>,
/* private fields */
}
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.response_scope: Option<ResponseScope>
The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
orchestration_configuration: Option<AppliedOrchestrationConfiguration>
The chat response orchestration settings for your application.
Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.
blocked_phrases: Option<BlockedPhrasesConfiguration>
The phrases blocked from chat by your chat control configuration.
topic_configurations: Option<Vec<TopicConfiguration>>
The topic specific controls configured for a Amazon Q Business application.
creator_mode_configuration: Option<AppliedCreatorModeConfiguration>
The configuration details for CREATOR_MODE
.
next_token: Option<String>
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
hallucination_reduction_configuration: Option<HallucinationReductionConfiguration>
The hallucination reduction settings for your application.
Implementations§
Source§impl GetChatControlsConfigurationOutput
impl GetChatControlsConfigurationOutput
Sourcepub fn response_scope(&self) -> Option<&ResponseScope>
pub fn response_scope(&self) -> Option<&ResponseScope>
The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
Sourcepub fn orchestration_configuration(
&self,
) -> Option<&AppliedOrchestrationConfiguration>
pub fn orchestration_configuration( &self, ) -> Option<&AppliedOrchestrationConfiguration>
The chat response orchestration settings for your application.
Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.
Sourcepub fn blocked_phrases(&self) -> Option<&BlockedPhrasesConfiguration>
pub fn blocked_phrases(&self) -> Option<&BlockedPhrasesConfiguration>
The phrases blocked from chat by your chat control configuration.
Sourcepub fn topic_configurations(&self) -> &[TopicConfiguration]
pub fn topic_configurations(&self) -> &[TopicConfiguration]
The topic specific controls configured for a Amazon Q Business application.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .topic_configurations.is_none()
.
Sourcepub fn creator_mode_configuration(
&self,
) -> Option<&AppliedCreatorModeConfiguration>
pub fn creator_mode_configuration( &self, ) -> Option<&AppliedCreatorModeConfiguration>
The configuration details for CREATOR_MODE
.
Sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
Sourcepub fn hallucination_reduction_configuration(
&self,
) -> Option<&HallucinationReductionConfiguration>
pub fn hallucination_reduction_configuration( &self, ) -> Option<&HallucinationReductionConfiguration>
The hallucination reduction settings for your application.
Source§impl GetChatControlsConfigurationOutput
impl GetChatControlsConfigurationOutput
Sourcepub fn builder() -> GetChatControlsConfigurationOutputBuilder
pub fn builder() -> GetChatControlsConfigurationOutputBuilder
Creates a new builder-style object to manufacture GetChatControlsConfigurationOutput
.
Trait Implementations§
Source§impl Clone for GetChatControlsConfigurationOutput
impl Clone for GetChatControlsConfigurationOutput
Source§fn clone(&self) -> GetChatControlsConfigurationOutput
fn clone(&self) -> GetChatControlsConfigurationOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for GetChatControlsConfigurationOutput
impl PartialEq for GetChatControlsConfigurationOutput
Source§fn eq(&self, other: &GetChatControlsConfigurationOutput) -> bool
fn eq(&self, other: &GetChatControlsConfigurationOutput) -> bool
self
and other
values to be equal, and is used by ==
.Source§impl RequestId for GetChatControlsConfigurationOutput
impl RequestId for GetChatControlsConfigurationOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetChatControlsConfigurationOutput
Auto Trait Implementations§
impl Freeze for GetChatControlsConfigurationOutput
impl RefUnwindSafe for GetChatControlsConfigurationOutput
impl Send for GetChatControlsConfigurationOutput
impl Sync for GetChatControlsConfigurationOutput
impl Unpin for GetChatControlsConfigurationOutput
impl UnwindSafe for GetChatControlsConfigurationOutput
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);