Class: Aws::QConnect::Types::SendMessageRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::SendMessageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ai_agent_id ⇒ String

  The identifier of the AI Agent to use for processing the message.

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #configuration ⇒ Types::MessageConfiguration

  The configuration of the [SendMessage] request.

• #conversation_context ⇒ Types::ConversationContext

  The conversation context before the Amazon Q in Connect session.

• #message ⇒ Types::MessageInput

  The message data to submit to the Amazon Q in Connect session.

• #metadata ⇒ Hash<String,String>

  Additional metadata for the message.

• #orchestrator_use_case ⇒ String

  The orchestrator use case for message processing.

• #session_id ⇒ String

  The identifier of the Amazon Q in Connect session.

• #type ⇒ String

  The message type.

Instance Attribute Details

#ai_agent_id ⇒ String

The identifier of the AI Agent to use for processing the message.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.

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

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::MessageConfiguration

The configuration of the [SendMessage] request.

[1]: docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html

Returns:

• (Types::MessageConfiguration)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#conversation_context ⇒ Types::ConversationContext

The conversation context before the Amazon Q in Connect session.

Returns:

• (Types::ConversationContext)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ Types::MessageInput

The message data to submit to the Amazon Q in Connect session.

Returns:

• (Types::MessageInput)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

Additional metadata for the message.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#orchestrator_use_case ⇒ String

The orchestrator use case for message processing.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the Amazon Q in Connect session.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The message type.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 10342

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end