@salesforce/plugin-agent 1.37.0 → 1.38.0
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 +221 -20
- package/lib/agentSessionScanner.d.ts +12 -0
- package/lib/agentSessionScanner.js +56 -0
- package/lib/agentSessionScanner.js.map +1 -0
- package/lib/commands/agent/trace/delete.d.ts +21 -0
- package/lib/commands/agent/trace/delete.js +118 -0
- package/lib/commands/agent/trace/delete.js.map +1 -0
- package/lib/commands/agent/trace/list.d.ts +22 -0
- package/lib/commands/agent/trace/list.js +101 -0
- package/lib/commands/agent/trace/list.js.map +1 -0
- package/lib/commands/agent/trace/read.d.ts +75 -0
- package/lib/commands/agent/trace/read.js +308 -0
- package/lib/commands/agent/trace/read.js.map +1 -0
- package/messages/agent.trace.delete.md +87 -0
- package/messages/agent.trace.list.md +87 -0
- package/messages/agent.trace.read.md +171 -0
- package/oclif.manifest.json +622 -335
- package/package.json +4 -4
- package/schemas/agent-trace-delete.json +28 -0
- package/schemas/agent-trace-list.json +34 -0
- package/schemas/agent-trace-read.json +466 -0
package/oclif.manifest.json
CHANGED
|
@@ -409,6 +409,473 @@
|
|
|
409
409
|
"preview:agent"
|
|
410
410
|
]
|
|
411
411
|
},
|
|
412
|
+
"agent:preview:end": {
|
|
413
|
+
"aliases": [],
|
|
414
|
+
"args": {},
|
|
415
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
416
|
+
"examples": [
|
|
417
|
+
"End a preview session of a published agent by specifying its session ID and API name ; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
|
|
418
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
|
|
419
|
+
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent"
|
|
420
|
+
],
|
|
421
|
+
"flags": {
|
|
422
|
+
"json": {
|
|
423
|
+
"description": "Format output as json.",
|
|
424
|
+
"helpGroup": "GLOBAL",
|
|
425
|
+
"name": "json",
|
|
426
|
+
"allowNo": false,
|
|
427
|
+
"type": "boolean"
|
|
428
|
+
},
|
|
429
|
+
"flags-dir": {
|
|
430
|
+
"helpGroup": "GLOBAL",
|
|
431
|
+
"name": "flags-dir",
|
|
432
|
+
"summary": "Import flag values from a directory.",
|
|
433
|
+
"hasDynamicHelp": false,
|
|
434
|
+
"multiple": false,
|
|
435
|
+
"type": "option"
|
|
436
|
+
},
|
|
437
|
+
"target-org": {
|
|
438
|
+
"char": "o",
|
|
439
|
+
"name": "target-org",
|
|
440
|
+
"noCacheDefault": true,
|
|
441
|
+
"required": true,
|
|
442
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
443
|
+
"hasDynamicHelp": true,
|
|
444
|
+
"multiple": false,
|
|
445
|
+
"type": "option"
|
|
446
|
+
},
|
|
447
|
+
"api-version": {
|
|
448
|
+
"description": "Override the api version used for api requests made by this command",
|
|
449
|
+
"name": "api-version",
|
|
450
|
+
"hasDynamicHelp": false,
|
|
451
|
+
"multiple": false,
|
|
452
|
+
"type": "option"
|
|
453
|
+
},
|
|
454
|
+
"session-id": {
|
|
455
|
+
"name": "session-id",
|
|
456
|
+
"required": false,
|
|
457
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
458
|
+
"hasDynamicHelp": false,
|
|
459
|
+
"multiple": false,
|
|
460
|
+
"type": "option"
|
|
461
|
+
},
|
|
462
|
+
"api-name": {
|
|
463
|
+
"char": "n",
|
|
464
|
+
"name": "api-name",
|
|
465
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
466
|
+
"hasDynamicHelp": false,
|
|
467
|
+
"multiple": false,
|
|
468
|
+
"type": "option"
|
|
469
|
+
},
|
|
470
|
+
"authoring-bundle": {
|
|
471
|
+
"name": "authoring-bundle",
|
|
472
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
473
|
+
"hasDynamicHelp": false,
|
|
474
|
+
"multiple": false,
|
|
475
|
+
"type": "option"
|
|
476
|
+
}
|
|
477
|
+
},
|
|
478
|
+
"hasDynamicHelp": true,
|
|
479
|
+
"hiddenAliases": [],
|
|
480
|
+
"id": "agent:preview:end",
|
|
481
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
482
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
483
|
+
"pluginType": "core",
|
|
484
|
+
"strict": true,
|
|
485
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
486
|
+
"enableJsonFlag": true,
|
|
487
|
+
"requiresProject": true,
|
|
488
|
+
"envVariablesSection": {
|
|
489
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
490
|
+
"body": [
|
|
491
|
+
{
|
|
492
|
+
"name": "SF_TARGET_ORG",
|
|
493
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
494
|
+
}
|
|
495
|
+
]
|
|
496
|
+
},
|
|
497
|
+
"errorCodes": {
|
|
498
|
+
"header": "ERROR CODES",
|
|
499
|
+
"body": [
|
|
500
|
+
{
|
|
501
|
+
"name": "Succeeded (0)",
|
|
502
|
+
"description": "Preview session ended successfully and traces saved."
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "NotFound (2)",
|
|
506
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
"name": "PreviewEndFailed (4)",
|
|
510
|
+
"description": "Failed to end the preview session."
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "SessionAmbiguous (5)",
|
|
514
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
515
|
+
}
|
|
516
|
+
]
|
|
517
|
+
},
|
|
518
|
+
"isESM": true,
|
|
519
|
+
"relativePath": [
|
|
520
|
+
"lib",
|
|
521
|
+
"commands",
|
|
522
|
+
"agent",
|
|
523
|
+
"preview",
|
|
524
|
+
"end.js"
|
|
525
|
+
],
|
|
526
|
+
"aliasPermutations": [],
|
|
527
|
+
"permutations": [
|
|
528
|
+
"agent:preview:end",
|
|
529
|
+
"preview:agent:end",
|
|
530
|
+
"preview:end:agent",
|
|
531
|
+
"agent:end:preview",
|
|
532
|
+
"end:agent:preview",
|
|
533
|
+
"end:preview:agent"
|
|
534
|
+
]
|
|
535
|
+
},
|
|
536
|
+
"agent:preview:send": {
|
|
537
|
+
"aliases": [],
|
|
538
|
+
"args": {},
|
|
539
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
540
|
+
"examples": [
|
|
541
|
+
"Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
|
|
542
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
|
|
543
|
+
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
544
|
+
],
|
|
545
|
+
"flags": {
|
|
546
|
+
"json": {
|
|
547
|
+
"description": "Format output as json.",
|
|
548
|
+
"helpGroup": "GLOBAL",
|
|
549
|
+
"name": "json",
|
|
550
|
+
"allowNo": false,
|
|
551
|
+
"type": "boolean"
|
|
552
|
+
},
|
|
553
|
+
"flags-dir": {
|
|
554
|
+
"helpGroup": "GLOBAL",
|
|
555
|
+
"name": "flags-dir",
|
|
556
|
+
"summary": "Import flag values from a directory.",
|
|
557
|
+
"hasDynamicHelp": false,
|
|
558
|
+
"multiple": false,
|
|
559
|
+
"type": "option"
|
|
560
|
+
},
|
|
561
|
+
"target-org": {
|
|
562
|
+
"char": "o",
|
|
563
|
+
"name": "target-org",
|
|
564
|
+
"noCacheDefault": true,
|
|
565
|
+
"required": true,
|
|
566
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
567
|
+
"hasDynamicHelp": true,
|
|
568
|
+
"multiple": false,
|
|
569
|
+
"type": "option"
|
|
570
|
+
},
|
|
571
|
+
"api-version": {
|
|
572
|
+
"description": "Override the api version used for api requests made by this command",
|
|
573
|
+
"name": "api-version",
|
|
574
|
+
"hasDynamicHelp": false,
|
|
575
|
+
"multiple": false,
|
|
576
|
+
"type": "option"
|
|
577
|
+
},
|
|
578
|
+
"session-id": {
|
|
579
|
+
"name": "session-id",
|
|
580
|
+
"required": false,
|
|
581
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
582
|
+
"hasDynamicHelp": false,
|
|
583
|
+
"multiple": false,
|
|
584
|
+
"type": "option"
|
|
585
|
+
},
|
|
586
|
+
"utterance": {
|
|
587
|
+
"char": "u",
|
|
588
|
+
"name": "utterance",
|
|
589
|
+
"required": true,
|
|
590
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
591
|
+
"hasDynamicHelp": false,
|
|
592
|
+
"multiple": false,
|
|
593
|
+
"type": "option"
|
|
594
|
+
},
|
|
595
|
+
"api-name": {
|
|
596
|
+
"char": "n",
|
|
597
|
+
"name": "api-name",
|
|
598
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
599
|
+
"hasDynamicHelp": false,
|
|
600
|
+
"multiple": false,
|
|
601
|
+
"type": "option"
|
|
602
|
+
},
|
|
603
|
+
"authoring-bundle": {
|
|
604
|
+
"name": "authoring-bundle",
|
|
605
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
606
|
+
"hasDynamicHelp": false,
|
|
607
|
+
"multiple": false,
|
|
608
|
+
"type": "option"
|
|
609
|
+
}
|
|
610
|
+
},
|
|
611
|
+
"hasDynamicHelp": true,
|
|
612
|
+
"hiddenAliases": [],
|
|
613
|
+
"id": "agent:preview:send",
|
|
614
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
615
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
616
|
+
"pluginType": "core",
|
|
617
|
+
"strict": true,
|
|
618
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
619
|
+
"enableJsonFlag": true,
|
|
620
|
+
"requiresProject": true,
|
|
621
|
+
"envVariablesSection": {
|
|
622
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
623
|
+
"body": [
|
|
624
|
+
{
|
|
625
|
+
"name": "SF_TARGET_ORG",
|
|
626
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
627
|
+
}
|
|
628
|
+
]
|
|
629
|
+
},
|
|
630
|
+
"errorCodes": {
|
|
631
|
+
"header": "ERROR CODES",
|
|
632
|
+
"body": [
|
|
633
|
+
{
|
|
634
|
+
"name": "Succeeded (0)",
|
|
635
|
+
"description": "Message sent successfully and agent response received."
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "NotFound (2)",
|
|
639
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "PreviewSendFailed (4)",
|
|
643
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "SessionAmbiguous (5)",
|
|
647
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
648
|
+
}
|
|
649
|
+
]
|
|
650
|
+
},
|
|
651
|
+
"isESM": true,
|
|
652
|
+
"relativePath": [
|
|
653
|
+
"lib",
|
|
654
|
+
"commands",
|
|
655
|
+
"agent",
|
|
656
|
+
"preview",
|
|
657
|
+
"send.js"
|
|
658
|
+
],
|
|
659
|
+
"aliasPermutations": [],
|
|
660
|
+
"permutations": [
|
|
661
|
+
"agent:preview:send",
|
|
662
|
+
"preview:agent:send",
|
|
663
|
+
"preview:send:agent",
|
|
664
|
+
"agent:send:preview",
|
|
665
|
+
"send:agent:preview",
|
|
666
|
+
"send:preview:agent"
|
|
667
|
+
]
|
|
668
|
+
},
|
|
669
|
+
"agent:preview:sessions": {
|
|
670
|
+
"aliases": [],
|
|
671
|
+
"args": {},
|
|
672
|
+
"description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
|
|
673
|
+
"examples": [
|
|
674
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
675
|
+
],
|
|
676
|
+
"flags": {
|
|
677
|
+
"json": {
|
|
678
|
+
"description": "Format output as json.",
|
|
679
|
+
"helpGroup": "GLOBAL",
|
|
680
|
+
"name": "json",
|
|
681
|
+
"allowNo": false,
|
|
682
|
+
"type": "boolean"
|
|
683
|
+
},
|
|
684
|
+
"flags-dir": {
|
|
685
|
+
"helpGroup": "GLOBAL",
|
|
686
|
+
"name": "flags-dir",
|
|
687
|
+
"summary": "Import flag values from a directory.",
|
|
688
|
+
"hasDynamicHelp": false,
|
|
689
|
+
"multiple": false,
|
|
690
|
+
"type": "option"
|
|
691
|
+
}
|
|
692
|
+
},
|
|
693
|
+
"hasDynamicHelp": false,
|
|
694
|
+
"hiddenAliases": [],
|
|
695
|
+
"id": "agent:preview:sessions",
|
|
696
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
697
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
698
|
+
"pluginType": "core",
|
|
699
|
+
"strict": true,
|
|
700
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
701
|
+
"enableJsonFlag": true,
|
|
702
|
+
"requiresProject": true,
|
|
703
|
+
"errorCodes": {
|
|
704
|
+
"header": "ERROR CODES",
|
|
705
|
+
"body": [
|
|
706
|
+
{
|
|
707
|
+
"name": "Succeeded (0)",
|
|
708
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
709
|
+
}
|
|
710
|
+
]
|
|
711
|
+
},
|
|
712
|
+
"isESM": true,
|
|
713
|
+
"relativePath": [
|
|
714
|
+
"lib",
|
|
715
|
+
"commands",
|
|
716
|
+
"agent",
|
|
717
|
+
"preview",
|
|
718
|
+
"sessions.js"
|
|
719
|
+
],
|
|
720
|
+
"aliasPermutations": [],
|
|
721
|
+
"permutations": [
|
|
722
|
+
"agent:preview:sessions",
|
|
723
|
+
"preview:agent:sessions",
|
|
724
|
+
"preview:sessions:agent",
|
|
725
|
+
"agent:sessions:preview",
|
|
726
|
+
"sessions:agent:preview",
|
|
727
|
+
"sessions:preview:agent"
|
|
728
|
+
]
|
|
729
|
+
},
|
|
730
|
+
"agent:preview:start": {
|
|
731
|
+
"aliases": [],
|
|
732
|
+
"args": {},
|
|
733
|
+
"description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
|
|
734
|
+
"examples": [
|
|
735
|
+
"Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
|
|
736
|
+
"Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
|
|
737
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
738
|
+
],
|
|
739
|
+
"flags": {
|
|
740
|
+
"json": {
|
|
741
|
+
"description": "Format output as json.",
|
|
742
|
+
"helpGroup": "GLOBAL",
|
|
743
|
+
"name": "json",
|
|
744
|
+
"allowNo": false,
|
|
745
|
+
"type": "boolean"
|
|
746
|
+
},
|
|
747
|
+
"flags-dir": {
|
|
748
|
+
"helpGroup": "GLOBAL",
|
|
749
|
+
"name": "flags-dir",
|
|
750
|
+
"summary": "Import flag values from a directory.",
|
|
751
|
+
"hasDynamicHelp": false,
|
|
752
|
+
"multiple": false,
|
|
753
|
+
"type": "option"
|
|
754
|
+
},
|
|
755
|
+
"target-org": {
|
|
756
|
+
"char": "o",
|
|
757
|
+
"name": "target-org",
|
|
758
|
+
"noCacheDefault": true,
|
|
759
|
+
"required": true,
|
|
760
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
761
|
+
"hasDynamicHelp": true,
|
|
762
|
+
"multiple": false,
|
|
763
|
+
"type": "option"
|
|
764
|
+
},
|
|
765
|
+
"api-version": {
|
|
766
|
+
"description": "Override the api version used for api requests made by this command",
|
|
767
|
+
"name": "api-version",
|
|
768
|
+
"hasDynamicHelp": false,
|
|
769
|
+
"multiple": false,
|
|
770
|
+
"type": "option"
|
|
771
|
+
},
|
|
772
|
+
"api-name": {
|
|
773
|
+
"char": "n",
|
|
774
|
+
"name": "api-name",
|
|
775
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
776
|
+
"hasDynamicHelp": false,
|
|
777
|
+
"multiple": false,
|
|
778
|
+
"type": "option"
|
|
779
|
+
},
|
|
780
|
+
"authoring-bundle": {
|
|
781
|
+
"name": "authoring-bundle",
|
|
782
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
783
|
+
"hasDynamicHelp": false,
|
|
784
|
+
"multiple": false,
|
|
785
|
+
"type": "option"
|
|
786
|
+
},
|
|
787
|
+
"use-live-actions": {
|
|
788
|
+
"exclusive": [
|
|
789
|
+
"simulate-actions"
|
|
790
|
+
],
|
|
791
|
+
"name": "use-live-actions",
|
|
792
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
793
|
+
"allowNo": false,
|
|
794
|
+
"type": "boolean"
|
|
795
|
+
},
|
|
796
|
+
"simulate-actions": {
|
|
797
|
+
"exclusive": [
|
|
798
|
+
"use-live-actions"
|
|
799
|
+
],
|
|
800
|
+
"name": "simulate-actions",
|
|
801
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
802
|
+
"allowNo": false,
|
|
803
|
+
"type": "boolean"
|
|
804
|
+
},
|
|
805
|
+
"agent-json": {
|
|
806
|
+
"dependsOn": [
|
|
807
|
+
"authoring-bundle"
|
|
808
|
+
],
|
|
809
|
+
"hidden": true,
|
|
810
|
+
"name": "agent-json",
|
|
811
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
812
|
+
"hasDynamicHelp": false,
|
|
813
|
+
"multiple": false,
|
|
814
|
+
"type": "option"
|
|
815
|
+
}
|
|
816
|
+
},
|
|
817
|
+
"hasDynamicHelp": true,
|
|
818
|
+
"hiddenAliases": [],
|
|
819
|
+
"id": "agent:preview:start",
|
|
820
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
821
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
822
|
+
"pluginType": "core",
|
|
823
|
+
"strict": true,
|
|
824
|
+
"summary": "Start a programmatic agent preview session.",
|
|
825
|
+
"enableJsonFlag": true,
|
|
826
|
+
"requiresProject": true,
|
|
827
|
+
"envVariablesSection": {
|
|
828
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
829
|
+
"body": [
|
|
830
|
+
{
|
|
831
|
+
"name": "SF_TARGET_ORG",
|
|
832
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
833
|
+
}
|
|
834
|
+
]
|
|
835
|
+
},
|
|
836
|
+
"errorCodes": {
|
|
837
|
+
"header": "ERROR CODES",
|
|
838
|
+
"body": [
|
|
839
|
+
{
|
|
840
|
+
"name": "Succeeded (0)",
|
|
841
|
+
"description": "Preview session started successfully."
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
"name": "Failed (1)",
|
|
845
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
"name": "NotFound (2)",
|
|
849
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
"name": "ServerError (3)",
|
|
853
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
854
|
+
},
|
|
855
|
+
{
|
|
856
|
+
"name": "PreviewStartFailed (4)",
|
|
857
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
858
|
+
}
|
|
859
|
+
]
|
|
860
|
+
},
|
|
861
|
+
"isESM": true,
|
|
862
|
+
"relativePath": [
|
|
863
|
+
"lib",
|
|
864
|
+
"commands",
|
|
865
|
+
"agent",
|
|
866
|
+
"preview",
|
|
867
|
+
"start.js"
|
|
868
|
+
],
|
|
869
|
+
"aliasPermutations": [],
|
|
870
|
+
"permutations": [
|
|
871
|
+
"agent:preview:start",
|
|
872
|
+
"preview:agent:start",
|
|
873
|
+
"preview:start:agent",
|
|
874
|
+
"agent:start:preview",
|
|
875
|
+
"start:agent:preview",
|
|
876
|
+
"start:preview:agent"
|
|
877
|
+
]
|
|
878
|
+
},
|
|
412
879
|
"agent:generate:agent-spec": {
|
|
413
880
|
"aliases": [],
|
|
414
881
|
"args": {},
|
|
@@ -1764,157 +2231,33 @@
|
|
|
1764
2231
|
},
|
|
1765
2232
|
"test-runner": {
|
|
1766
2233
|
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
1767
|
-
"name": "test-runner",
|
|
1768
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
1769
|
-
"hasDynamicHelp": false,
|
|
1770
|
-
"multiple": false,
|
|
1771
|
-
"options": [
|
|
1772
|
-
"agentforce-studio",
|
|
1773
|
-
"testing-center"
|
|
1774
|
-
],
|
|
1775
|
-
"type": "option"
|
|
1776
|
-
},
|
|
1777
|
-
"verbose": {
|
|
1778
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
1779
|
-
"name": "verbose",
|
|
1780
|
-
"summary": "Show generated data in the test results output.",
|
|
1781
|
-
"allowNo": false,
|
|
1782
|
-
"type": "boolean"
|
|
1783
|
-
}
|
|
1784
|
-
},
|
|
1785
|
-
"hasDynamicHelp": true,
|
|
1786
|
-
"hiddenAliases": [],
|
|
1787
|
-
"id": "agent:test:run",
|
|
1788
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1789
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1790
|
-
"pluginType": "core",
|
|
1791
|
-
"strict": true,
|
|
1792
|
-
"summary": "Start an agent test in your org.",
|
|
1793
|
-
"enableJsonFlag": true,
|
|
1794
|
-
"envVariablesSection": {
|
|
1795
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1796
|
-
"body": [
|
|
1797
|
-
{
|
|
1798
|
-
"name": "SF_TARGET_ORG",
|
|
1799
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1800
|
-
}
|
|
1801
|
-
]
|
|
1802
|
-
},
|
|
1803
|
-
"errorCodes": {
|
|
1804
|
-
"header": "ERROR CODES",
|
|
1805
|
-
"body": [
|
|
1806
|
-
{
|
|
1807
|
-
"name": "Succeeded (0)",
|
|
1808
|
-
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
1809
|
-
},
|
|
1810
|
-
{
|
|
1811
|
-
"name": "Failed (1)",
|
|
1812
|
-
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
1813
|
-
},
|
|
1814
|
-
{
|
|
1815
|
-
"name": "NotFound (2)",
|
|
1816
|
-
"description": "Test definition not found or invalid test name."
|
|
1817
|
-
},
|
|
1818
|
-
{
|
|
1819
|
-
"name": "OperationFailed (4)",
|
|
1820
|
-
"description": "Failed to start or poll test due to API or network errors."
|
|
1821
|
-
}
|
|
1822
|
-
]
|
|
1823
|
-
},
|
|
1824
|
-
"isESM": true,
|
|
1825
|
-
"relativePath": [
|
|
1826
|
-
"lib",
|
|
1827
|
-
"commands",
|
|
1828
|
-
"agent",
|
|
1829
|
-
"test",
|
|
1830
|
-
"run.js"
|
|
1831
|
-
],
|
|
1832
|
-
"aliasPermutations": [],
|
|
1833
|
-
"permutations": [
|
|
1834
|
-
"agent:test:run",
|
|
1835
|
-
"test:agent:run",
|
|
1836
|
-
"test:run:agent",
|
|
1837
|
-
"agent:run:test",
|
|
1838
|
-
"run:agent:test",
|
|
1839
|
-
"run:test:agent"
|
|
1840
|
-
]
|
|
1841
|
-
},
|
|
1842
|
-
"agent:preview:end": {
|
|
1843
|
-
"aliases": [],
|
|
1844
|
-
"args": {},
|
|
1845
|
-
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
1846
|
-
"examples": [
|
|
1847
|
-
"End a preview session of a published agent by specifying its session ID and API name ; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
|
|
1848
|
-
"Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
|
|
1849
|
-
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent"
|
|
1850
|
-
],
|
|
1851
|
-
"flags": {
|
|
1852
|
-
"json": {
|
|
1853
|
-
"description": "Format output as json.",
|
|
1854
|
-
"helpGroup": "GLOBAL",
|
|
1855
|
-
"name": "json",
|
|
1856
|
-
"allowNo": false,
|
|
1857
|
-
"type": "boolean"
|
|
1858
|
-
},
|
|
1859
|
-
"flags-dir": {
|
|
1860
|
-
"helpGroup": "GLOBAL",
|
|
1861
|
-
"name": "flags-dir",
|
|
1862
|
-
"summary": "Import flag values from a directory.",
|
|
1863
|
-
"hasDynamicHelp": false,
|
|
1864
|
-
"multiple": false,
|
|
1865
|
-
"type": "option"
|
|
1866
|
-
},
|
|
1867
|
-
"target-org": {
|
|
1868
|
-
"char": "o",
|
|
1869
|
-
"name": "target-org",
|
|
1870
|
-
"noCacheDefault": true,
|
|
1871
|
-
"required": true,
|
|
1872
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1873
|
-
"hasDynamicHelp": true,
|
|
1874
|
-
"multiple": false,
|
|
1875
|
-
"type": "option"
|
|
1876
|
-
},
|
|
1877
|
-
"api-version": {
|
|
1878
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1879
|
-
"name": "api-version",
|
|
1880
|
-
"hasDynamicHelp": false,
|
|
1881
|
-
"multiple": false,
|
|
1882
|
-
"type": "option"
|
|
1883
|
-
},
|
|
1884
|
-
"session-id": {
|
|
1885
|
-
"name": "session-id",
|
|
1886
|
-
"required": false,
|
|
1887
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
1888
|
-
"hasDynamicHelp": false,
|
|
1889
|
-
"multiple": false,
|
|
1890
|
-
"type": "option"
|
|
1891
|
-
},
|
|
1892
|
-
"api-name": {
|
|
1893
|
-
"char": "n",
|
|
1894
|
-
"name": "api-name",
|
|
1895
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1896
|
-
"hasDynamicHelp": false,
|
|
1897
|
-
"multiple": false,
|
|
1898
|
-
"type": "option"
|
|
1899
|
-
},
|
|
1900
|
-
"authoring-bundle": {
|
|
1901
|
-
"name": "authoring-bundle",
|
|
1902
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2234
|
+
"name": "test-runner",
|
|
2235
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
1903
2236
|
"hasDynamicHelp": false,
|
|
1904
2237
|
"multiple": false,
|
|
2238
|
+
"options": [
|
|
2239
|
+
"agentforce-studio",
|
|
2240
|
+
"testing-center"
|
|
2241
|
+
],
|
|
1905
2242
|
"type": "option"
|
|
2243
|
+
},
|
|
2244
|
+
"verbose": {
|
|
2245
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
2246
|
+
"name": "verbose",
|
|
2247
|
+
"summary": "Show generated data in the test results output.",
|
|
2248
|
+
"allowNo": false,
|
|
2249
|
+
"type": "boolean"
|
|
1906
2250
|
}
|
|
1907
2251
|
},
|
|
1908
2252
|
"hasDynamicHelp": true,
|
|
1909
2253
|
"hiddenAliases": [],
|
|
1910
|
-
"id": "agent:
|
|
2254
|
+
"id": "agent:test:run",
|
|
1911
2255
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1912
2256
|
"pluginName": "@salesforce/plugin-agent",
|
|
1913
2257
|
"pluginType": "core",
|
|
1914
2258
|
"strict": true,
|
|
1915
|
-
"summary": "
|
|
2259
|
+
"summary": "Start an agent test in your org.",
|
|
1916
2260
|
"enableJsonFlag": true,
|
|
1917
|
-
"requiresProject": true,
|
|
1918
2261
|
"envVariablesSection": {
|
|
1919
2262
|
"header": "ENVIRONMENT VARIABLES",
|
|
1920
2263
|
"body": [
|
|
@@ -1929,19 +2272,19 @@
|
|
|
1929
2272
|
"body": [
|
|
1930
2273
|
{
|
|
1931
2274
|
"name": "Succeeded (0)",
|
|
1932
|
-
"description": "
|
|
2275
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
1933
2276
|
},
|
|
1934
2277
|
{
|
|
1935
|
-
"name": "
|
|
1936
|
-
"description": "
|
|
2278
|
+
"name": "Failed (1)",
|
|
2279
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
1937
2280
|
},
|
|
1938
2281
|
{
|
|
1939
|
-
"name": "
|
|
1940
|
-
"description": "
|
|
2282
|
+
"name": "NotFound (2)",
|
|
2283
|
+
"description": "Test definition not found or invalid test name."
|
|
1941
2284
|
},
|
|
1942
2285
|
{
|
|
1943
|
-
"name": "
|
|
1944
|
-
"description": "
|
|
2286
|
+
"name": "OperationFailed (4)",
|
|
2287
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
1945
2288
|
}
|
|
1946
2289
|
]
|
|
1947
2290
|
},
|
|
@@ -1950,27 +2293,30 @@
|
|
|
1950
2293
|
"lib",
|
|
1951
2294
|
"commands",
|
|
1952
2295
|
"agent",
|
|
1953
|
-
"
|
|
1954
|
-
"
|
|
2296
|
+
"test",
|
|
2297
|
+
"run.js"
|
|
1955
2298
|
],
|
|
1956
2299
|
"aliasPermutations": [],
|
|
1957
2300
|
"permutations": [
|
|
1958
|
-
"agent:
|
|
1959
|
-
"
|
|
1960
|
-
"
|
|
1961
|
-
"agent:
|
|
1962
|
-
"
|
|
1963
|
-
"
|
|
2301
|
+
"agent:test:run",
|
|
2302
|
+
"test:agent:run",
|
|
2303
|
+
"test:run:agent",
|
|
2304
|
+
"agent:run:test",
|
|
2305
|
+
"run:agent:test",
|
|
2306
|
+
"run:test:agent"
|
|
1964
2307
|
]
|
|
1965
2308
|
},
|
|
1966
|
-
"agent:
|
|
2309
|
+
"agent:trace:delete": {
|
|
1967
2310
|
"aliases": [],
|
|
1968
2311
|
"args": {},
|
|
1969
|
-
"description": "
|
|
2312
|
+
"description": "Deletes trace files recorded during agent preview sessions. By default, shows a preview of what will be deleted and prompts for confirmation. Use --no-prompt to skip confirmation.\n\nWithout filters, deletes all traces for all agents and sessions. Use flags to narrow the scope: filter by agent name (--agent), by session (--session-id), or by age (--older-than).",
|
|
1970
2313
|
"examples": [
|
|
1971
|
-
"
|
|
1972
|
-
"
|
|
1973
|
-
"
|
|
2314
|
+
"Delete all traces for all agents and sessions (with confirmation prompt):\n<%= config.bin %> <%= command.id %>",
|
|
2315
|
+
"Delete all traces for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
2316
|
+
"Delete traces from a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2317
|
+
"Delete traces older than 7 days:\n<%= config.bin %> <%= command.id %> --older-than 7d",
|
|
2318
|
+
"Delete traces older than 24 hours for a specific agent, no prompt:\n<%= config.bin %> <%= command.id %> --agent My_Agent --older-than 24h --no-prompt",
|
|
2319
|
+
"Delete all traces without confirmation:\n<%= config.bin %> <%= command.id %> --no-prompt"
|
|
1974
2320
|
],
|
|
1975
2321
|
"flags": {
|
|
1976
2322
|
"json": {
|
|
@@ -1988,93 +2334,51 @@
|
|
|
1988
2334
|
"multiple": false,
|
|
1989
2335
|
"type": "option"
|
|
1990
2336
|
},
|
|
1991
|
-
"
|
|
1992
|
-
"char": "
|
|
1993
|
-
"name": "
|
|
1994
|
-
"
|
|
1995
|
-
"required": true,
|
|
1996
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1997
|
-
"hasDynamicHelp": true,
|
|
1998
|
-
"multiple": false,
|
|
1999
|
-
"type": "option"
|
|
2000
|
-
},
|
|
2001
|
-
"api-version": {
|
|
2002
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2003
|
-
"name": "api-version",
|
|
2337
|
+
"agent": {
|
|
2338
|
+
"char": "a",
|
|
2339
|
+
"name": "agent",
|
|
2340
|
+
"summary": "Only delete traces for this agent name (substring match). Matches against the name used when starting the session, whether that's an authoring bundle or a published agent API name.",
|
|
2004
2341
|
"hasDynamicHelp": false,
|
|
2005
2342
|
"multiple": false,
|
|
2006
2343
|
"type": "option"
|
|
2007
2344
|
},
|
|
2008
2345
|
"session-id": {
|
|
2009
2346
|
"name": "session-id",
|
|
2010
|
-
"
|
|
2011
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
2012
|
-
"hasDynamicHelp": false,
|
|
2013
|
-
"multiple": false,
|
|
2014
|
-
"type": "option"
|
|
2015
|
-
},
|
|
2016
|
-
"utterance": {
|
|
2017
|
-
"char": "u",
|
|
2018
|
-
"name": "utterance",
|
|
2019
|
-
"required": true,
|
|
2020
|
-
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
2347
|
+
"summary": "Only delete traces from this session ID.",
|
|
2021
2348
|
"hasDynamicHelp": false,
|
|
2022
2349
|
"multiple": false,
|
|
2023
2350
|
"type": "option"
|
|
2024
2351
|
},
|
|
2025
|
-
"
|
|
2026
|
-
"
|
|
2027
|
-
"
|
|
2028
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2352
|
+
"older-than": {
|
|
2353
|
+
"name": "older-than",
|
|
2354
|
+
"summary": "Only delete traces older than this duration. Accepts a number followed by a unit: m/minutes, h/hours, d/days, w/weeks (e.g. 7d, 24h, 2w).",
|
|
2029
2355
|
"hasDynamicHelp": false,
|
|
2030
2356
|
"multiple": false,
|
|
2031
2357
|
"type": "option"
|
|
2032
2358
|
},
|
|
2033
|
-
"
|
|
2034
|
-
"name": "
|
|
2035
|
-
"summary": "
|
|
2036
|
-
"
|
|
2037
|
-
"
|
|
2038
|
-
"type": "option"
|
|
2359
|
+
"no-prompt": {
|
|
2360
|
+
"name": "no-prompt",
|
|
2361
|
+
"summary": "Skip the confirmation prompt and delete immediately.",
|
|
2362
|
+
"allowNo": false,
|
|
2363
|
+
"type": "boolean"
|
|
2039
2364
|
}
|
|
2040
2365
|
},
|
|
2041
|
-
"hasDynamicHelp":
|
|
2366
|
+
"hasDynamicHelp": false,
|
|
2042
2367
|
"hiddenAliases": [],
|
|
2043
|
-
"id": "agent:
|
|
2368
|
+
"id": "agent:trace:delete",
|
|
2044
2369
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2045
2370
|
"pluginName": "@salesforce/plugin-agent",
|
|
2046
2371
|
"pluginType": "core",
|
|
2047
2372
|
"strict": true,
|
|
2048
|
-
"summary": "
|
|
2373
|
+
"summary": "Delete agent preview trace files.",
|
|
2049
2374
|
"enableJsonFlag": true,
|
|
2050
2375
|
"requiresProject": true,
|
|
2051
|
-
"envVariablesSection": {
|
|
2052
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2053
|
-
"body": [
|
|
2054
|
-
{
|
|
2055
|
-
"name": "SF_TARGET_ORG",
|
|
2056
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2057
|
-
}
|
|
2058
|
-
]
|
|
2059
|
-
},
|
|
2060
2376
|
"errorCodes": {
|
|
2061
2377
|
"header": "ERROR CODES",
|
|
2062
2378
|
"body": [
|
|
2063
2379
|
{
|
|
2064
2380
|
"name": "Succeeded (0)",
|
|
2065
|
-
"description": "
|
|
2066
|
-
},
|
|
2067
|
-
{
|
|
2068
|
-
"name": "NotFound (2)",
|
|
2069
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2070
|
-
},
|
|
2071
|
-
{
|
|
2072
|
-
"name": "PreviewSendFailed (4)",
|
|
2073
|
-
"description": "Failed to send message or receive response from the preview session."
|
|
2074
|
-
},
|
|
2075
|
-
{
|
|
2076
|
-
"name": "SessionAmbiguous (5)",
|
|
2077
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2381
|
+
"description": "Traces deleted successfully (or no traces matched)."
|
|
2078
2382
|
}
|
|
2079
2383
|
]
|
|
2080
2384
|
},
|
|
@@ -2083,25 +2387,31 @@
|
|
|
2083
2387
|
"lib",
|
|
2084
2388
|
"commands",
|
|
2085
2389
|
"agent",
|
|
2086
|
-
"
|
|
2087
|
-
"
|
|
2390
|
+
"trace",
|
|
2391
|
+
"delete.js"
|
|
2088
2392
|
],
|
|
2089
2393
|
"aliasPermutations": [],
|
|
2090
2394
|
"permutations": [
|
|
2091
|
-
"agent:
|
|
2092
|
-
"
|
|
2093
|
-
"
|
|
2094
|
-
"agent:
|
|
2095
|
-
"
|
|
2096
|
-
"
|
|
2395
|
+
"agent:trace:delete",
|
|
2396
|
+
"trace:agent:delete",
|
|
2397
|
+
"trace:delete:agent",
|
|
2398
|
+
"agent:delete:trace",
|
|
2399
|
+
"delete:agent:trace",
|
|
2400
|
+
"delete:trace:agent"
|
|
2097
2401
|
]
|
|
2098
2402
|
},
|
|
2099
|
-
"agent:
|
|
2403
|
+
"agent:trace:list": {
|
|
2100
2404
|
"aliases": [],
|
|
2101
2405
|
"args": {},
|
|
2102
|
-
"description": "
|
|
2406
|
+
"description": "Lists trace files recorded during agent preview sessions. By default, lists all traces 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).\n\nEach 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.",
|
|
2103
2407
|
"examples": [
|
|
2104
|
-
"List all
|
|
2408
|
+
"List all traces for all agents and sessions:\n<%= config.bin %> <%= command.id %>",
|
|
2409
|
+
"List all traces for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
2410
|
+
"List traces for a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2411
|
+
"List traces recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):\n<%= config.bin %> <%= command.id %> --since 2026-04-20",
|
|
2412
|
+
"List traces recorded on or after a specific UTC time:\n<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z",
|
|
2413
|
+
"Filter by agent and date together:\n<%= config.bin %> <%= command.id %> --agent My_Agent --since 2026-04-20",
|
|
2414
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --json"
|
|
2105
2415
|
],
|
|
2106
2416
|
"flags": {
|
|
2107
2417
|
"json": {
|
|
@@ -2118,16 +2428,39 @@
|
|
|
2118
2428
|
"hasDynamicHelp": false,
|
|
2119
2429
|
"multiple": false,
|
|
2120
2430
|
"type": "option"
|
|
2431
|
+
},
|
|
2432
|
+
"session-id": {
|
|
2433
|
+
"name": "session-id",
|
|
2434
|
+
"summary": "Session ID used to filter the list of trace files.",
|
|
2435
|
+
"hasDynamicHelp": false,
|
|
2436
|
+
"multiple": false,
|
|
2437
|
+
"type": "option"
|
|
2438
|
+
},
|
|
2439
|
+
"agent": {
|
|
2440
|
+
"char": "a",
|
|
2441
|
+
"name": "agent",
|
|
2442
|
+
"summary": "Only show traces for this agent name (substring match). Matches against the name used when starting the session, whether that's an authoring bundle or a published agent API name.",
|
|
2443
|
+
"hasDynamicHelp": false,
|
|
2444
|
+
"multiple": false,
|
|
2445
|
+
"type": "option"
|
|
2446
|
+
},
|
|
2447
|
+
"since": {
|
|
2448
|
+
"description": "Accepts ISO 8601 format: date-only (2026-04-20), date-time (2026-04-20T14:00:00Z), or date-time with milliseconds (2026-04-20T14:00:00.000Z). The \"Recorded At\" values shown in the table output are valid inputs.",
|
|
2449
|
+
"name": "since",
|
|
2450
|
+
"summary": "Date used to filter the list of trace files; only those recorded on or after the date are listed.",
|
|
2451
|
+
"hasDynamicHelp": false,
|
|
2452
|
+
"multiple": false,
|
|
2453
|
+
"type": "option"
|
|
2121
2454
|
}
|
|
2122
2455
|
},
|
|
2123
2456
|
"hasDynamicHelp": false,
|
|
2124
2457
|
"hiddenAliases": [],
|
|
2125
|
-
"id": "agent:
|
|
2458
|
+
"id": "agent:trace:list",
|
|
2126
2459
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2127
2460
|
"pluginName": "@salesforce/plugin-agent",
|
|
2128
2461
|
"pluginType": "core",
|
|
2129
2462
|
"strict": true,
|
|
2130
|
-
"summary": "List
|
|
2463
|
+
"summary": "List the trace files that were recorded during all agent preview sessions.",
|
|
2131
2464
|
"enableJsonFlag": true,
|
|
2132
2465
|
"requiresProject": true,
|
|
2133
2466
|
"errorCodes": {
|
|
@@ -2135,7 +2468,7 @@
|
|
|
2135
2468
|
"body": [
|
|
2136
2469
|
{
|
|
2137
2470
|
"name": "Succeeded (0)",
|
|
2138
|
-
"description": "
|
|
2471
|
+
"description": "Trace files listed successfully (or empty list if none found)."
|
|
2139
2472
|
}
|
|
2140
2473
|
]
|
|
2141
2474
|
},
|
|
@@ -2144,27 +2477,31 @@
|
|
|
2144
2477
|
"lib",
|
|
2145
2478
|
"commands",
|
|
2146
2479
|
"agent",
|
|
2147
|
-
"
|
|
2148
|
-
"
|
|
2480
|
+
"trace",
|
|
2481
|
+
"list.js"
|
|
2149
2482
|
],
|
|
2150
2483
|
"aliasPermutations": [],
|
|
2151
2484
|
"permutations": [
|
|
2152
|
-
"agent:
|
|
2153
|
-
"
|
|
2154
|
-
"
|
|
2155
|
-
"agent:
|
|
2156
|
-
"
|
|
2157
|
-
"
|
|
2485
|
+
"agent:trace:list",
|
|
2486
|
+
"trace:agent:list",
|
|
2487
|
+
"trace:list:agent",
|
|
2488
|
+
"agent:list:trace",
|
|
2489
|
+
"list:agent:trace",
|
|
2490
|
+
"list:trace:agent"
|
|
2158
2491
|
]
|
|
2159
2492
|
},
|
|
2160
|
-
"agent:
|
|
2493
|
+
"agent:trace:read": {
|
|
2161
2494
|
"aliases": [],
|
|
2162
2495
|
"args": {},
|
|
2163
|
-
"description": "
|
|
2496
|
+
"description": "Reads trace files recorded during an agent preview session and outputs them in one of three formats.\n\n**--format summary** (default): A per-turn narrative showing topic routing, actions executed, and the agent's response. Use this to quickly understand what happened in a session.\n\n**--format detail**: Diagnostic drill-down into a specific dimension (--dimension required). Filters output to only the trace steps relevant to that dimension, minimizing noise.\n\n**--format raw**: Unprocessed trace JSON. Use this as a fallback when the trace schema has changed or you need to perform custom analysis.\n\nAvailable dimensions for --format detail: actions, grounding, routing, errors.\n\nUse --turn N to scope output to a single conversation turn.",
|
|
2164
2497
|
"examples": [
|
|
2165
|
-
"
|
|
2166
|
-
"
|
|
2167
|
-
"
|
|
2498
|
+
"Show a session summary (all turns):\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2499
|
+
"Show summary for a single turn:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --turn 2",
|
|
2500
|
+
"Drill into action execution across all turns:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension actions",
|
|
2501
|
+
"Drill into routing decisions for a specific turn:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension routing --turn 1",
|
|
2502
|
+
"Show all errors across the session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension errors",
|
|
2503
|
+
"Output raw trace JSON for custom parsing:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format raw",
|
|
2504
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --json"
|
|
2168
2505
|
],
|
|
2169
2506
|
"flags": {
|
|
2170
2507
|
"json": {
|
|
@@ -2182,128 +2519,78 @@
|
|
|
2182
2519
|
"multiple": false,
|
|
2183
2520
|
"type": "option"
|
|
2184
2521
|
},
|
|
2185
|
-
"
|
|
2186
|
-
"char": "
|
|
2187
|
-
"name": "
|
|
2188
|
-
"noCacheDefault": true,
|
|
2522
|
+
"session-id": {
|
|
2523
|
+
"char": "s",
|
|
2524
|
+
"name": "session-id",
|
|
2189
2525
|
"required": true,
|
|
2190
|
-
"summary": "
|
|
2191
|
-
"hasDynamicHelp": true,
|
|
2192
|
-
"multiple": false,
|
|
2193
|
-
"type": "option"
|
|
2194
|
-
},
|
|
2195
|
-
"api-version": {
|
|
2196
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2197
|
-
"name": "api-version",
|
|
2526
|
+
"summary": "Session ID to read traces for.",
|
|
2198
2527
|
"hasDynamicHelp": false,
|
|
2199
2528
|
"multiple": false,
|
|
2200
2529
|
"type": "option"
|
|
2201
2530
|
},
|
|
2202
|
-
"
|
|
2203
|
-
"char": "
|
|
2204
|
-
"name": "
|
|
2205
|
-
"summary": "
|
|
2531
|
+
"format": {
|
|
2532
|
+
"char": "f",
|
|
2533
|
+
"name": "format",
|
|
2534
|
+
"summary": "Output format: summary (default), detail, or raw. Use detail with --dimension to drill into a specific aspect of the trace.",
|
|
2535
|
+
"default": "summary",
|
|
2206
2536
|
"hasDynamicHelp": false,
|
|
2207
2537
|
"multiple": false,
|
|
2538
|
+
"options": [
|
|
2539
|
+
"summary",
|
|
2540
|
+
"detail",
|
|
2541
|
+
"raw"
|
|
2542
|
+
],
|
|
2208
2543
|
"type": "option"
|
|
2209
2544
|
},
|
|
2210
|
-
"
|
|
2211
|
-
"
|
|
2212
|
-
"
|
|
2545
|
+
"dimension": {
|
|
2546
|
+
"char": "d",
|
|
2547
|
+
"name": "dimension",
|
|
2548
|
+
"summary": "Dimension to drill into when using --format detail. One of: actions, grounding, routing, errors. Required when --format is detail.",
|
|
2213
2549
|
"hasDynamicHelp": false,
|
|
2214
2550
|
"multiple": false,
|
|
2215
|
-
"
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
"
|
|
2220
|
-
],
|
|
2221
|
-
"name": "use-live-actions",
|
|
2222
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2223
|
-
"allowNo": false,
|
|
2224
|
-
"type": "boolean"
|
|
2225
|
-
},
|
|
2226
|
-
"simulate-actions": {
|
|
2227
|
-
"exclusive": [
|
|
2228
|
-
"use-live-actions"
|
|
2551
|
+
"options": [
|
|
2552
|
+
"actions",
|
|
2553
|
+
"grounding",
|
|
2554
|
+
"routing",
|
|
2555
|
+
"errors"
|
|
2229
2556
|
],
|
|
2230
|
-
"
|
|
2231
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2232
|
-
"allowNo": false,
|
|
2233
|
-
"type": "boolean"
|
|
2557
|
+
"type": "option"
|
|
2234
2558
|
},
|
|
2235
|
-
"
|
|
2236
|
-
"
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
"hidden": true,
|
|
2240
|
-
"name": "agent-json",
|
|
2241
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2559
|
+
"turn": {
|
|
2560
|
+
"char": "t",
|
|
2561
|
+
"name": "turn",
|
|
2562
|
+
"summary": "Scope output to this conversation turn number.",
|
|
2242
2563
|
"hasDynamicHelp": false,
|
|
2243
2564
|
"multiple": false,
|
|
2244
2565
|
"type": "option"
|
|
2245
2566
|
}
|
|
2246
2567
|
},
|
|
2247
|
-
"hasDynamicHelp":
|
|
2568
|
+
"hasDynamicHelp": false,
|
|
2248
2569
|
"hiddenAliases": [],
|
|
2249
|
-
"id": "agent:
|
|
2570
|
+
"id": "agent:trace:read",
|
|
2250
2571
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2251
2572
|
"pluginName": "@salesforce/plugin-agent",
|
|
2252
2573
|
"pluginType": "core",
|
|
2253
2574
|
"strict": true,
|
|
2254
|
-
"summary": "
|
|
2575
|
+
"summary": "Read and analyze trace files from an agent preview session.",
|
|
2255
2576
|
"enableJsonFlag": true,
|
|
2256
2577
|
"requiresProject": true,
|
|
2257
|
-
"envVariablesSection": {
|
|
2258
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2259
|
-
"body": [
|
|
2260
|
-
{
|
|
2261
|
-
"name": "SF_TARGET_ORG",
|
|
2262
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2263
|
-
}
|
|
2264
|
-
]
|
|
2265
|
-
},
|
|
2266
|
-
"errorCodes": {
|
|
2267
|
-
"header": "ERROR CODES",
|
|
2268
|
-
"body": [
|
|
2269
|
-
{
|
|
2270
|
-
"name": "Succeeded (0)",
|
|
2271
|
-
"description": "Preview session started successfully."
|
|
2272
|
-
},
|
|
2273
|
-
{
|
|
2274
|
-
"name": "Failed (1)",
|
|
2275
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2276
|
-
},
|
|
2277
|
-
{
|
|
2278
|
-
"name": "NotFound (2)",
|
|
2279
|
-
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2280
|
-
},
|
|
2281
|
-
{
|
|
2282
|
-
"name": "ServerError (3)",
|
|
2283
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2284
|
-
},
|
|
2285
|
-
{
|
|
2286
|
-
"name": "PreviewStartFailed (4)",
|
|
2287
|
-
"description": "Preview session failed to start due to API or network errors."
|
|
2288
|
-
}
|
|
2289
|
-
]
|
|
2290
|
-
},
|
|
2291
2578
|
"isESM": true,
|
|
2292
2579
|
"relativePath": [
|
|
2293
2580
|
"lib",
|
|
2294
2581
|
"commands",
|
|
2295
2582
|
"agent",
|
|
2296
|
-
"
|
|
2297
|
-
"
|
|
2583
|
+
"trace",
|
|
2584
|
+
"read.js"
|
|
2298
2585
|
],
|
|
2299
2586
|
"aliasPermutations": [],
|
|
2300
2587
|
"permutations": [
|
|
2301
|
-
"agent:
|
|
2302
|
-
"
|
|
2303
|
-
"
|
|
2304
|
-
"agent:
|
|
2305
|
-
"
|
|
2306
|
-
"
|
|
2588
|
+
"agent:trace:read",
|
|
2589
|
+
"trace:agent:read",
|
|
2590
|
+
"trace:read:agent",
|
|
2591
|
+
"agent:read:trace",
|
|
2592
|
+
"read:agent:trace",
|
|
2593
|
+
"read:trace:agent"
|
|
2307
2594
|
]
|
|
2308
2595
|
},
|
|
2309
2596
|
"agent:validate:authoring-bundle": {
|
|
@@ -2421,5 +2708,5 @@
|
|
|
2421
2708
|
]
|
|
2422
2709
|
}
|
|
2423
2710
|
},
|
|
2424
|
-
"version": "1.
|
|
2711
|
+
"version": "1.38.0"
|
|
2425
2712
|
}
|