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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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_token ⇒ String

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) 


902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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_id ⇒ String

The identifier of the Amazon Q Business conversation.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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_stream ⇒ Types::ChatInputStream

The streaming input for the Chat API.

Returns:



902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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_id ⇒ String

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

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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_groups ⇒ Array<String>

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

Returns:

  • (Array<String>) 


902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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_id ⇒ String

The identifier of the user attached to the chat input.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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