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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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)


5601
5602
5603
5604
5605
5606
5607
5608
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5601

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

#example_chat_messagesArray<String>

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

Returns:

  • (Array<String>)


5601
5602
5603
5604
5605
5606
5607
5608
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5601

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

#nameString

A name for your topic control configuration.

Returns:

  • (String)


5601
5602
5603
5604
5605
5606
5607
5608
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5601

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

#rulesArray<Types::Rule>

Rules defined for a topic configuration.

Returns:



5601
5602
5603
5604
5605
5606
5607
5608
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5601

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