Class: Aws::QBusiness::Types::ChatSyncOutput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_review ⇒ Types::ActionReview

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

Returns:



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#auth_challenge_request ⇒ Types::AuthChallengeRequest

An authentication verification event activated by an end user request to use a custom plugin.

Returns:



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#conversation_id ⇒ String

The identifier of the Amazon Q Business conversation.

Returns:

  • (String) 


1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#failed_attachments ⇒ Array<Types::AttachmentOutput>

A list of files which failed to upload during chat.

Returns:



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#source_attributions ⇒ Array<Types::SourceAttribution>

The source documents used to generate the conversation response.

Returns:



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#system_message ⇒ String

An AI-generated message in a conversation.

Returns:

  • (String) 


1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_id ⇒ String

The identifier of an Amazon Q Business AI generated message within the conversation.

Returns:

  • (String) 


1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end

#user_message_id ⇒ String

The identifier of an Amazon Q Business end user text input message within the conversation.

Returns:

  • (String) 


1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1338

class ChatSyncOutput < Struct.new(
  :conversation_id,
  :system_message,
  :system_message_id,
  :user_message_id,
  :action_review,
  :auth_challenge_request,
  :source_attributions,
  :failed_attachments)
  SENSITIVE = []
  include Aws::Structure
end