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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#blocked_phrasesTypes::BlockedPhrasesConfiguration

The phrases blocked from chat by your chat control configuration.



3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3827

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

#creator_mode_configurationTypes::AppliedCreatorModeConfiguration

The configuration details for CREATOR_MODE.



3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3827

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

#next_tokenString

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)


3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3827

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

#orchestration_configurationTypes::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.



3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3827

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

#response_scopeString

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)


3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3827

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

#topic_configurationsArray<Types::TopicConfiguration>

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

Returns:



3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3827

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