Class: Aws::QBusiness::Types::GetChatControlsConfigurationResponse

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::GetChatControlsConfigurationResponse

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #blocked_phrases ⇒ Types::BlockedPhrasesConfiguration

  The phrases blocked from chat by your chat control configuration.

• #creator_mode_configuration ⇒ Types::AppliedCreatorModeConfiguration

  The configuration details for CREATOR_MODE.

• #next_token ⇒ String

  If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response.

• #response_scope ⇒ String

  The response scope configured for a Amazon Q Business application.

• #topic_configurations ⇒ Array<Types::TopicConfiguration>

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

Instance Attribute Details

#blocked_phrases ⇒ Types::BlockedPhrasesConfiguration

The phrases blocked from chat by your chat control configuration.

Returns:

• (Types::BlockedPhrasesConfiguration)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3101

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#creator_mode_configuration ⇒ Types::AppliedCreatorModeConfiguration

The configuration details for CREATOR_MODE.

Returns:

• (Types::AppliedCreatorModeConfiguration)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3101

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3101

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#response_scope ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3101

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#topic_configurations ⇒ Array<Types::TopicConfiguration>

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

Returns:

• (Array<Types::TopicConfiguration>)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3101

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end