afv-library/skills/developing-agentforce/assets/escalation-pattern.agent
Willie Ruemmele 261abd679a
chore: rename topic to subagent for Agent Script v2 @W-21955450@ (#193)
* @W-21955450@ Rename topic to subagent for Agent Script v2

Aligns with Agent Script v2 naming standards where `topic` is renamed
to `subagent` across all skill documentation and templates.

Changes:
- Agent Script templates: topic keyword → subagent keyword
- References: @topic.* → @subagent.*
- Documentation: Updated all skill references and guides
- Natural language references preserved in comments/descriptions

* Rename start_agent topic_selector to agent_router

Completes the topic → subagent terminology alignment by:

1. Renaming start_agent from topic_selector to agent_router (15 agent files)
2. Updating template topic declarations: topic {{placeholder}} → subagent {{placeholder}} (5 files)
3. Updating all @subagent.topic_selector references to @subagent.agent_router (35 occurrences)
4. Updating documentation: prose, examples, and diagrams (10 markdown files)
5. Updating comments to use agent_router terminology

Files affected:
- 22 agent template files
- 10 documentation/reference markdown files
- Template component files

The agent_router name is more descriptive of its actual function
(routing to different subagents) and completes the Agent Script v2
terminology standardization.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Rename files with "topic" to use "subagent" terminology

Completes the topic → subagent terminology alignment by renaming
files and updating all references:

**Files renamed (5):**
- multi-topic.agent → multi-subagent.agent
- template-single-topic.agent → template-single-subagent.agent
- template-multi-topic.agent → template-multi-subagent.agent
- topic-with-actions.agent → subagent-with-actions.agent
- agent-topic-map-diagrams.md → agent-subagent-map-diagrams.md

**References updated (6 docs):**
- Updated all filename references to point to new filenames
- Updated "Topic Map" → "Subagent Map" throughout documentation
- Updated "multi-topic"/"single-topic" → "multi-subagent"/"single-subagent"

Files modified:
- README.md, SKILL.md, agent-spec-template.md
- assets/agents/README.md, assets/README-legacy.md
- references/agent-design-and-spec-creation.md

This ensures consistent "subagent" terminology across filenames,
file content, and all documentation references.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Complete topic-to-subagent terminology update across skills

Comprehensive update replacing "topic" with "subagent" terminology throughout
the developing-agentforce and testing-agentforce skills to align with Agent
Script's `subagent` block naming.

Key changes:
- "Topic Selector" → "Subagent Router" in all agent templates and docs
- "Topic/action" → "Subagent/action" in documentation
- "Topic map" → "Subagent map" in diagram references
- Updated all architecture documentation to use "subagent" terminology
- Updated 19 .agent template files with new labels and comments
- Updated 8 reference documentation files with consistent terminology

API contract preservation:
- Test spec YAML files preserve "topic" terminology to match Testing Center API
- Added clarifying comments explaining topic/subagent equivalence in YAML files
- Field names like `expectedTopic` unchanged (Salesforce API requirement)

Preserved terms:
- "off-topic" (standard phrase for out-of-scope)
- "expectedTopic" field (Testing Center API)
- "platform topics" (Salesforce guardrail features)

32 files changed, 379 insertions(+), 366 deletions(-)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Complete comprehensive topic-to-subagent terminology update

Thorough update replacing all remaining "topic" references with "subagent"
terminology across developing-agentforce, testing-agentforce, and
observing-agentforce skills to fully align with Agent Script's `subagent`
block naming.

Key changes:
- Agent Script syntax: @topic.<name> → @subagent.<name>
- Agent Script syntax: topic.actions → subagent.actions
- Shell script patterns: ^topic → ^subagent
- Documentation: "topic instructions" → "subagent instructions"
- observing-agentforce skill: Updated all agent architecture references
- Template files: Updated all inline comments and descriptions
- Variable names in scripts: TOPIC → SUBAGENT

Specific updates:
- 45 files changed, 294 insertions, 294 deletions
- Updated all Agent Script code examples to use @subagent syntax
- Updated observing-agentforce issue classification guide
- Updated shell script patterns in diagnostic tools
- Updated Apex comments to clarify topic field maps to subagents

Preserved (as required):
- "off-topic" and "off_topic" (standard out-of-scope phrase)
- Testing Center API fields: expectedTopic, topic: in YAML
- API response fields: .topic, generatedData.topic, topic_assertion
- STDM field names: ssot__TopicApiName__c (with clarifying docs)
- Template placeholders in test specs (API values)
- "Topic hash drift" (API field behavior)
- "Email topic/purpose" (means email subject)
- Explanatory comments about API field mapping

All Agent Script syntax and documentation now consistently uses "subagent"
while preserving backward compatibility with platform API field names.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* a few more topic -> subagent replacements

---------

Co-authored-by: Steve Hetzel <shetzel@salesforce.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-04-27 12:42:18 -06:00

210 lines
8.4 KiB
Plaintext

# Escalation Pattern Template
# ===========================
#
# This template demonstrates the complete escalation pattern with:
# - Multi-channel connection blocks (messaging, voice, web)
# - Graceful handoff with escalation messages
# - Pre-escalation data gathering
# - OmniChannel routing configuration
#
# Pattern: Multi-channel escalation with context preservation
# Use when: Any agent that needs human handoff capabilities
system:
messages:
welcome: "Hello! I'm here to help. If I can't assist you, I can connect you with a specialist."
error: "I apologize, something went wrong. Let me connect you with someone who can help."
instructions: "You are a helpful agent. When you cannot resolve an issue, escalate to a human agent with full context."
config:
agent_name: "EscalationPatternAgent"
agent_label: "Escalation Demo Agent"
description: "Agent demonstrating complete escalation patterns"
default_agent_user: "agent@yourorg.com" # REQUIRED: Change to valid Einstein Agent User
# ============================================================
# CONNECTION BLOCKS (Multi-Channel Escalation)
# ============================================================
connections:
# Messaging channel (SMS, WhatsApp, etc.)
connection messaging:
escalation_message: "One moment, I'm transferring our conversation to a specialist who can better assist you."
outbound_route_type: "OmniChannelFlow"
outbound_route_name: "<flow://Escalate_Messaging_To_Agent>"
adaptive_response_allowed: False
# Voice channel
connection voice:
escalation_message: "Please hold while I transfer you to a specialist. They will have full context of our conversation."
outbound_route_type: "Queue"
outbound_route_name: "Customer_Support_Queue"
adaptive_response_allowed: True
# Web chat channel
connection web:
escalation_message: "Connecting you with a live agent now. They'll be with you shortly."
outbound_route_type: "OmniChannelFlow"
outbound_route_name: "<flow://Web_Chat_Escalation_Flow>"
adaptive_response_allowed: False
variables:
# Customer context
customer_name: mutable string = ""
description: "Customer's name for personalization"
customer_issue: mutable string = ""
description: "Summary of customer's issue"
issue_category: mutable string = ""
description: "Category of issue for routing"
# Escalation state
escalation_reason: mutable string = ""
description: "Reason for escalation"
attempts_before_escalation: mutable number = 0
description: "Number of resolution attempts"
ready_to_escalate: mutable boolean = False
description: "Whether pre-escalation data is gathered"
start_agent entry:
description: "Entry point - greet and assess needs"
reasoning:
instructions: |
Greet the customer and understand their needs.
Try to help directly, escalate if needed.
actions:
go_support: @utils.transition to @subagent.support
description: "Help with support issue"
# ============================================================
# SUPPORT SUBAGENT (With Escalation Triggers)
# ============================================================
subagent support:
description: "Attempt to resolve issue, escalate if unable"
reasoning:
instructions: ->
# POST-ACTION: Check if escalation was triggered
if @variables.ready_to_escalate == True:
transition to @subagent.pre_escalation
# Track attempts
| I'm here to help you with your issue.
if @variables.attempts_before_escalation >= 2:
| It seems like I'm having trouble resolving this.
| Would you like me to connect you with a specialist?
actions:
# Attempt resolution
try_resolve: @actions.Attempt_Resolution
description: "Try to resolve the issue"
with issue = ... # LLM extracts from conversation
set @variables.customer_issue = @outputs.issue_summary
set @variables.issue_category = @outputs.category
set @variables.attempts_before_escalation = @variables.attempts_before_escalation + 1
# User-initiated escalation
request_human: @utils.setVariables
description: "I'd like to speak with a human"
with escalation_reason = "Customer requested human agent"
with ready_to_escalate = True
# Agent-initiated escalation (after failed attempts)
escalate_complex: @utils.setVariables
description: "Connect me with a specialist"
available when @variables.attempts_before_escalation >= 2
with escalation_reason = "Unable to resolve after multiple attempts"
with ready_to_escalate = True
# ============================================================
# PRE-ESCALATION SUBAGENT (Gather Context)
# ============================================================
subagent pre_escalation:
description: "Gather information before escalating"
reasoning:
instructions: ->
# Ensure we have customer name for personalization
if @variables.customer_name == "":
| Before I transfer you, may I have your name so the specialist can address you properly?
else:
| Thank you, {!@variables.customer_name}. Let me prepare the transfer.
# Display summary of what we'll share
if @variables.customer_name != "" and @variables.customer_issue != "":
| I'll share the following with the specialist:
| - Your issue: {!@variables.customer_issue}
| - Category: {!@variables.issue_category}
| - Reason for transfer: {!@variables.escalation_reason}
|
| Ready to connect you now.
transition to @subagent.escalation
actions:
# Capture customer name
save_name: @utils.setVariables
description: "Save customer name"
available when @variables.customer_name == ""
with customer_name = ... # LLM extracts name from response
# Proceed to escalation
proceed: @utils.transition to @subagent.escalation
description: "Proceed with transfer"
available when @variables.customer_name != ""
# Cancel escalation
cancel_escalation: @utils.setVariables
description: "Actually, let me try again with the bot"
with ready_to_escalate = False
with escalation_reason = ""
run @utils.transition to @subagent.support
# ============================================================
# ESCALATION SUBAGENT (Handoff)
# ============================================================
subagent escalation:
description: "Execute escalation to human agent"
reasoning:
instructions: ->
# Log escalation context (this gets passed to human agent)
run @actions.Log_Escalation_Context
with customer_name = @variables.customer_name
with issue_summary = @variables.customer_issue
with category = @variables.issue_category
with reason = @variables.escalation_reason
with attempt_count = @variables.attempts_before_escalation
| Transferring you now. Thank you for your patience!
actions:
# The actual escalation - uses connection block configuration
handoff: @utils.escalate
description: "Transfer to human agent"
# ============================================================
# OPTIONAL: SPECIALIZED ESCALATION QUEUES
# ============================================================
subagent escalate_billing:
description: "Escalate specifically to billing team"
reasoning:
instructions: |
I'm connecting you with our billing specialists.
They'll be able to help with your account questions.
actions:
# Note: In production, you'd configure this action
# to route to a specific billing queue
billing_handoff: @utils.escalate
description: "Transfer to billing team"
subagent escalate_technical:
description: "Escalate specifically to technical support"
reasoning:
instructions: |
I'm connecting you with our technical support team.
They specialize in resolving complex technical issues.
actions:
tech_handoff: @utils.escalate
description: "Transfer to technical support"