Class: Aws::QBusiness::Types::UpdateChatControlsConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::UpdateChatControlsConfigurationRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The identifier of the application for which the chat controls are configured.

• #blocked_phrases_configuration_update ⇒ Types::BlockedPhrasesConfigurationUpdate

  The phrases blocked from chat by your chat control configuration.

• #client_token ⇒ String

  A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

• #creator_mode_configuration ⇒ Types::CreatorModeConfiguration

  The configuration details for CREATOR_MODE.

• #hallucination_reduction_configuration ⇒ Types::HallucinationReductionConfiguration

  The hallucination reduction settings for your application.

• #orchestration_configuration ⇒ Types::OrchestrationConfiguration

  The chat response orchestration settings for your application.

• #response_scope ⇒ String

  The response scope configured for your application.

• #topic_configurations_to_create_or_update ⇒ Array<Types::TopicConfiguration>

  The configured topic specific chat controls you want to update.

• #topic_configurations_to_delete ⇒ Array<Types::TopicConfiguration>

  The configured topic specific chat controls you want to delete.

Instance Attribute Details

#application_id ⇒ String

The identifier of the application for which the chat controls are configured.

Returns:

• (String)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#blocked_phrases_configuration_update ⇒ Types::BlockedPhrasesConfigurationUpdate

The phrases blocked from chat by your chat control configuration.

Returns:

• (Types::BlockedPhrasesConfigurationUpdate)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creator_mode_configuration ⇒ Types::CreatorModeConfiguration

The configuration details for CREATOR_MODE.

Returns:

• (Types::CreatorModeConfiguration)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#hallucination_reduction_configuration ⇒ Types::HallucinationReductionConfiguration

The hallucination reduction settings for your application.

Returns:

• (Types::HallucinationReductionConfiguration)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#orchestration_configuration ⇒ Types::OrchestrationConfiguration

The chat response orchestration settings for your application.

Returns:

• (Types::OrchestrationConfiguration)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#response_scope ⇒ String

The response scope configured for your 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 8777

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#topic_configurations_to_create_or_update ⇒ Array<Types::TopicConfiguration>

The configured topic specific chat controls you want to update.

Returns:

• (Array<Types::TopicConfiguration>)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#topic_configurations_to_delete ⇒ Array<Types::TopicConfiguration>

The configured topic specific chat controls you want to delete.

Returns:

• (Array<Types::TopicConfiguration>)

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

class UpdateChatControlsConfigurationRequest < Struct.new(
  :application_id,
  :client_token,
  :response_scope,
  :orchestration_configuration,
  :blocked_phrases_configuration_update,
  :topic_configurations_to_create_or_update,
  :topic_configurations_to_delete,
  :creator_mode_configuration,
  :hallucination_reduction_configuration)
  SENSITIVE = []
  include Aws::Structure
end