afv-library/skills/developing-agentforce/assets/verification-gate.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

209 lines
8.2 KiB
Plaintext

# Verification Gate Architecture Template
# ========================================
#
# This template demonstrates the Verification Gate pattern where users
# must pass through identity verification before accessing sensitive subagents.
#
# Pattern: Security gate before protected functionality
# Use when: Handling sensitive data, payments, PII access
#
# Key Features:
# - Deterministic verification (code-enforced, not LLM suggestions)
# - available when guards make actions invisible until verified
# - Post-action checks at TOP of instructions
# - Automatic escalation after 3 failed attempts
system:
messages:
welcome: "Welcome! I'll need to verify your identity before we proceed."
error: "I apologize, something went wrong. Let me try again."
instructions: "You are a secure customer service agent. Always verify identity before sensitive operations."
config:
agent_name: "SecureAgent"
agent_label: "Secure Customer Agent"
description: "Agent with verification gate for sensitive operations"
default_agent_user: "agent@yourorg.com" # REQUIRED: Change to valid Einstein Agent User
variables:
# Identity verification state
customer_verified: mutable boolean = False
description: "Has customer passed identity verification"
failed_attempts: mutable number = 0
description: "Number of failed verification attempts"
# Session context (read-only from external source)
customer_id: linked string
source: @session.customerId
description: "Customer ID from session"
customer_email: linked string
source: @session.customerEmail
description: "Customer email from session"
# Operation state
refund_status: mutable string = ""
description: "Status of refund operation"
churn_risk_score: mutable number = 0
description: "Customer churn risk from Data Cloud"
# ============================================================
# ENTRY POINT
# ============================================================
start_agent entry:
description: "Entry point - routes through verification"
reasoning:
instructions: |
Welcome the customer and route to identity verification.
actions:
start_verification: @utils.transition to @subagent.identity_verification
description: "Begin identity verification process"
# ============================================================
# VERIFICATION GATE (Security Check)
# ============================================================
subagent identity_verification:
description: "Verify customer identity before proceeding"
reasoning:
instructions: ->
# SECURITY: Check for lockout FIRST (deterministic)
if @variables.failed_attempts >= 3:
| Too many failed attempts. Transferring to a human agent.
transition to @subagent.escalation
# Already verified? Proceed to protected subagents
if @variables.customer_verified == True:
| Identity verified! How can I help you today?
# Not yet verified
if @variables.customer_verified == False:
| Please verify your identity by confirming your email address.
| I have your email on file - please confirm it matches.
actions:
verify_email: @actions.verify_email
description: "Verify customer email"
with email = @variables.customer_email
set @variables.customer_verified = @outputs.verified
# GUARDED: Only visible when verified
go_to_account: @utils.transition to @subagent.account_management
description: "Access account settings"
available when @variables.customer_verified == True
go_to_refund: @utils.transition to @subagent.refund_processor
description: "Process a refund request"
available when @variables.customer_verified == True
# Always available
escalate_now: @utils.escalate
description: "Transfer to human agent"
# ============================================================
# PROTECTED: Account Management
# ============================================================
subagent account_management:
description: "Manage customer account (requires verification)"
reasoning:
instructions: ->
# SECURITY GATE: Re-check verification
if @variables.customer_verified == False:
transition to @subagent.identity_verification
| Welcome to account management.
| What would you like to do with your account?
actions:
update_email: @actions.update_email
description: "Update email address"
available when @variables.customer_verified == True
update_preferences: @actions.update_preferences
description: "Update communication preferences"
available when @variables.customer_verified == True
back: @utils.transition to @subagent.identity_verification
description: "Return to main menu"
# ============================================================
# PROTECTED: Refund Processor (with Post-Action Pattern)
# ============================================================
subagent refund_processor:
description: "Process refund requests (requires verification)"
reasoning:
instructions: ->
# SECURITY GATE: Re-check verification
if @variables.customer_verified == False:
transition to @subagent.identity_verification
# ====================================================
# POST-ACTION CHECK (at TOP - triggers on loop)
# ====================================================
if @variables.refund_status == "Approved":
# Deterministic follow-up - LLM cannot skip!
run @actions.create_crm_case
with customer_id = @variables.customer_id
with refund_amount = @variables.refund_amount
transition to @subagent.success_confirmation
# ====================================================
# PRE-LLM: Load churn risk data
# ====================================================
run @actions.check_churn_risk
with customer_id = @variables.customer_id
set @variables.churn_risk_score = @outputs.score
# ====================================================
# DYNAMIC INSTRUCTIONS (based on churn risk)
# ====================================================
| Customer risk score: {!@variables.churn_risk_score}
if @variables.churn_risk_score >= 80:
| HIGH RISK - Offer a full cash refund to retain this customer.
else:
| STANDARD - Offer a $10 store credit as goodwill.
actions:
approve_full_refund: @actions.process_refund
description: "Approve full cash refund"
available when @variables.churn_risk_score >= 80
with type = "full"
set @variables.refund_status = @outputs.status
offer_credit: @actions.issue_credit
description: "Offer store credit"
available when @variables.churn_risk_score < 80
with amount = 10
set @variables.refund_status = @outputs.status
# ============================================================
# SUCCESS CONFIRMATION
# ============================================================
subagent success_confirmation:
description: "Confirm successful operation"
reasoning:
instructions: |
Great news! Your request has been processed successfully.
Is there anything else I can help you with?
actions:
new_request: @utils.transition to @subagent.identity_verification
description: "Start a new request"
end_conversation: @actions.end_session
description: "End the conversation"
# ============================================================
# ESCALATION (Handoff to Human)
# ============================================================
subagent escalation:
description: "Escalate to human agent"
reasoning:
instructions: |
I'm transferring you to a human agent who can better assist you.
Please hold while I connect you.
actions:
handoff: @utils.escalate
description: "Transfer to human agent"