mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 11:43:26 +08:00
* @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>
273 lines
9.0 KiB
Plaintext
273 lines
9.0 KiB
Plaintext
# Order Service Agent
|
|
# ========================
|
|
#
|
|
# A complex real-world agent for e-commerce customer service featuring:
|
|
# - Verification gate before order access
|
|
# - Multiple specialized subagents (order status, tracking, returns)
|
|
# - Two-level action system with Flow targets
|
|
# - after_reasoning for post-action routing
|
|
# - available when guards for conditional action visibility
|
|
|
|
system:
|
|
instructions: |
|
|
You are an AI Customer Service Assistant helping customers with their orders.
|
|
Be helpful, empathetic, and efficient in resolving order-related issues.
|
|
Always verify customer identity before sharing order details.
|
|
Do not fabricate data — always use action results.
|
|
messages:
|
|
welcome: "Hello! I'm here to help you with your orders. How can I assist you today?"
|
|
error: "I apologize for the inconvenience. Let me try a different approach."
|
|
|
|
config:
|
|
developer_name: "OrderServiceAgent"
|
|
agent_label: "Order Service Assistant"
|
|
description: "Helps customers check order status, process returns, and track shipments"
|
|
default_agent_user: "einsteinagent@00dxx000001234.ext"
|
|
|
|
variables:
|
|
EndUserId: linked string
|
|
source: @MessagingSession.MessagingEndUserId
|
|
description: "Messaging End User ID"
|
|
visibility: "External"
|
|
RoutableId: linked string
|
|
source: @MessagingSession.Id
|
|
description: "Messaging Session ID"
|
|
visibility: "External"
|
|
ContactId: linked string
|
|
source: @MessagingEndUser.ContactId
|
|
description: "Contact ID"
|
|
visibility: "External"
|
|
customer_email: mutable string = ""
|
|
description: "Customer email for verification"
|
|
customer_verified: mutable boolean = False
|
|
description: "Whether customer identity has been verified"
|
|
order_number: mutable string = ""
|
|
description: "Current order number"
|
|
order_status: mutable string = ""
|
|
description: "Current order status"
|
|
tracking_number: mutable string = ""
|
|
description: "Shipment tracking number"
|
|
return_reason: mutable string = ""
|
|
description: "Reason for return"
|
|
return_initiated: mutable boolean = False
|
|
description: "Whether a return has been initiated"
|
|
return_label_url: mutable string = ""
|
|
description: "URL for return shipping label"
|
|
|
|
language:
|
|
default_locale: "en_US"
|
|
additional_locales: ""
|
|
all_additional_locales: False
|
|
|
|
start_agent agent_router:
|
|
description: "Route customers through verification then to the right subagent"
|
|
reasoning:
|
|
instructions: |
|
|
You are a router only. Do NOT answer questions or provide help directly.
|
|
Route all users to identity verification first.
|
|
If already verified, route to the appropriate subagent:
|
|
- Order questions -> use to_orders
|
|
- Returns -> use to_returns
|
|
- Tracking -> use to_tracking
|
|
actions:
|
|
to_verify: @utils.transition to @subagent.verification
|
|
description: "Begin identity verification"
|
|
to_orders: @utils.transition to @subagent.order_status
|
|
description: "Check order status"
|
|
available when @variables.customer_verified == True
|
|
to_returns: @utils.transition to @subagent.returns
|
|
description: "Process a return"
|
|
available when @variables.customer_verified == True
|
|
to_tracking: @utils.transition to @subagent.shipment_tracking
|
|
description: "Track a shipment"
|
|
available when @variables.customer_verified == True
|
|
|
|
subagent verification:
|
|
label: "Identity Verification"
|
|
description: "Verify customer identity before accessing order information"
|
|
|
|
actions:
|
|
verify_customer:
|
|
description: "Verify customer identity by email"
|
|
target: "flow://Verify_Customer_Identity"
|
|
inputs:
|
|
email: string
|
|
description: "Customer email address"
|
|
outputs:
|
|
verified: boolean
|
|
description: "Whether verification succeeded"
|
|
customer_name: string
|
|
description: "Verified customer name"
|
|
|
|
reasoning:
|
|
instructions: ->
|
|
if @variables.customer_verified == True:
|
|
| Welcome back! How can I help you today?
|
|
|
|
if @variables.customer_verified == False:
|
|
| To help you with your order, I need to verify your identity.
|
|
| What is the email address associated with your account?
|
|
|
|
actions:
|
|
verify: @actions.verify_customer
|
|
description: "Verify customer identity by email"
|
|
with email = ...
|
|
set @variables.customer_verified = @outputs.verified
|
|
set @variables.customer_email = @outputs.customer_name
|
|
|
|
proceed_to_orders: @utils.transition to @subagent.order_status
|
|
description: "Move to order lookup"
|
|
available when @variables.customer_verified == True
|
|
|
|
escalate_now: @utils.escalate
|
|
description: "Transfer to human agent"
|
|
|
|
subagent order_status:
|
|
label: "Order Status"
|
|
description: "Look up order details and provide status updates"
|
|
|
|
actions:
|
|
lookup_order:
|
|
description: "Look up order by order number"
|
|
target: "flow://Lookup_Order"
|
|
inputs:
|
|
order_number: string
|
|
description: "Order number to look up"
|
|
customer_email: string
|
|
description: "Customer email for validation"
|
|
outputs:
|
|
status: string
|
|
description: "Order status"
|
|
is_displayable: True
|
|
tracking_number: string
|
|
description: "Shipment tracking number"
|
|
is_displayable: True
|
|
estimated_delivery: string
|
|
description: "Estimated delivery date"
|
|
is_displayable: True
|
|
|
|
reasoning:
|
|
instructions: ->
|
|
if @variables.order_status != "":
|
|
| Order {!@variables.order_number} status: {!@variables.order_status}
|
|
| Would you like to track your shipment or initiate a return?
|
|
|
|
if @variables.order_status == "":
|
|
| What is your order number? You can find it in your confirmation email.
|
|
| Use the find_order action to look up order details.
|
|
|
|
actions:
|
|
find_order: @actions.lookup_order
|
|
description: "Look up order details"
|
|
with order_number = ...
|
|
with customer_email = @variables.customer_email
|
|
set @variables.order_status = @outputs.status
|
|
set @variables.tracking_number = @outputs.tracking_number
|
|
|
|
to_returns: @utils.transition to @subagent.returns
|
|
description: "Start a return"
|
|
available when @variables.order_status != ""
|
|
|
|
to_tracking: @utils.transition to @subagent.shipment_tracking
|
|
description: "Track shipment"
|
|
available when @variables.tracking_number != ""
|
|
|
|
back: @utils.transition to @subagent.agent_router
|
|
description: "Route to a different subagent"
|
|
|
|
subagent shipment_tracking:
|
|
label: "Shipment Tracking"
|
|
description: "Track shipment status and estimated delivery"
|
|
|
|
actions:
|
|
get_tracking_details:
|
|
description: "Get detailed tracking information"
|
|
target: "flow://Get_Tracking_Details"
|
|
inputs:
|
|
tracking_number: string
|
|
description: "Shipment tracking number"
|
|
outputs:
|
|
current_location: string
|
|
description: "Current package location"
|
|
is_displayable: True
|
|
estimated_delivery: string
|
|
description: "Estimated delivery date"
|
|
is_displayable: True
|
|
delivery_status: string
|
|
description: "Delivery status"
|
|
is_displayable: True
|
|
|
|
reasoning:
|
|
instructions: |
|
|
Look up the tracking information for the customer's shipment.
|
|
Use the track action with the tracking number.
|
|
Do not fabricate tracking details — always use the action result.
|
|
|
|
actions:
|
|
track: @actions.get_tracking_details
|
|
description: "Get tracking details"
|
|
with tracking_number = @variables.tracking_number
|
|
|
|
back: @utils.transition to @subagent.agent_router
|
|
description: "Route to a different subagent"
|
|
|
|
subagent returns:
|
|
label: "Returns"
|
|
description: "Process return requests and generate return labels"
|
|
|
|
actions:
|
|
initiate_return:
|
|
description: "Initiate a return for an order"
|
|
target: "flow://Initiate_Return"
|
|
inputs:
|
|
order_number: string
|
|
description: "Order number to return"
|
|
reason: string
|
|
description: "Reason for return"
|
|
outputs:
|
|
return_label_url: string
|
|
description: "URL for return shipping label"
|
|
is_displayable: True
|
|
return_deadline: string
|
|
description: "Deadline to ship return"
|
|
is_displayable: True
|
|
|
|
reasoning:
|
|
instructions: ->
|
|
if @variables.return_initiated == True:
|
|
| Your return has been initiated!
|
|
| Return label: {!@variables.return_label_url}
|
|
|
|
if @variables.return_initiated == False:
|
|
| I can help you with a return for order {!@variables.order_number}.
|
|
| What is the reason for your return?
|
|
| Use the process_return action to start the return.
|
|
|
|
actions:
|
|
process_return: @actions.initiate_return
|
|
description: "Process the return request"
|
|
with order_number = @variables.order_number
|
|
with reason = ...
|
|
set @variables.return_initiated = True
|
|
set @variables.return_label_url = @outputs.return_label_url
|
|
|
|
back: @utils.transition to @subagent.agent_router
|
|
description: "Route to a different subagent"
|
|
|
|
after_reasoning: ->
|
|
if @variables.return_initiated == True:
|
|
transition to @subagent.follow_up
|
|
|
|
subagent follow_up:
|
|
label: "Follow Up"
|
|
description: "Handle follow-up actions and next steps"
|
|
reasoning:
|
|
instructions: |
|
|
The customer's request has been processed.
|
|
Ask if there is anything else you can help with.
|
|
actions:
|
|
new_order: @utils.transition to @subagent.order_status
|
|
description: "Look up another order"
|
|
back: @utils.transition to @subagent.agent_router
|
|
description: "Start over"
|