Class: Aws::QBusiness::Types::TopicConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

The topic specific controls configured for an Amazon Q Business application.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5842

class TopicConfiguration < Struct.new(
  :name,
  :description,
  :example_chat_messages,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#example_chat_messages ⇒ Array<String>

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

Returns:

  • (Array<String>) 


5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5842

class TopicConfiguration < Struct.new(
  :name,
  :description,
  :example_chat_messages,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for your topic control configuration.

Returns:

  • (String) 


5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5842

class TopicConfiguration < Struct.new(
  :name,
  :description,
  :example_chat_messages,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::Rule>

Rules defined for a topic configuration.

Returns:



5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5842

class TopicConfiguration < Struct.new(
  :name,
  :description,
  :example_chat_messages,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end