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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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`.

• #hallucination_reduction_configuration ⇒ Types::HallucinationReductionConfiguration

  The hallucination reduction settings for your application.

• #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.

• #orchestration_configuration ⇒ Types::AppliedOrchestrationConfiguration

  The chat response orchestration settings for your application.

• #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 'lib/aws-sdk-qbusiness/types.rb', line 4537

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

#creator_mode_configuration ⇒ Types::AppliedCreatorModeConfiguration

The configuration details for ‘CREATOR_MODE`.

Returns:

• (Types::AppliedCreatorModeConfiguration)

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

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

#hallucination_reduction_configuration ⇒ Types::HallucinationReductionConfiguration

The hallucination reduction settings for your application.

Returns:

• (Types::HallucinationReductionConfiguration)

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

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token,
  :hallucination_reduction_configuration)
  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 'lib/aws-sdk-qbusiness/types.rb', line 4537

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

#orchestration_configuration ⇒ Types::AppliedOrchestrationConfiguration

The chat response orchestration settings for your application.

<note markdown=“1”> Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see [Supported languages].

</note>

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html

Returns:

• (Types::AppliedOrchestrationConfiguration)

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

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token,
  :hallucination_reduction_configuration)
  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 'lib/aws-sdk-qbusiness/types.rb', line 4537

class GetChatControlsConfigurationResponse < Struct.new(
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases,
  :topic_configurations,
  :creator_mode_configuration,
  :next_token,
  :hallucination_reduction_configuration)
  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 'lib/aws-sdk-qbusiness/types.rb', line 4537

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