Class: Aws::QBusiness::Types::ChatResponseConfiguration

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

Overview

Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#chat_response_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.

Returns:

  • (String) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#chat_response_configuration_id ⇒ String

A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.

Returns:

  • (String) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.

Returns:

  • (Time) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.

Returns:

  • (String) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#response_configuration_summary ⇒ String

A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.

Returns:

  • (String) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.

Returns:

  • (String) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.

Returns:

  • (Time) 


1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1403

class ChatResponseConfiguration < Struct.new(
  :chat_response_configuration_id,
  :chat_response_configuration_arn,
  :display_name,
  :response_configuration_summary,
  :status,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end