Class: Aws::QConnect::Types::HandoffAgentConfiguration

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

Overview

A collaborator agent configuration in which the Orchestration AI Agent transfers control of the conversation to the collaborator agent.

See Also:

Constant Summary collapse

SENSITIVE = 
[:instruction]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_target ⇒ Types::AgentTarget

The collaborator agent to hand off to.

Returns:



5947
5948
5949
5950
5951
5952
5953
5954
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5947

class HandoffAgentConfiguration < Struct.new(
  :agent_target,
  :instruction,
  :audio_streaming_enabled,
  :immediate_handoff)
  SENSITIVE = [:instruction]
  include Aws::Structure
end

#audio_streaming_enabled ⇒ Boolean

Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.

Returns:

  • (Boolean) 


5947
5948
5949
5950
5951
5952
5953
5954
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5947

class HandoffAgentConfiguration < Struct.new(
  :agent_target,
  :instruction,
  :audio_streaming_enabled,
  :immediate_handoff)
  SENSITIVE = [:instruction]
  include Aws::Structure
end

#immediate_handoff ⇒ Boolean

Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.

Returns:

  • (Boolean) 


5947
5948
5949
5950
5951
5952
5953
5954
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5947

class HandoffAgentConfiguration < Struct.new(
  :agent_target,
  :instruction,
  :audio_streaming_enabled,
  :immediate_handoff)
  SENSITIVE = [:instruction]
  include Aws::Structure
end

#instruction ⇒ Types::MultiAgentInstruction

The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.

Returns:



5947
5948
5949
5950
5951
5952
5953
5954
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5947

class HandoffAgentConfiguration < Struct.new(
  :agent_target,
  :instruction,
  :audio_streaming_enabled,
  :immediate_handoff)
  SENSITIVE = [:instruction]
  include Aws::Structure
end