Class: Aws::QBusiness::Types::ChatInput

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

#application_idString

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

Returns:

  • (String)


1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

A token that you provide to identify the chat input.

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

Returns:

  • (String)


1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#conversation_idString

The identifier of the Amazon Q Business conversation.

Returns:

  • (String)


1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#input_streamTypes::ChatInputStream

The streaming input for the Chat API.



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#parent_message_idString

The identifier used to associate a user message with a AI generated response.

Returns:

  • (String)


1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#user_groupsArray<String>

The group names that a user associated with the chat input belongs to.

Returns:

  • (Array<String>)


1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

The identifier of the user attached to the chat input.

Returns:

  • (String)


1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1199

class ChatInput < Struct.new(
  :application_id,
  :user_id,
  :user_groups,
  :conversation_id,
  :parent_message_id,
  :client_token,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end