Skip to content

HandoffAgentConfiguration

Source code in docs_src/capo_qconnect/types/handoff_agent_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
class HandoffAgentConfiguration(TypedDict, closed=True):
    agent_target: "capo_qconnect.types.agent_target.AgentTarget"
    """<p>The collaborator agent to hand off to.</p>"""
    instruction: NotRequired[
        "capo_qconnect.types.multi_agent_instruction.MultiAgentInstruction"
    ]
    """<p>The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.</p>"""
    audio_streaming_enabled: NotRequired["bool"]
    """<p>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.</p>"""
    immediate_handoff: NotRequired["bool"]
    """<p>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 <code>true</code>.</p>"""

agent_target instance-attribute 

agent_target: AgentTarget

The collaborator agent to hand off to.

audio_streaming_enabled instance-attribute 

audio_streaming_enabled: NotRequired[bool]

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.

immediate_handoff instance-attribute 

immediate_handoff: NotRequired[bool]

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.

instruction instance-attribute 

instruction: NotRequired[MultiAgentInstruction]

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