mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-02 05:09:27 +08:00
261abd679a
* @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>
128 lines
6.7 KiB
YAML
128 lines
6.7 KiB
YAML
# Standard Agent Test Specification Template
|
|
# Compatible with: sf agent test create --spec <file> --api-name <name>
|
|
#
|
|
# Usage:
|
|
# 1. Replace <placeholders> with actual values
|
|
# 2. Create: sf agent test create --spec this-file.yaml --api-name <Test_Name> --target-org <alias>
|
|
# 3. Run: sf agent test run --api-name <Test_Name> --wait 10 --result-format json --target-org <alias>
|
|
#
|
|
# IMPORTANT: This YAML is parsed by @salesforce/agents — NOT a generic AiEvaluationDefinition format.
|
|
# Only use the fields documented below.
|
|
#
|
|
# NOTE: The Testing Center API uses "topic" terminology. In Agent Script, topics are called
|
|
# "subagents" (e.g., the `subagent` block). When writing tests, use "topic" to match the API,
|
|
# but understand that each expectedTopic value maps to a subagent in your .agent file.
|
|
|
|
# Required: Display name for the test (MasterLabel)
|
|
name: "<Agent_Name> Standard Tests"
|
|
|
|
# Required: Must be AGENT
|
|
subjectType: AGENT
|
|
|
|
# Required: Agent BotDefinition DeveloperName (API name)
|
|
subjectName: <Agent_Name>
|
|
|
|
testCases:
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
# TOPIC ROUTING TESTS
|
|
# Verify utterances route to the correct topic
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
|
|
- utterance: "User message that should trigger topic 1"
|
|
expectedTopic: <topic_name>
|
|
|
|
- utterance: "Alternative phrasing for topic 1"
|
|
expectedTopic: <topic_name>
|
|
|
|
- utterance: "User message that should trigger topic 2"
|
|
expectedTopic: <another_topic>
|
|
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
# ACTION INVOCATION TESTS
|
|
# Verify actions are invoked (flat list of action name strings)
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
|
|
- utterance: "Message that should trigger an action"
|
|
expectedTopic: <topic_name>
|
|
expectedActions:
|
|
- <action_name>
|
|
|
|
- utterance: "Message for a second action"
|
|
expectedTopic: <topic_name>
|
|
expectedActions:
|
|
- <action_name_2>
|
|
expectedOutcome: "Agent confirms the action and provides relevant details"
|
|
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
# CONTEXT VARIABLE TESTS
|
|
# Pass runtime context to simulate authenticated sessions
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
|
|
- utterance: "Show me my account details"
|
|
expectedTopic: <topic_name>
|
|
contextVariables:
|
|
- name: RoutableId
|
|
value: "<MessagingSession_ID>"
|
|
- name: CaseId
|
|
value: "<Case_ID>"
|
|
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
# CONVERSATION HISTORY TESTS
|
|
# Simulate multi-turn conversations (roles: user and agent)
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
|
|
- utterance: "Now process the return"
|
|
expectedTopic: <topic_name>
|
|
conversationHistory:
|
|
- role: user
|
|
message: "I need help with order #12345"
|
|
- role: agent
|
|
topic: <previous_topic>
|
|
message: "I found your order. It was delivered on March 1st. How can I help?"
|
|
expectedActions:
|
|
- <return_action_name>
|
|
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
# ESCALATION TESTS
|
|
# ═══════════════════════════════════════════════════════════════════
|
|
|
|
- utterance: "I want to talk to a real person"
|
|
expectedTopic: Escalation
|
|
|
|
# ═══════════════════════════════════════════════════════════════════════
|
|
# NOTES — AGENT SCRIPT ACTION TYPES
|
|
#
|
|
# Agent Script agents (.agent files / AiAuthoringBundle) have TWO types
|
|
# of actions that appear in CLI test results:
|
|
#
|
|
# 1. TRANSITION ACTIONS (from start_agent reasoning.actions):
|
|
# - Named: go_<topic_name>
|
|
# - Target: @utils.transition to @subagent.<name>
|
|
# - Captured by single-utterance tests
|
|
#
|
|
# 2. BUSINESS ACTIONS (from subagent.actions + reasoning.actions):
|
|
# - Named: <action_definition_name> (Level 1 from subagent.actions block)
|
|
# - Target: apex://ClassName or flow://FlowName
|
|
# - May require conversationHistory to reach in multi-subagent agents
|
|
#
|
|
# Use expectedActions with the DEFINITION name (Level 1), not the
|
|
# invocation name (Level 2). E.g., use get_order_status, not check_status.
|
|
# ═══════════════════════════════════════════════════════════════════════
|
|
|
|
# ═══════════════════════════════════════════════════════════════════════
|
|
# NOTES — TOPIC NAME RESOLUTION
|
|
#
|
|
# The expectedTopic value depends on the topic type:
|
|
#
|
|
# Standard topics (Escalation, Off_Topic, etc.):
|
|
# Use localDeveloperName: "Escalation"
|
|
#
|
|
# Promoted topics (created in Setup UI, prefixed with p_16j...):
|
|
# MUST use the full runtime developerName with hash suffix
|
|
#
|
|
# To discover actual topic names:
|
|
# 1. Run one test with a guess
|
|
# 2. Check results JSON: .testCases[].generatedData.topic
|
|
# 3. Update expectedTopic with the actual value
|
|
# ═══════════════════════════════════════════════════════════════════════
|