Struct aws_sdk_qbusiness::types::TopicConfiguration

#[non_exhaustive]
pub struct TopicConfiguration {
    pub name: String,
    pub description: Option<String>,
    pub example_chat_messages: Option<Vec<String>>,
    pub rules: Vec<Rule>,
}

The topic specific controls configured for an Amazon Q application.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

A name for your topic control configuration.

description: Option<String>

A description for your topic control configuration. Use this outline how the large language model (LLM) should use this topic control configuration.

example_chat_messages: Option<Vec<String>>

A list of example phrases that you expect the end user to use in relation to the topic.

rules: Vec<Rule>

Rules defined for a topic configuration.

Implementations

impl TopicConfiguration

pub fn name(&self) -> &str

A name for your topic control configuration.

pub fn description(&self) -> Option<&str>

A description for your topic control configuration. Use this outline how the large language model (LLM) should use this topic control configuration.

pub fn example_chat_messages(&self) -> &[String]

A list of example phrases that you expect the end user to use in relation to the topic.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .example_chat_messages.is_none().

pub fn rules(&self) -> &[Rule]

Rules defined for a topic configuration.

impl TopicConfiguration

pub fn builder() -> TopicConfigurationBuilder

Creates a new builder-style object to manufacture TopicConfiguration.

Trait Implementations

impl Clone for TopicConfiguration

fn clone(&self) -> TopicConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TopicConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TopicConfiguration

fn eq(&self, other: &TopicConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TopicConfiguration