afv-library/skills/developing-agentforce/assets/patterns/prompt-template-action.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

189 lines
6.4 KiB
Plaintext

# Prompt Template Action Pattern
# Invoke Salesforce PromptTemplates directly from Agent Script
#
# ★ When To Use This Pattern:
# - Generate dynamic AI content (summaries, emails, recommendations)
# - Use Einstein Prompt Builder templates from agents
# - Combine structured data with LLM generation
# - Leverage existing PromptTemplate investments
#
# ★ Key Insights:
# - Target uses generatePromptResponse:// protocol (not flow://)
# - Input names MUST have "Input:" prefix (critical!)
# - Output field is always named "promptResponse"
# - PromptTemplate must be deployed BEFORE the agent
#
# ★ Important Limitation:
# - Template API name must exactly match target
# - Record-bound templates require recordId input
#
# This is a COMPLETE template - customize for your use case
system:
instructions: "You are a content generation assistant. Help users create personalized content using AI templates. Always verify the generated content meets quality standards."
messages:
welcome: "Hello! I can help generate personalized content for you."
error: "I encountered an issue generating content. Let me try again."
config:
agent_name: "Content_Generator_Agent"
default_agent_user: "agent@company.salesforce.com"
agent_label: "Content Generator"
description: "Agent that generates AI content using Prompt Templates"
variables:
# Standard linked variables
EndUserId: linked string
source: @MessagingSession.MessagingEndUserId
description: "Messaging End User ID"
RoutableId: linked string
source: @MessagingSession.Id
description: "Messaging Session ID"
ContactId: linked string
source: @MessagingEndUser.ContactId
description: "Contact ID"
# Content generation variables
generated_schedule: mutable string = ""
description: "AI-generated schedule content"
generated_email: mutable string = ""
description: "AI-generated email content"
user_email: mutable string = ""
description: "User's email address"
user_timezone: mutable string = "America/Los_Angeles"
description: "User's timezone"
recipient_name: mutable string = ""
description: "Email recipient name"
email_topic: mutable string = ""
description: "Topic for email generation"
language:
default_locale: "en_US"
start_agent agent_router:
label: "Content Generator"
description: "Routes to content generation options"
reasoning:
instructions: ->
| Ask the user what type of content they'd like to generate:
| 1. Personalized daily schedule
| 2. Professional email
|
| Route to the appropriate subagent.
actions:
go_schedule: @utils.transition to @subagent.schedule_generation
go_email: @utils.transition to @subagent.email_generation
subagent schedule_generation:
label: "Schedule Generation"
description: "Generate personalized daily schedules"
actions:
# ★ PROMPT TEMPLATE ACTION - Key syntax elements:
# 1. target: uses generatePromptResponse:// protocol
# 2. inputs: MUST use "Input:" prefix
# 3. outputs: field name is always "promptResponse"
Generate_Personalized_Schedule:
description: "Generate a personalized daily schedule using AI."
inputs:
# ★ CRITICAL: Input names must have "Input:" prefix
# These map to {!email} and {!timezone} in the PromptTemplate
"Input:email": string
description: "User's email address for preference lookup"
is_required: True
"Input:timezone": string
description: "User's timezone for schedule formatting"
is_required: False
outputs:
# ★ Standard output field name for prompt responses
promptResponse: string
description: "The AI-generated schedule content"
is_used_by_planner: True
is_displayable: True
# ★ Target protocol: generatePromptResponse://TemplateApiName
target: "generatePromptResponse://Generate_Personalized_Schedule"
reasoning:
instructions: ->
| Help the user create a personalized daily schedule.
|
| 1. Ask for their email (required)
| 2. Ask for their timezone (optional, defaults to Pacific)
| 3. Generate the schedule using the AI template
| 4. Present the generated schedule
|
| The schedule will include morning routine, work blocks,
| breaks, and evening wind-down based on preferences.
actions:
create_schedule: @actions.Generate_Personalized_Schedule
# ★ Input binding with quoted field names
with "Input:email"=@variables.user_email
with "Input:timezone"=@variables.user_timezone
set @variables.generated_schedule = @outputs.promptResponse
back: @utils.transition to @subagent.agent_router
subagent email_generation:
label: "Email Generation"
description: "Generate professional emails"
actions:
# Another Prompt Template action example
Generate_Professional_Email:
description: "Generate a professional email draft."
inputs:
"Input:recipientName": string
description: "Name of the email recipient"
is_required: True
"Input:topic": string
description: "Topic or purpose of the email"
is_required: True
"Input:tone": string
description: "Desired tone: formal, friendly, urgent"
is_required: False
outputs:
promptResponse: string
description: "The generated email content"
is_used_by_planner: True
is_displayable: True
target: "generatePromptResponse://Generate_Professional_Email"
reasoning:
instructions: ->
| Help the user draft a professional email.
|
| Collect:
| 1. Recipient's name (required)
| 2. Email topic/purpose (required)
| 3. Desired tone: formal, friendly, or urgent (optional)
|
| Generate the email and present it for review.
actions:
create_email: @actions.Generate_Professional_Email
with "Input:recipientName"=...
with "Input:topic"=...
with "Input:tone"=...
set @variables.generated_email = @outputs.promptResponse
back: @utils.transition to @subagent.agent_router
# ★ Insight: Prompt Template Integration Checklist
#
# BEFORE PUBLISHING AGENT:
# 1. Create PromptTemplate metadata file
# 2. Deploy PromptTemplate: sf project deploy start -m "PromptTemplate:Template_Name"
# 3. Verify template exists: sf org list metadata -m PromptTemplate
#
# INPUT MAPPING:
# Agent Script "Input:fieldName" → PromptTemplate {!fieldName}
# "Input:email" → {!email}
# "Input:customerName" → {!customerName}
#
# COMMON ERRORS:
# - HTTP 404: PromptTemplate not deployed yet
# - "property X not found": Input name doesn't match template variable
# - Missing "Input:" prefix: Inputs won't map correctly