@salesforce/plugin-agent 1.39.0 → 1.39.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +99 -75
- package/messages/agent.trace.delete.md +13 -11
- package/messages/agent.trace.list.md +9 -9
- package/messages/agent.trace.read.md +25 -22
- package/oclif.manifest.json +734 -734
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -130,7 +130,7 @@ EXAMPLES
|
|
|
130
130
|
$ sf agent activate --api-name Resort_Manager --version 2 --target-org my-org
|
|
131
131
|
```
|
|
132
132
|
|
|
133
|
-
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
133
|
+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/activate.ts)_
|
|
134
134
|
|
|
135
135
|
## `sf agent create`
|
|
136
136
|
|
|
@@ -197,7 +197,7 @@ EXAMPLES
|
|
|
197
197
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
198
198
|
```
|
|
199
199
|
|
|
200
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
200
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/create.ts)_
|
|
201
201
|
|
|
202
202
|
## `sf agent deactivate`
|
|
203
203
|
|
|
@@ -238,7 +238,7 @@ EXAMPLES
|
|
|
238
238
|
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
|
|
239
239
|
```
|
|
240
240
|
|
|
241
|
-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
241
|
+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/deactivate.ts)_
|
|
242
242
|
|
|
243
243
|
## `sf agent generate agent-spec`
|
|
244
244
|
|
|
@@ -345,7 +345,7 @@ EXAMPLES
|
|
|
345
345
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
346
346
|
```
|
|
347
347
|
|
|
348
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
348
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/generate/agent-spec.ts)_
|
|
349
349
|
|
|
350
350
|
## `sf agent generate authoring-bundle`
|
|
351
351
|
|
|
@@ -422,7 +422,7 @@ EXAMPLES
|
|
|
422
422
|
other-package-dir/main/default --target-org my-dev-org
|
|
423
423
|
```
|
|
424
424
|
|
|
425
|
-
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
425
|
+
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/generate/authoring-bundle.ts)_
|
|
426
426
|
|
|
427
427
|
## `sf agent generate template`
|
|
428
428
|
|
|
@@ -484,7 +484,7 @@ EXAMPLES
|
|
|
484
484
|
my-package --source-org my-scratch-org
|
|
485
485
|
```
|
|
486
486
|
|
|
487
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
487
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/generate/template.ts)_
|
|
488
488
|
|
|
489
489
|
## `sf agent generate test-spec`
|
|
490
490
|
|
|
@@ -549,7 +549,7 @@ EXAMPLES
|
|
|
549
549
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
550
550
|
```
|
|
551
551
|
|
|
552
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
552
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/generate/test-spec.ts)_
|
|
553
553
|
|
|
554
554
|
## `sf agent preview`
|
|
555
555
|
|
|
@@ -622,7 +622,7 @@ EXAMPLES
|
|
|
622
622
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
623
623
|
```
|
|
624
624
|
|
|
625
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
625
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/preview.ts)_
|
|
626
626
|
|
|
627
627
|
## `sf agent preview end`
|
|
628
628
|
|
|
@@ -694,7 +694,7 @@ EXAMPLES
|
|
|
694
694
|
$ sf agent preview end --all --target-org <target_org>
|
|
695
695
|
```
|
|
696
696
|
|
|
697
|
-
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
697
|
+
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/preview/end.ts)_
|
|
698
698
|
|
|
699
699
|
## `sf agent preview send`
|
|
700
700
|
|
|
@@ -752,7 +752,7 @@ EXAMPLES
|
|
|
752
752
|
$ sf agent preview send --utterance "what can you help me with?" --authoring-bundle My_Local_Agent
|
|
753
753
|
```
|
|
754
754
|
|
|
755
|
-
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
755
|
+
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/preview/send.ts)_
|
|
756
756
|
|
|
757
757
|
## `sf agent preview sessions`
|
|
758
758
|
|
|
@@ -785,7 +785,7 @@ EXAMPLES
|
|
|
785
785
|
$ sf agent preview sessions
|
|
786
786
|
```
|
|
787
787
|
|
|
788
|
-
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
788
|
+
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/preview/sessions.ts)_
|
|
789
789
|
|
|
790
790
|
## `sf agent preview start`
|
|
791
791
|
|
|
@@ -850,7 +850,7 @@ EXAMPLES
|
|
|
850
850
|
$ sf agent preview start --api-name My_Published_Agent
|
|
851
851
|
```
|
|
852
852
|
|
|
853
|
-
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
853
|
+
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/preview/start.ts)_
|
|
854
854
|
|
|
855
855
|
## `sf agent publish authoring-bundle`
|
|
856
856
|
|
|
@@ -910,7 +910,7 @@ EXAMPLES
|
|
|
910
910
|
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --concise
|
|
911
911
|
```
|
|
912
912
|
|
|
913
|
-
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
913
|
+
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/publish/authoring-bundle.ts)_
|
|
914
914
|
|
|
915
915
|
## `sf agent test create`
|
|
916
916
|
|
|
@@ -965,7 +965,7 @@ EXAMPLES
|
|
|
965
965
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
966
966
|
```
|
|
967
967
|
|
|
968
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
968
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/test/create.ts)_
|
|
969
969
|
|
|
970
970
|
## `sf agent test list`
|
|
971
971
|
|
|
@@ -1000,7 +1000,7 @@ EXAMPLES
|
|
|
1000
1000
|
$ sf agent test list --target-org my-org
|
|
1001
1001
|
```
|
|
1002
1002
|
|
|
1003
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1003
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/test/list.ts)_
|
|
1004
1004
|
|
|
1005
1005
|
## `sf agent test results`
|
|
1006
1006
|
|
|
@@ -1076,7 +1076,7 @@ FLAG DESCRIPTIONS
|
|
|
1076
1076
|
expression when using custom evaluations.
|
|
1077
1077
|
```
|
|
1078
1078
|
|
|
1079
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1079
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/test/results.ts)_
|
|
1080
1080
|
|
|
1081
1081
|
## `sf agent test resume`
|
|
1082
1082
|
|
|
@@ -1160,7 +1160,7 @@ FLAG DESCRIPTIONS
|
|
|
1160
1160
|
expression when using custom evaluations.
|
|
1161
1161
|
```
|
|
1162
1162
|
|
|
1163
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1163
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/test/resume.ts)_
|
|
1164
1164
|
|
|
1165
1165
|
## `sf agent test run`
|
|
1166
1166
|
|
|
@@ -1244,7 +1244,7 @@ FLAG DESCRIPTIONS
|
|
|
1244
1244
|
expression when using custom evaluations.
|
|
1245
1245
|
```
|
|
1246
1246
|
|
|
1247
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1247
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/test/run.ts)_
|
|
1248
1248
|
|
|
1249
1249
|
## `sf agent test run-eval`
|
|
1250
1250
|
|
|
@@ -1317,11 +1317,11 @@ EXAMPLES
|
|
|
1317
1317
|
$ echo '{"tests":[...]}' | sf agent test run-eval --spec --target-org my-org
|
|
1318
1318
|
```
|
|
1319
1319
|
|
|
1320
|
-
_See code: [src/commands/agent/test/run-eval.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1320
|
+
_See code: [src/commands/agent/test/run-eval.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/test/run-eval.ts)_
|
|
1321
1321
|
|
|
1322
1322
|
## `sf agent trace delete`
|
|
1323
1323
|
|
|
1324
|
-
Delete agent preview
|
|
1324
|
+
Delete trace files from an agent preview session.
|
|
1325
1325
|
|
|
1326
1326
|
```
|
|
1327
1327
|
USAGE
|
|
@@ -1329,28 +1329,34 @@ USAGE
|
|
|
1329
1329
|
[--no-prompt]
|
|
1330
1330
|
|
|
1331
1331
|
FLAGS
|
|
1332
|
-
-a, --agent=<value>
|
|
1333
|
-
starting the session,
|
|
1332
|
+
-a, --agent=<value> API name of the agent used to filter the list of trace files you want to delete. Matches
|
|
1333
|
+
against the API name used when starting the session, either an authoring bundle or a
|
|
1334
|
+
published agent API name.
|
|
1334
1335
|
--no-prompt Skip the confirmation prompt and delete immediately.
|
|
1335
|
-
--older-than=<value>
|
|
1336
|
-
h/hours, d/days, w/weeks
|
|
1337
|
-
|
|
1336
|
+
--older-than=<value> Duration used to filter the list of trace files; only files older than the duration are
|
|
1337
|
+
deleted. Accepts a number followed by a unit: m/minutes, h/hours, d/days, w/weeks. Examples:
|
|
1338
|
+
7d, 24h, 2w.
|
|
1339
|
+
--session-id=<value> Session ID used to filter the list of trace files you want to delete. Use the "agent preview
|
|
1340
|
+
sessions" CLI command to list all known agent preview sessions along with their session IDs.
|
|
1338
1341
|
|
|
1339
1342
|
GLOBAL FLAGS
|
|
1340
1343
|
--flags-dir=<value> Import flag values from a directory.
|
|
1341
1344
|
--json Format output as json.
|
|
1342
1345
|
|
|
1343
1346
|
DESCRIPTION
|
|
1344
|
-
Delete agent preview
|
|
1347
|
+
Delete trace files from an agent preview session.
|
|
1345
1348
|
|
|
1346
|
-
|
|
1347
|
-
|
|
1349
|
+
When you run an agent preview conversation (either interactive or programmatic), trace files are automatically
|
|
1350
|
+
recorded and saved in your local DX project. Use this command to delete some or all of the trace files.
|
|
1348
1351
|
|
|
1349
|
-
|
|
1350
|
-
|
|
1352
|
+
By default, this command shows a preview of what will be deleted and prompts for confirmation. Use --no-prompt to skip
|
|
1353
|
+
confirmation.
|
|
1354
|
+
|
|
1355
|
+
Without filters, this comamnd deletes all trace files for all agents and sessions. Use flags to narrow the scope:
|
|
1356
|
+
filter by agent API name (--agent), by session (--session-id), or by age (--older-than).
|
|
1351
1357
|
|
|
1352
1358
|
EXAMPLES
|
|
1353
|
-
Delete all traces for all agents and sessions
|
|
1359
|
+
Delete all traces for all agents and sessions; prompt for confirmation:
|
|
1354
1360
|
|
|
1355
1361
|
$ sf agent trace delete
|
|
1356
1362
|
|
|
@@ -1366,29 +1372,31 @@ EXAMPLES
|
|
|
1366
1372
|
|
|
1367
1373
|
$ sf agent trace delete --older-than 7d
|
|
1368
1374
|
|
|
1369
|
-
Delete traces older than 24 hours for a specific agent
|
|
1375
|
+
Delete traces older than 24 hours for a specific agent; don't prompt for confirmation:
|
|
1370
1376
|
|
|
1371
1377
|
$ sf agent trace delete --agent My_Agent --older-than 24h --no-prompt
|
|
1372
1378
|
|
|
1373
|
-
Delete all traces
|
|
1379
|
+
Delete all traces for all agents and sessions; don't prompt for confirmation:
|
|
1374
1380
|
|
|
1375
1381
|
$ sf agent trace delete --no-prompt
|
|
1376
1382
|
```
|
|
1377
1383
|
|
|
1378
|
-
_See code: [src/commands/agent/trace/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1384
|
+
_See code: [src/commands/agent/trace/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/trace/delete.ts)_
|
|
1379
1385
|
|
|
1380
1386
|
## `sf agent trace list`
|
|
1381
1387
|
|
|
1382
|
-
List the trace files that were recorded during all agent preview sessions.
|
|
1388
|
+
List the available trace files that were recorded during all agent preview sessions.
|
|
1383
1389
|
|
|
1384
1390
|
```
|
|
1385
1391
|
USAGE
|
|
1386
1392
|
$ sf agent trace list [--json] [--flags-dir <value>] [--session-id <value>] [-a <value>] [--since <value>]
|
|
1387
1393
|
|
|
1388
1394
|
FLAGS
|
|
1389
|
-
-a, --agent=<value>
|
|
1390
|
-
starting the session,
|
|
1391
|
-
|
|
1395
|
+
-a, --agent=<value> API name of the agent used to filter the list of available trace files. Matches against the
|
|
1396
|
+
API name used when starting the session, either an authoring bundle or a published agent API
|
|
1397
|
+
name.
|
|
1398
|
+
--session-id=<value> Session ID used to filter the list of trace files. Use the "agent preview sessions" CLI
|
|
1399
|
+
command to list all known agent preview sessions along with their session IDs.
|
|
1392
1400
|
--since=<value> Date used to filter the list of trace files; only those recorded on or after the date are
|
|
1393
1401
|
listed.
|
|
1394
1402
|
|
|
@@ -1397,33 +1405,34 @@ GLOBAL FLAGS
|
|
|
1397
1405
|
--json Format output as json.
|
|
1398
1406
|
|
|
1399
1407
|
DESCRIPTION
|
|
1400
|
-
List the trace files that were recorded during all agent preview sessions.
|
|
1408
|
+
List the available trace files that were recorded during all agent preview sessions.
|
|
1401
1409
|
|
|
1402
|
-
|
|
1403
|
-
|
|
1410
|
+
When you run an agent preview conversation (either interactive or programmatic), trace files are automatically
|
|
1411
|
+
recorded and saved in your local DX project. By default, this command lists all trace files for all agents and all of
|
|
1412
|
+
their sessions. Use flags to narrow results: filter by agent name (--agent), by session (--session-id), or by date
|
|
1404
1413
|
(--since).
|
|
1405
1414
|
|
|
1406
1415
|
Each row in the output corresponds to one trace file, which in turn corresponds to one agent session. The Agent column
|
|
1407
1416
|
shows the authoring bundle or API name used when starting the session.
|
|
1408
1417
|
|
|
1409
1418
|
EXAMPLES
|
|
1410
|
-
List all
|
|
1419
|
+
List all trace files for all agents and sessions:
|
|
1411
1420
|
|
|
1412
1421
|
$ sf agent trace list
|
|
1413
1422
|
|
|
1414
|
-
List all
|
|
1423
|
+
List all trace files for a specific agent:
|
|
1415
1424
|
|
|
1416
1425
|
$ sf agent trace list --agent My_Agent
|
|
1417
1426
|
|
|
1418
|
-
List
|
|
1427
|
+
List trace files for a specific session:
|
|
1419
1428
|
|
|
1420
1429
|
$ sf agent trace list --session-id <SESSION_ID>
|
|
1421
1430
|
|
|
1422
|
-
List
|
|
1431
|
+
List trace files recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):
|
|
1423
1432
|
|
|
1424
1433
|
$ sf agent trace list --since 2026-04-20
|
|
1425
1434
|
|
|
1426
|
-
List
|
|
1435
|
+
List trace files recorded on or after a specific UTC time:
|
|
1427
1436
|
|
|
1428
1437
|
$ sf agent trace list --since 2026-04-20T14:00:00Z
|
|
1429
1438
|
|
|
@@ -1442,11 +1451,11 @@ FLAG DESCRIPTIONS
|
|
|
1442
1451
|
(2026-04-20T14:00:00.000Z). The "Recorded At" values shown in the table output are valid inputs.
|
|
1443
1452
|
```
|
|
1444
1453
|
|
|
1445
|
-
_See code: [src/commands/agent/trace/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1454
|
+
_See code: [src/commands/agent/trace/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/trace/list.ts)_
|
|
1446
1455
|
|
|
1447
1456
|
## `sf agent trace read`
|
|
1448
1457
|
|
|
1449
|
-
Read
|
|
1458
|
+
Read trace files from an agent preview session.
|
|
1450
1459
|
|
|
1451
1460
|
```
|
|
1452
1461
|
USAGE
|
|
@@ -1454,43 +1463,58 @@ USAGE
|
|
|
1454
1463
|
actions|grounding|routing|errors] [-t <value>]
|
|
1455
1464
|
|
|
1456
1465
|
FLAGS
|
|
1457
|
-
-d, --dimension=<option> Dimension to drill into when using --format detail
|
|
1458
|
-
|
|
1466
|
+
-d, --dimension=<option> Dimension to drill into when using "--format detail"; used to filter and organize the trace
|
|
1467
|
+
data to answer a specific type of question.
|
|
1459
1468
|
<options: actions|grounding|routing|errors>
|
|
1460
|
-
-f, --format=<option> [default: summary] Output format
|
|
1461
|
-
|
|
1469
|
+
-f, --format=<option> [default: summary] Output format of the trace data; specifies the level of detail you want
|
|
1470
|
+
in the trace files.
|
|
1462
1471
|
<options: summary|detail|raw>
|
|
1463
|
-
-s, --session-id=<value> (required) Session ID to read traces for.
|
|
1464
|
-
|
|
1472
|
+
-s, --session-id=<value> (required) Session ID to read traces for. Use the "agent preview sessions" CLI command to
|
|
1473
|
+
list all known agent preview sessions along with their session IDs
|
|
1474
|
+
-t, --turn=<value> Turn number for which you want trace data. A turn is a single utterance or response in a
|
|
1475
|
+
conversation, starting with 1.
|
|
1465
1476
|
|
|
1466
1477
|
GLOBAL FLAGS
|
|
1467
1478
|
--flags-dir=<value> Import flag values from a directory.
|
|
1468
1479
|
--json Format output as json.
|
|
1469
1480
|
|
|
1470
1481
|
DESCRIPTION
|
|
1471
|
-
Read
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1482
|
+
Read trace files from an agent preview session.
|
|
1483
|
+
|
|
1484
|
+
When you run an agent preview conversation (either interactive or programmatic), trace files are automatically
|
|
1485
|
+
recorded and saved in your local DX project. Each turn (utterance or response) of a conversation creates trace data.
|
|
1486
|
+
Use this command to view trace data for a specific preview session, so you can then analyze the trace data to observe,
|
|
1487
|
+
monitor, investigate, and troubleshoot agent events and behavior.
|
|
1488
|
+
|
|
1489
|
+
Use the --format flag to specify one of these formats of the outputted trace data:
|
|
1490
|
+
|
|
1491
|
+
- summary (Default): A per-turn narrative showing topic routing, actions executed, and the agent's response. Use this
|
|
1492
|
+
to quickly understand what happened in a preview session.
|
|
1493
|
+
- detail: Diagnostic drill-down into a specific dimension. Filters output to only the trace steps relevant to that
|
|
1494
|
+
dimension, minimizing noise.
|
|
1495
|
+
- raw: Unprocessed trace JSON. Use this as a fallback when the trace schema has changed or you need to perform custom
|
|
1496
|
+
analysis.
|
|
1497
|
+
|
|
1498
|
+
If you specify "--format detail", you must also specify a dimension with the --dimension flag. Dimensions are a way to
|
|
1499
|
+
slice and analyze the agent execution trace from a specific angle or concern. Instead of looking at the raw sequence
|
|
1500
|
+
of everything that happened, each dimension filters and organizes the trace data to answer a specific type of
|
|
1501
|
+
question. These are the available dimensions and the information they provide:
|
|
1502
|
+
|
|
1503
|
+
- actions: The actions the agent executed. Includes action name, input parameters, output, and latency. Use this
|
|
1504
|
+
dimension to understand what the agent actually did when answering an utterance in the preview session.
|
|
1505
|
+
- grounding: The reasoning steps used by the LLM. Use this dimension to see how the agent "thought" about the problem
|
|
1506
|
+
- the AI reasoning that determined which actions to take.
|
|
1507
|
+
- routing: How the agent navigated between subagents. Use this dimension to understand conversation flow - when and
|
|
1508
|
+
why the agent switched between different subagents or contexts during the conversation.
|
|
1509
|
+
- errors: Aggregates all errors during the session. Use this dimension to quickly identify and debug issues across all
|
|
1510
|
+
steps.
|
|
1487
1511
|
|
|
1488
1512
|
EXAMPLES
|
|
1489
|
-
Show a session summary
|
|
1513
|
+
Show a session trace summary for all turns in the session with the specified ID:
|
|
1490
1514
|
|
|
1491
1515
|
$ sf agent trace read --session-id <SESSION_ID>
|
|
1492
1516
|
|
|
1493
|
-
Show summary for
|
|
1517
|
+
Show a trace summary for the second turn (utterance or response) of the conversation:
|
|
1494
1518
|
|
|
1495
1519
|
$ sf agent trace read --session-id <SESSION_ID> --turn 2
|
|
1496
1520
|
|
|
@@ -1498,7 +1522,7 @@ EXAMPLES
|
|
|
1498
1522
|
|
|
1499
1523
|
$ sf agent trace read --session-id <SESSION_ID> --format detail --dimension actions
|
|
1500
1524
|
|
|
1501
|
-
Drill into routing decisions for
|
|
1525
|
+
Drill into routing decisions for the first turn of the conversation:
|
|
1502
1526
|
|
|
1503
1527
|
$ sf agent trace read --session-id <SESSION_ID> --format detail --dimension routing --turn 1
|
|
1504
1528
|
|
|
@@ -1515,7 +1539,7 @@ EXAMPLES
|
|
|
1515
1539
|
$ sf agent trace read --session-id <SESSION_ID> --json
|
|
1516
1540
|
```
|
|
1517
1541
|
|
|
1518
|
-
_See code: [src/commands/agent/trace/read.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1542
|
+
_See code: [src/commands/agent/trace/read.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/trace/read.ts)_
|
|
1519
1543
|
|
|
1520
1544
|
## `sf agent validate authoring-bundle`
|
|
1521
1545
|
|
|
@@ -1562,6 +1586,6 @@ EXAMPLES
|
|
|
1562
1586
|
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
|
|
1563
1587
|
```
|
|
1564
1588
|
|
|
1565
|
-
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.
|
|
1589
|
+
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.39.1/src/commands/agent/validate/authoring-bundle.ts)_
|
|
1566
1590
|
|
|
1567
1591
|
<!-- commandsstop -->
|
|
@@ -1,24 +1,26 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
Delete agent preview
|
|
3
|
+
Delete trace files from an agent preview session.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. Use this command to delete some or all of the trace files.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
By default, this command shows a preview of what will be deleted and prompts for confirmation. Use --no-prompt to skip confirmation.
|
|
10
|
+
|
|
11
|
+
Without filters, this comamnd deletes all trace files for all agents and sessions. Use flags to narrow the scope: filter by agent API name (--agent), by session (--session-id), or by age (--older-than).
|
|
10
12
|
|
|
11
13
|
# flags.agent.summary
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
API name of the agent used to filter the list of trace files you want to delete. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.
|
|
14
16
|
|
|
15
17
|
# flags.session-id.summary
|
|
16
18
|
|
|
17
|
-
|
|
19
|
+
Session ID used to filter the list of trace files you want to delete. Use the "agent preview sessions" CLI command to list all known agent preview sessions along with their session IDs.
|
|
18
20
|
|
|
19
21
|
# flags.older-than.summary
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
Duration used to filter the list of trace files; only files older than the duration are deleted. Accepts a number followed by a unit: m/minutes, h/hours, d/days, w/weeks. Examples: 7d, 24h, 2w.
|
|
22
24
|
|
|
23
25
|
# flags.no-prompt.summary
|
|
24
26
|
|
|
@@ -26,11 +28,11 @@ Skip the confirmation prompt and delete immediately.
|
|
|
26
28
|
|
|
27
29
|
# error.invalidOlderThan
|
|
28
30
|
|
|
29
|
-
Invalid --older-than value: '%s'. Use a number followed by a unit: m/minutes, h/hours, d/days, w/weeks
|
|
31
|
+
Invalid --older-than value: '%s'. Use a number followed by a unit: m/minutes, h/hours, d/days, w/weeks, Examples: 7d, 24h, 30m, 2w.
|
|
30
32
|
|
|
31
33
|
# prompt.confirm
|
|
32
34
|
|
|
33
|
-
Delete %s trace file(s)? This
|
|
35
|
+
Delete %s trace file(s)? This can't be undone.
|
|
34
36
|
|
|
35
37
|
# output.noneFound
|
|
36
38
|
|
|
@@ -62,7 +64,7 @@ Plan ID
|
|
|
62
64
|
|
|
63
65
|
# examples
|
|
64
66
|
|
|
65
|
-
- Delete all traces for all agents and sessions
|
|
67
|
+
- Delete all traces for all agents and sessions; prompt for confirmation:
|
|
66
68
|
|
|
67
69
|
<%= config.bin %> <%= command.id %>
|
|
68
70
|
|
|
@@ -78,10 +80,10 @@ Plan ID
|
|
|
78
80
|
|
|
79
81
|
<%= config.bin %> <%= command.id %> --older-than 7d
|
|
80
82
|
|
|
81
|
-
- Delete traces older than 24 hours for a specific agent
|
|
83
|
+
- Delete traces older than 24 hours for a specific agent; don't prompt for confirmation:
|
|
82
84
|
|
|
83
85
|
<%= config.bin %> <%= command.id %> --agent My_Agent --older-than 24h --no-prompt
|
|
84
86
|
|
|
85
|
-
- Delete all traces
|
|
87
|
+
- Delete all traces for all agents and sessions; don't prompt for confirmation:
|
|
86
88
|
|
|
87
89
|
<%= config.bin %> <%= command.id %> --no-prompt
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
List the trace files that were recorded during all agent preview sessions.
|
|
3
|
+
List the available trace files that were recorded during all agent preview sessions.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. By default, this command lists all trace files for all agents and all of their sessions. Use flags to narrow results: filter by agent name (--agent), by session (--session-id), or by date (--since).
|
|
8
8
|
|
|
9
9
|
Each row in the output corresponds to one trace file, which in turn corresponds to one agent session. The Agent column shows the authoring bundle or API name used when starting the session.
|
|
10
10
|
|
|
11
11
|
# flags.agent.summary
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
API name of the agent used to filter the list of available trace files. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.
|
|
14
14
|
|
|
15
15
|
# flags.session-id.summary
|
|
16
16
|
|
|
17
|
-
Session ID used to filter the list of trace files.
|
|
17
|
+
Session ID used to filter the list of trace files. Use the "agent preview sessions" CLI command to list all known agent preview sessions along with their session IDs.
|
|
18
18
|
|
|
19
19
|
# flags.since.summary
|
|
20
20
|
|
|
@@ -58,23 +58,23 @@ Path
|
|
|
58
58
|
|
|
59
59
|
# examples
|
|
60
60
|
|
|
61
|
-
- List all
|
|
61
|
+
- List all trace files for all agents and sessions:
|
|
62
62
|
|
|
63
63
|
<%= config.bin %> <%= command.id %>
|
|
64
64
|
|
|
65
|
-
- List all
|
|
65
|
+
- List all trace files for a specific agent:
|
|
66
66
|
|
|
67
67
|
<%= config.bin %> <%= command.id %> --agent My_Agent
|
|
68
68
|
|
|
69
|
-
- List
|
|
69
|
+
- List trace files for a specific session:
|
|
70
70
|
|
|
71
71
|
<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>
|
|
72
72
|
|
|
73
|
-
- List
|
|
73
|
+
- List trace files recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):
|
|
74
74
|
|
|
75
75
|
<%= config.bin %> <%= command.id %> --since 2026-04-20
|
|
76
76
|
|
|
77
|
-
- List
|
|
77
|
+
- List trace files recorded on or after a specific UTC time:
|
|
78
78
|
|
|
79
79
|
<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z
|
|
80
80
|
|