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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::ChatInput

Includes:

Structure

Defined in:

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 Amazon Q Business application linked to a streaming Amazon Q Business conversation.

• #client_token ⇒ String

  A token that you provide to identify the chat input.

• #conversation_id ⇒ String

  The identifier of the Amazon Q Business conversation.

• #input_stream ⇒ Types::ChatInputStream

  The streaming input for the ‘Chat` API.

• #parent_message_id ⇒ String

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

• #user_groups ⇒ Array<String>

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

• #user_id ⇒ String

  The identifier of the user attached to the chat input.

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

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

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)

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

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)

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

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:

• (Types::ChatInputStream)

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

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)

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

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 group names that a user associated with the chat input belongs to.

Returns:

• (Array<String>)

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

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)

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

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