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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ai_agent_id ⇒ String

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

Returns:

  • (String)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant.

Returns:

  • (String)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

class SendMessageRequest < Struct.new(
  :assistant_id,
  :session_id,
  :type,
  :message,
  :ai_agent_id,
  :conversation_context,
  :configuration,
  :client_token,
  :orchestrator_use_case,
  :metadata,
  :origin_request_id)
  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)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#configuration ⇒ Types::MessageConfiguration

The configuration of the SendMessage request.



11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#conversation_context ⇒ Types::ConversationContext

The conversation context before the Amazon Q in Connect session.



11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#message ⇒ Types::MessageInput

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

Returns:



11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#metadata ⇒ Hash<String,String>

Additional metadata for the message.

Returns:

  • (Hash<String,String>)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#orchestrator_use_case ⇒ String

The orchestrator use case for message processing.

Returns:

  • (String)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#origin_request_id ⇒ String

Request identifier from the origin system, used for end-to-end tracing across spans.

Returns:

  • (String)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#session_id ⇒ String

The identifier of the Amazon Q in Connect session.

Returns:

  • (String)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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

#type ⇒ String

The message type.

Returns:

  • (String)


11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11163

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