mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 03:09:50 +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>
4.5 KiB
4.5 KiB
Test Report Format, Coverage Analysis, and CI/CD — Reference
Summary Report
Agentforce Agent Test Report
===========================================
Agent: OrderManagementAgent
Org: production
Test Cases: 6
Duration: 45.2s
Results:
Subagent Routing: 5/6 passed (83.3%)
Action Invocation: 4/6 passed (66.7%)
Grounding: 6/6 passed (100%)
Safety: 6/6 passed (100%)
Response Quality: 5/6 passed (83.3%)
Overall Score: 86.7%
Status: PASSED WITH WARNINGS
Detailed Test Cases
Test Case 1: "Where is my order?"
Expected Topic: order_mgmt
Actual Topic: order_mgmt (pass)
Expected Action: get_order_status
Actual Action: get_order_status (pass)
Grounding: GROUNDED (pass)
Safety Score: 0.95 (pass)
Response Quality: Relevant (pass)
Test Case 2: "I want to return this"
Expected Topic: returns
Actual Topic: order_mgmt (fail - misrouted)
Fix Applied: Expanded 'returns' subagent description
Retry Result: Correctly routed (pass)
Coverage Analysis
Track which subagents and actions are tested across both modes:
| Dimension | Target | How to measure |
|---|---|---|
| Subagent coverage | 100% of non-entry subagents | Count subagents with at least 1 test case |
| Action coverage | 100% of actions | Count actions with at least 1 test case targeting them |
| Phrasing diversity | 3+ utterances per subagent (production) | Multiple wordings per intent |
| Guardrail coverage | At least 1 off-topic test | Verify agent deflects non-relevant queries |
| Multi-turn coverage | Test subagent transitions | Conversation history tests |
| Escalation coverage | Test escalation triggers | Verify human handoff works |
CI/CD with Testing Center
For CI/CD pipelines, use Mode B (Testing Center) for persistent regression suites:
# .github/workflows/agent-testing.yml
name: Agent Testing
on:
pull_request:
paths:
- 'force-app/**/*.agent'
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Authenticate org
run: |
echo "${{ secrets.SFDX_AUTH_URL }}" > auth.txt
sf org login sfdx-url --sfdx-url-file auth.txt --alias testorg
- name: Deploy test suite
run: |
sf agent test create --json \
--spec tests/${{ vars.AGENT_NAME }}-testing-center.yaml \
--api-name ${{ vars.AGENT_NAME }}_CI \
--force-overwrite \
-o testorg
- name: Run tests
run: |
sf agent test run --json \
--api-name ${{ vars.AGENT_NAME }}_CI \
--wait 15 \
--result-format junit \
--output-dir test-results \
-o testorg
- name: Upload test results
uses: actions/upload-artifact@v3
with:
name: agent-test-results
path: test-results/
Cross-Skill Integration (/observing-agentforce)
The /observing-agentforce skill creates test cases during its Phase 3.7 after fixing issues found through STDM session analysis. These test cases use Testing Center format so they can be deployed directly to the org.
Test Case Convention
Test cases from /observing-agentforce follow Testing Center YAML format:
# tests/<AgentApiName>-regression.yaml
name: "<AgentName> Regression Tests"
subjectType: AGENT
subjectName: <AgentApiName>
testCases:
- utterance: "find me a home in San Jose"
expectedTopic: home_search
expectedActions:
- search_homes_and_communities
- utterance: "I have a legal dispute"
expectedTopic: escalation
expectedActions:
- transfer_to_agent
Deploying Cross-Skill Tests
When /observing-agentforce generates test cases, deploy them using Mode B:
# Deploy the regression test suite
sf agent test create --json \
--spec tests/<AgentApiName>-regression.yaml \
--api-name <AgentApiName>_Regression \
--force-overwrite \
-o <org>
# Run
sf agent test run --json \
--api-name <AgentApiName>_Regression \
--wait 10 \
--result-format json \
-o <org>
Test File Location Convention
<project-root>/
tests/
<AgentApiName>-testing-center.yaml # Full smoke suite (Mode B -- Testing Center)
<AgentApiName>-regression.yaml # Regression tests from /observing-agentforce (Mode B)
<AgentApiName>-smoke.yaml # Ad-hoc smoke tests (Mode A -- preview only)
Both this skill and /observing-agentforce write to the tests/ directory using the agent's API name as prefix. Testing Center files (-testing-center.yaml, -regression.yaml) use the name/subjectType/subjectName/testCases format.