@salesforce/plugin-agent 1.32.9 → 1.32.11
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 +49 -35
- package/lib/commands/agent/generate/template.d.ts +45 -2
- package/lib/commands/agent/generate/template.js +257 -8
- package/lib/commands/agent/generate/template.js.map +1 -1
- package/messages/agent.generate.template.md +50 -9
- package/oclif.manifest.json +458 -440
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -657,9 +657,9 @@
|
|
|
657
657
|
"agent:generate:template": {
|
|
658
658
|
"aliases": [],
|
|
659
659
|
"args": {},
|
|
660
|
-
"description": "
|
|
660
|
+
"description": "WARNING: This command doesn't work for agents that were created from an Agent Script file. In other words, you can't currently package an agent template for agents that use Agent Script.\n\nAt a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate metadata file for a specific agent (Bot). You then use the BotTemplate metadata file, along with the GenAiPlannerBundle metadata file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion metadata file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate metadata file is generated in the \"botTemplates\" directory in the output directory specified with the --output-dir flag, and has the name <Agent_API_name>\\_v<Version>\\_Template.botTemplate-meta.xml, such as my-package/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.\n\nSee \"Develop and Package Agent Templates Using Scratch Orgs\" (https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/dev2gp_package_agent_templates.htm) for details about the complete process, which includes using a scratch org to create and test the agent, retrieving the agent metadata to your DX project, running this command to create the agent template, and then packaging the template.",
|
|
661
661
|
"examples": [
|
|
662
|
-
"Generate an agent template from
|
|
662
|
+
"Generate an agent template from the My_Awesome_Agent Bot metadata file in your DX project and save the BotTemplate and GenAiPlannerBundle to the specified directory; use version 1 of the agent. The agent that the template is based on is in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1 --output-dir my-package --source-org my-scratch-org"
|
|
663
663
|
],
|
|
664
664
|
"flags": {
|
|
665
665
|
"json": {
|
|
@@ -684,6 +684,16 @@
|
|
|
684
684
|
"multiple": false,
|
|
685
685
|
"type": "option"
|
|
686
686
|
},
|
|
687
|
+
"source-org": {
|
|
688
|
+
"char": "s",
|
|
689
|
+
"name": "source-org",
|
|
690
|
+
"noCacheDefault": true,
|
|
691
|
+
"required": true,
|
|
692
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
693
|
+
"hasDynamicHelp": true,
|
|
694
|
+
"multiple": false,
|
|
695
|
+
"type": "option"
|
|
696
|
+
},
|
|
687
697
|
"agent-version": {
|
|
688
698
|
"name": "agent-version",
|
|
689
699
|
"required": true,
|
|
@@ -700,16 +710,24 @@
|
|
|
700
710
|
"hasDynamicHelp": false,
|
|
701
711
|
"multiple": false,
|
|
702
712
|
"type": "option"
|
|
713
|
+
},
|
|
714
|
+
"output-dir": {
|
|
715
|
+
"char": "r",
|
|
716
|
+
"name": "output-dir",
|
|
717
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
718
|
+
"hasDynamicHelp": false,
|
|
719
|
+
"multiple": false,
|
|
720
|
+
"type": "option"
|
|
703
721
|
}
|
|
704
722
|
},
|
|
705
|
-
"hasDynamicHelp":
|
|
723
|
+
"hasDynamicHelp": true,
|
|
706
724
|
"hiddenAliases": [],
|
|
707
725
|
"id": "agent:generate:template",
|
|
708
726
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
709
727
|
"pluginName": "@salesforce/plugin-agent",
|
|
710
728
|
"pluginType": "core",
|
|
711
729
|
"strict": true,
|
|
712
|
-
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a managed package.",
|
|
730
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
713
731
|
"enableJsonFlag": true,
|
|
714
732
|
"requiresProject": true,
|
|
715
733
|
"isESM": true,
|
|
@@ -888,14 +906,14 @@
|
|
|
888
906
|
"authoring-bundle:publish:agent"
|
|
889
907
|
]
|
|
890
908
|
},
|
|
891
|
-
"agent:
|
|
909
|
+
"agent:test:create": {
|
|
892
910
|
"aliases": [],
|
|
893
911
|
"args": {},
|
|
894
|
-
"description": "
|
|
912
|
+
"description": "To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the \"agent generate test-spec\" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.\n\nWhen this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI. This command also retrieves the metadata component (AiEvaluationDefinition) associated with the new test to your local Salesforce DX project and displays its filename.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
|
|
895
913
|
"examples": [
|
|
896
|
-
"
|
|
897
|
-
"
|
|
898
|
-
"
|
|
914
|
+
"Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
|
|
915
|
+
"Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
|
|
916
|
+
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview"
|
|
899
917
|
],
|
|
900
918
|
"flags": {
|
|
901
919
|
"json": {
|
|
@@ -913,6 +931,20 @@
|
|
|
913
931
|
"multiple": false,
|
|
914
932
|
"type": "option"
|
|
915
933
|
},
|
|
934
|
+
"api-name": {
|
|
935
|
+
"name": "api-name",
|
|
936
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
937
|
+
"hasDynamicHelp": false,
|
|
938
|
+
"multiple": false,
|
|
939
|
+
"type": "option"
|
|
940
|
+
},
|
|
941
|
+
"spec": {
|
|
942
|
+
"name": "spec",
|
|
943
|
+
"summary": "Path to the test spec YAML file.",
|
|
944
|
+
"hasDynamicHelp": false,
|
|
945
|
+
"multiple": false,
|
|
946
|
+
"type": "option"
|
|
947
|
+
},
|
|
916
948
|
"target-org": {
|
|
917
949
|
"char": "o",
|
|
918
950
|
"name": "target-org",
|
|
@@ -930,66 +962,53 @@
|
|
|
930
962
|
"multiple": false,
|
|
931
963
|
"type": "option"
|
|
932
964
|
},
|
|
933
|
-
"
|
|
934
|
-
"name": "
|
|
935
|
-
"
|
|
936
|
-
"
|
|
937
|
-
"
|
|
938
|
-
"multiple": false,
|
|
939
|
-
"type": "option"
|
|
940
|
-
},
|
|
941
|
-
"api-name": {
|
|
942
|
-
"char": "n",
|
|
943
|
-
"name": "api-name",
|
|
944
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
945
|
-
"hasDynamicHelp": false,
|
|
946
|
-
"multiple": false,
|
|
947
|
-
"type": "option"
|
|
965
|
+
"preview": {
|
|
966
|
+
"name": "preview",
|
|
967
|
+
"summary": "Preview the test metadata file (AiEvaluationDefinition) without deploying to your org.",
|
|
968
|
+
"allowNo": false,
|
|
969
|
+
"type": "boolean"
|
|
948
970
|
},
|
|
949
|
-
"
|
|
950
|
-
"name": "
|
|
951
|
-
"summary": "
|
|
952
|
-
"
|
|
953
|
-
"
|
|
954
|
-
"type": "option"
|
|
971
|
+
"force-overwrite": {
|
|
972
|
+
"name": "force-overwrite",
|
|
973
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
974
|
+
"allowNo": false,
|
|
975
|
+
"type": "boolean"
|
|
955
976
|
}
|
|
956
977
|
},
|
|
957
978
|
"hasDynamicHelp": true,
|
|
958
979
|
"hiddenAliases": [],
|
|
959
|
-
"id": "agent:
|
|
980
|
+
"id": "agent:test:create",
|
|
960
981
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
961
982
|
"pluginName": "@salesforce/plugin-agent",
|
|
962
983
|
"pluginType": "core",
|
|
963
984
|
"strict": true,
|
|
964
|
-
"summary": "
|
|
985
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
965
986
|
"enableJsonFlag": true,
|
|
966
|
-
"requiresProject": true,
|
|
967
987
|
"isESM": true,
|
|
968
988
|
"relativePath": [
|
|
969
989
|
"lib",
|
|
970
990
|
"commands",
|
|
971
991
|
"agent",
|
|
972
|
-
"
|
|
973
|
-
"
|
|
992
|
+
"test",
|
|
993
|
+
"create.js"
|
|
974
994
|
],
|
|
975
995
|
"aliasPermutations": [],
|
|
976
996
|
"permutations": [
|
|
977
|
-
"agent:
|
|
978
|
-
"
|
|
979
|
-
"
|
|
980
|
-
"agent:
|
|
981
|
-
"
|
|
982
|
-
"
|
|
997
|
+
"agent:test:create",
|
|
998
|
+
"test:agent:create",
|
|
999
|
+
"test:create:agent",
|
|
1000
|
+
"agent:create:test",
|
|
1001
|
+
"create:agent:test",
|
|
1002
|
+
"create:test:agent"
|
|
983
1003
|
]
|
|
984
1004
|
},
|
|
985
|
-
"agent:
|
|
1005
|
+
"agent:test:list": {
|
|
986
1006
|
"aliases": [],
|
|
987
1007
|
"args": {},
|
|
988
|
-
"description": "
|
|
1008
|
+
"description": "The command outputs a table with the name (API name) of each test along with its unique ID and the date it was created in the org.",
|
|
989
1009
|
"examples": [
|
|
990
|
-
"
|
|
991
|
-
"
|
|
992
|
-
"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"
|
|
1010
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1011
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
993
1012
|
],
|
|
994
1013
|
"flags": {
|
|
995
1014
|
"json": {
|
|
@@ -1023,74 +1042,43 @@
|
|
|
1023
1042
|
"hasDynamicHelp": false,
|
|
1024
1043
|
"multiple": false,
|
|
1025
1044
|
"type": "option"
|
|
1026
|
-
},
|
|
1027
|
-
"session-id": {
|
|
1028
|
-
"name": "session-id",
|
|
1029
|
-
"required": false,
|
|
1030
|
-
"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.",
|
|
1031
|
-
"hasDynamicHelp": false,
|
|
1032
|
-
"multiple": false,
|
|
1033
|
-
"type": "option"
|
|
1034
|
-
},
|
|
1035
|
-
"utterance": {
|
|
1036
|
-
"char": "u",
|
|
1037
|
-
"name": "utterance",
|
|
1038
|
-
"required": true,
|
|
1039
|
-
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1040
|
-
"hasDynamicHelp": false,
|
|
1041
|
-
"multiple": false,
|
|
1042
|
-
"type": "option"
|
|
1043
|
-
},
|
|
1044
|
-
"api-name": {
|
|
1045
|
-
"char": "n",
|
|
1046
|
-
"name": "api-name",
|
|
1047
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1048
|
-
"hasDynamicHelp": false,
|
|
1049
|
-
"multiple": false,
|
|
1050
|
-
"type": "option"
|
|
1051
|
-
},
|
|
1052
|
-
"authoring-bundle": {
|
|
1053
|
-
"name": "authoring-bundle",
|
|
1054
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1055
|
-
"hasDynamicHelp": false,
|
|
1056
|
-
"multiple": false,
|
|
1057
|
-
"type": "option"
|
|
1058
1045
|
}
|
|
1059
1046
|
},
|
|
1060
1047
|
"hasDynamicHelp": true,
|
|
1061
1048
|
"hiddenAliases": [],
|
|
1062
|
-
"id": "agent:
|
|
1049
|
+
"id": "agent:test:list",
|
|
1063
1050
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1064
1051
|
"pluginName": "@salesforce/plugin-agent",
|
|
1065
1052
|
"pluginType": "core",
|
|
1066
1053
|
"strict": true,
|
|
1067
|
-
"summary": "
|
|
1054
|
+
"summary": "List the available agent tests in your org.",
|
|
1068
1055
|
"enableJsonFlag": true,
|
|
1069
|
-
"requiresProject": true,
|
|
1070
1056
|
"isESM": true,
|
|
1071
1057
|
"relativePath": [
|
|
1072
1058
|
"lib",
|
|
1073
1059
|
"commands",
|
|
1074
1060
|
"agent",
|
|
1075
|
-
"
|
|
1076
|
-
"
|
|
1061
|
+
"test",
|
|
1062
|
+
"list.js"
|
|
1077
1063
|
],
|
|
1078
1064
|
"aliasPermutations": [],
|
|
1079
1065
|
"permutations": [
|
|
1080
|
-
"agent:
|
|
1081
|
-
"
|
|
1082
|
-
"
|
|
1083
|
-
"agent:
|
|
1084
|
-
"
|
|
1085
|
-
"
|
|
1066
|
+
"agent:test:list",
|
|
1067
|
+
"test:agent:list",
|
|
1068
|
+
"test:list:agent",
|
|
1069
|
+
"agent:list:test",
|
|
1070
|
+
"list:agent:test",
|
|
1071
|
+
"list:test:agent"
|
|
1086
1072
|
]
|
|
1087
1073
|
},
|
|
1088
|
-
"agent:
|
|
1074
|
+
"agent:test:results": {
|
|
1089
1075
|
"aliases": [],
|
|
1090
1076
|
"args": {},
|
|
1091
|
-
"description": "This command
|
|
1077
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
1092
1078
|
"examples": [
|
|
1093
|
-
"
|
|
1079
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
1080
|
+
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
1081
|
+
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
1094
1082
|
],
|
|
1095
1083
|
"flags": {
|
|
1096
1084
|
"json": {
|
|
@@ -1107,44 +1095,99 @@
|
|
|
1107
1095
|
"hasDynamicHelp": false,
|
|
1108
1096
|
"multiple": false,
|
|
1109
1097
|
"type": "option"
|
|
1098
|
+
},
|
|
1099
|
+
"target-org": {
|
|
1100
|
+
"char": "o",
|
|
1101
|
+
"name": "target-org",
|
|
1102
|
+
"noCacheDefault": true,
|
|
1103
|
+
"required": true,
|
|
1104
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1105
|
+
"hasDynamicHelp": true,
|
|
1106
|
+
"multiple": false,
|
|
1107
|
+
"type": "option"
|
|
1108
|
+
},
|
|
1109
|
+
"api-version": {
|
|
1110
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1111
|
+
"name": "api-version",
|
|
1112
|
+
"hasDynamicHelp": false,
|
|
1113
|
+
"multiple": false,
|
|
1114
|
+
"type": "option"
|
|
1115
|
+
},
|
|
1116
|
+
"job-id": {
|
|
1117
|
+
"char": "i",
|
|
1118
|
+
"name": "job-id",
|
|
1119
|
+
"required": true,
|
|
1120
|
+
"summary": "Job ID of the completed agent test run.",
|
|
1121
|
+
"hasDynamicHelp": false,
|
|
1122
|
+
"multiple": false,
|
|
1123
|
+
"type": "option"
|
|
1124
|
+
},
|
|
1125
|
+
"result-format": {
|
|
1126
|
+
"name": "result-format",
|
|
1127
|
+
"summary": "Format of the agent test run results.",
|
|
1128
|
+
"default": "human",
|
|
1129
|
+
"hasDynamicHelp": false,
|
|
1130
|
+
"multiple": false,
|
|
1131
|
+
"options": [
|
|
1132
|
+
"json",
|
|
1133
|
+
"human",
|
|
1134
|
+
"junit",
|
|
1135
|
+
"tap"
|
|
1136
|
+
],
|
|
1137
|
+
"type": "option"
|
|
1138
|
+
},
|
|
1139
|
+
"output-dir": {
|
|
1140
|
+
"char": "d",
|
|
1141
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
1142
|
+
"name": "output-dir",
|
|
1143
|
+
"summary": "Directory to write the agent test results into.",
|
|
1144
|
+
"hasDynamicHelp": false,
|
|
1145
|
+
"multiple": false,
|
|
1146
|
+
"type": "option"
|
|
1147
|
+
},
|
|
1148
|
+
"verbose": {
|
|
1149
|
+
"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.",
|
|
1150
|
+
"name": "verbose",
|
|
1151
|
+
"summary": "Show generated data in the test results output.",
|
|
1152
|
+
"allowNo": false,
|
|
1153
|
+
"type": "boolean"
|
|
1110
1154
|
}
|
|
1111
1155
|
},
|
|
1112
|
-
"hasDynamicHelp":
|
|
1156
|
+
"hasDynamicHelp": true,
|
|
1113
1157
|
"hiddenAliases": [],
|
|
1114
|
-
"id": "agent:
|
|
1158
|
+
"id": "agent:test:results",
|
|
1115
1159
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1116
1160
|
"pluginName": "@salesforce/plugin-agent",
|
|
1117
1161
|
"pluginType": "core",
|
|
1118
1162
|
"strict": true,
|
|
1119
|
-
"summary": "
|
|
1163
|
+
"summary": "Get the results of a completed agent test run.",
|
|
1120
1164
|
"enableJsonFlag": true,
|
|
1121
|
-
"requiresProject": true,
|
|
1122
1165
|
"isESM": true,
|
|
1123
1166
|
"relativePath": [
|
|
1124
1167
|
"lib",
|
|
1125
1168
|
"commands",
|
|
1126
1169
|
"agent",
|
|
1127
|
-
"
|
|
1128
|
-
"
|
|
1170
|
+
"test",
|
|
1171
|
+
"results.js"
|
|
1129
1172
|
],
|
|
1130
1173
|
"aliasPermutations": [],
|
|
1131
1174
|
"permutations": [
|
|
1132
|
-
"agent:
|
|
1133
|
-
"
|
|
1134
|
-
"
|
|
1135
|
-
"agent:
|
|
1136
|
-
"
|
|
1137
|
-
"
|
|
1175
|
+
"agent:test:results",
|
|
1176
|
+
"test:agent:results",
|
|
1177
|
+
"test:results:agent",
|
|
1178
|
+
"agent:results:test",
|
|
1179
|
+
"results:agent:test",
|
|
1180
|
+
"results:test:agent"
|
|
1138
1181
|
]
|
|
1139
1182
|
},
|
|
1140
|
-
"agent:
|
|
1183
|
+
"agent:test:resume": {
|
|
1141
1184
|
"aliases": [],
|
|
1142
1185
|
"args": {},
|
|
1143
|
-
"description": "This command
|
|
1186
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nUse the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of the terminal to you, and you must run \"agent test resume\" again.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
1144
1187
|
"examples": [
|
|
1145
|
-
"
|
|
1146
|
-
"
|
|
1147
|
-
"
|
|
1188
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
1189
|
+
"Resume the most recently-run agent test in an org with alias \"my-org\" org; wait 10 minutes for the tests to finish:\n<%= config.bin %> <%= command.id %> --use-most-recent --wait 10 --target-org my-org",
|
|
1190
|
+
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
1148
1191
|
],
|
|
1149
1192
|
"flags": {
|
|
1150
1193
|
"json": {
|
|
@@ -1179,64 +1222,99 @@
|
|
|
1179
1222
|
"multiple": false,
|
|
1180
1223
|
"type": "option"
|
|
1181
1224
|
},
|
|
1182
|
-
"
|
|
1183
|
-
"char": "
|
|
1184
|
-
"name": "
|
|
1185
|
-
"summary": "
|
|
1186
|
-
"hasDynamicHelp": false,
|
|
1225
|
+
"job-id": {
|
|
1226
|
+
"char": "i",
|
|
1227
|
+
"name": "job-id",
|
|
1228
|
+
"summary": "Job ID of the original agent test run.",
|
|
1229
|
+
"hasDynamicHelp": false,
|
|
1187
1230
|
"multiple": false,
|
|
1188
1231
|
"type": "option"
|
|
1189
1232
|
},
|
|
1190
|
-
"
|
|
1191
|
-
"
|
|
1192
|
-
"
|
|
1233
|
+
"use-most-recent": {
|
|
1234
|
+
"char": "r",
|
|
1235
|
+
"name": "use-most-recent",
|
|
1236
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
1237
|
+
"allowNo": false,
|
|
1238
|
+
"type": "boolean"
|
|
1239
|
+
},
|
|
1240
|
+
"wait": {
|
|
1241
|
+
"char": "w",
|
|
1242
|
+
"name": "wait",
|
|
1243
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
1244
|
+
"default": "5 minutes",
|
|
1245
|
+
"hasDynamicHelp": true,
|
|
1246
|
+
"multiple": false,
|
|
1247
|
+
"type": "option"
|
|
1248
|
+
},
|
|
1249
|
+
"result-format": {
|
|
1250
|
+
"name": "result-format",
|
|
1251
|
+
"summary": "Format of the agent test run results.",
|
|
1252
|
+
"default": "human",
|
|
1193
1253
|
"hasDynamicHelp": false,
|
|
1194
1254
|
"multiple": false,
|
|
1255
|
+
"options": [
|
|
1256
|
+
"json",
|
|
1257
|
+
"human",
|
|
1258
|
+
"junit",
|
|
1259
|
+
"tap"
|
|
1260
|
+
],
|
|
1195
1261
|
"type": "option"
|
|
1196
1262
|
},
|
|
1197
|
-
"
|
|
1198
|
-
"
|
|
1199
|
-
"
|
|
1263
|
+
"output-dir": {
|
|
1264
|
+
"char": "d",
|
|
1265
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
1266
|
+
"name": "output-dir",
|
|
1267
|
+
"summary": "Directory to write the agent test results into.",
|
|
1268
|
+
"hasDynamicHelp": false,
|
|
1269
|
+
"multiple": false,
|
|
1270
|
+
"type": "option"
|
|
1271
|
+
},
|
|
1272
|
+
"verbose": {
|
|
1273
|
+
"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.",
|
|
1274
|
+
"name": "verbose",
|
|
1275
|
+
"summary": "Show generated data in the test results output.",
|
|
1200
1276
|
"allowNo": false,
|
|
1201
1277
|
"type": "boolean"
|
|
1202
1278
|
}
|
|
1203
1279
|
},
|
|
1204
1280
|
"hasDynamicHelp": true,
|
|
1205
1281
|
"hiddenAliases": [],
|
|
1206
|
-
"id": "agent:
|
|
1282
|
+
"id": "agent:test:resume",
|
|
1207
1283
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1208
1284
|
"pluginName": "@salesforce/plugin-agent",
|
|
1209
1285
|
"pluginType": "core",
|
|
1210
1286
|
"strict": true,
|
|
1211
|
-
"summary": "
|
|
1287
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
1212
1288
|
"enableJsonFlag": true,
|
|
1213
|
-
"requiresProject": true,
|
|
1214
1289
|
"isESM": true,
|
|
1215
1290
|
"relativePath": [
|
|
1216
1291
|
"lib",
|
|
1217
1292
|
"commands",
|
|
1218
1293
|
"agent",
|
|
1219
|
-
"
|
|
1220
|
-
"
|
|
1294
|
+
"test",
|
|
1295
|
+
"resume.js"
|
|
1221
1296
|
],
|
|
1222
1297
|
"aliasPermutations": [],
|
|
1223
1298
|
"permutations": [
|
|
1224
|
-
"agent:
|
|
1225
|
-
"
|
|
1226
|
-
"
|
|
1227
|
-
"agent:
|
|
1228
|
-
"
|
|
1229
|
-
"
|
|
1299
|
+
"agent:test:resume",
|
|
1300
|
+
"test:agent:resume",
|
|
1301
|
+
"test:resume:agent",
|
|
1302
|
+
"agent:resume:test",
|
|
1303
|
+
"resume:agent:test",
|
|
1304
|
+
"resume:test:agent"
|
|
1230
1305
|
]
|
|
1231
1306
|
},
|
|
1232
|
-
"agent:test:
|
|
1307
|
+
"agent:test:run-eval": {
|
|
1233
1308
|
"aliases": [],
|
|
1234
1309
|
"args": {},
|
|
1235
|
-
"description": "
|
|
1310
|
+
"description": "Execute rich evaluation tests against an Agentforce agent using the Einstein Evaluation API. Supports both YAML test specs (same format as `sf agent generate test-spec`) and JSON payloads.\n\nWhen you provide a YAML test spec, the command automatically translates test cases into Evaluation API calls and infers the agent name from the spec's `subjectName` field. This means you can use the same test spec with both `sf agent test run` and `sf agent test run-eval`. YAML test specs also support contextVariables, which allow you to inject contextual data (such as CaseId or RoutableId) into agent sessions for testing with different contexts.\n\nWhen you provide a JSON payload, it's sent directly to the API with optional normalization. The normalizer auto-corrects common field name mistakes, converts shorthand references to JSONPath, and injects defaults. Use `--no-normalize` to disable this auto-normalization. JSON payloads can also include context_variables on agent.create_session steps for the same contextual testing capabilities.\n\nSupports 8+ evaluator types, including topic routing assertions, action invocation checks, string/numeric assertions, semantic similarity scoring, and LLM-based quality ratings.",
|
|
1236
1311
|
"examples": [
|
|
1237
|
-
"
|
|
1238
|
-
"
|
|
1239
|
-
"
|
|
1312
|
+
"Run tests using a YAML test spec on the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec tests/my-agent-testSpec.yaml --target-org my-org",
|
|
1313
|
+
"Run tests using a YAML spec with explicit agent name override; use your default org:\n<%= config.bin %> <%= command.id %> --spec tests/my-agent-testSpec.yaml --api-name My_Agent --target-org my-org",
|
|
1314
|
+
"Run tests using a JSON payload:\n<%= config.bin %> <%= command.id %> --spec tests/eval-payload.json --target-org my-org",
|
|
1315
|
+
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec tests/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
1316
|
+
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec tests/agent-with-context.yaml --target-org my-org",
|
|
1317
|
+
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
1240
1318
|
],
|
|
1241
1319
|
"flags": {
|
|
1242
1320
|
"json": {
|
|
@@ -1254,20 +1332,6 @@
|
|
|
1254
1332
|
"multiple": false,
|
|
1255
1333
|
"type": "option"
|
|
1256
1334
|
},
|
|
1257
|
-
"api-name": {
|
|
1258
|
-
"name": "api-name",
|
|
1259
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
1260
|
-
"hasDynamicHelp": false,
|
|
1261
|
-
"multiple": false,
|
|
1262
|
-
"type": "option"
|
|
1263
|
-
},
|
|
1264
|
-
"spec": {
|
|
1265
|
-
"name": "spec",
|
|
1266
|
-
"summary": "Path to the test spec YAML file.",
|
|
1267
|
-
"hasDynamicHelp": false,
|
|
1268
|
-
"multiple": false,
|
|
1269
|
-
"type": "option"
|
|
1270
|
-
},
|
|
1271
1335
|
"target-org": {
|
|
1272
1336
|
"char": "o",
|
|
1273
1337
|
"name": "target-org",
|
|
@@ -1285,96 +1349,71 @@
|
|
|
1285
1349
|
"multiple": false,
|
|
1286
1350
|
"type": "option"
|
|
1287
1351
|
},
|
|
1288
|
-
"
|
|
1289
|
-
"
|
|
1290
|
-
"
|
|
1291
|
-
"
|
|
1292
|
-
"
|
|
1352
|
+
"spec": {
|
|
1353
|
+
"char": "s",
|
|
1354
|
+
"name": "spec",
|
|
1355
|
+
"required": true,
|
|
1356
|
+
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
1357
|
+
"hasDynamicHelp": false,
|
|
1358
|
+
"multiple": false,
|
|
1359
|
+
"type": "option"
|
|
1293
1360
|
},
|
|
1294
|
-
"
|
|
1295
|
-
"
|
|
1296
|
-
"
|
|
1297
|
-
"
|
|
1298
|
-
"
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
"hasDynamicHelp": true,
|
|
1302
|
-
"hiddenAliases": [],
|
|
1303
|
-
"id": "agent:test:create",
|
|
1304
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1305
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1306
|
-
"pluginType": "core",
|
|
1307
|
-
"strict": true,
|
|
1308
|
-
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
1309
|
-
"enableJsonFlag": true,
|
|
1310
|
-
"isESM": true,
|
|
1311
|
-
"relativePath": [
|
|
1312
|
-
"lib",
|
|
1313
|
-
"commands",
|
|
1314
|
-
"agent",
|
|
1315
|
-
"test",
|
|
1316
|
-
"create.js"
|
|
1317
|
-
],
|
|
1318
|
-
"aliasPermutations": [],
|
|
1319
|
-
"permutations": [
|
|
1320
|
-
"agent:test:create",
|
|
1321
|
-
"test:agent:create",
|
|
1322
|
-
"test:create:agent",
|
|
1323
|
-
"agent:create:test",
|
|
1324
|
-
"create:agent:test",
|
|
1325
|
-
"create:test:agent"
|
|
1326
|
-
]
|
|
1327
|
-
},
|
|
1328
|
-
"agent:test:list": {
|
|
1329
|
-
"aliases": [],
|
|
1330
|
-
"args": {},
|
|
1331
|
-
"description": "The command outputs a table with the name (API name) of each test along with its unique ID and the date it was created in the org.",
|
|
1332
|
-
"examples": [
|
|
1333
|
-
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1334
|
-
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
1335
|
-
],
|
|
1336
|
-
"flags": {
|
|
1337
|
-
"json": {
|
|
1338
|
-
"description": "Format output as json.",
|
|
1339
|
-
"helpGroup": "GLOBAL",
|
|
1340
|
-
"name": "json",
|
|
1341
|
-
"allowNo": false,
|
|
1342
|
-
"type": "boolean"
|
|
1361
|
+
"api-name": {
|
|
1362
|
+
"char": "n",
|
|
1363
|
+
"name": "api-name",
|
|
1364
|
+
"summary": "Agent DeveloperName (also called API name) to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
1365
|
+
"hasDynamicHelp": false,
|
|
1366
|
+
"multiple": false,
|
|
1367
|
+
"type": "option"
|
|
1343
1368
|
},
|
|
1344
|
-
"
|
|
1345
|
-
"
|
|
1346
|
-
"name": "
|
|
1347
|
-
"summary": "
|
|
1369
|
+
"wait": {
|
|
1370
|
+
"char": "w",
|
|
1371
|
+
"name": "wait",
|
|
1372
|
+
"summary": "Number of minutes to wait for results.",
|
|
1373
|
+
"default": 10,
|
|
1348
1374
|
"hasDynamicHelp": false,
|
|
1349
1375
|
"multiple": false,
|
|
1350
1376
|
"type": "option"
|
|
1351
1377
|
},
|
|
1352
|
-
"
|
|
1353
|
-
"
|
|
1354
|
-
"
|
|
1355
|
-
"
|
|
1356
|
-
"
|
|
1357
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1358
|
-
"hasDynamicHelp": true,
|
|
1378
|
+
"result-format": {
|
|
1379
|
+
"name": "result-format",
|
|
1380
|
+
"summary": "Format of the agent test run results.",
|
|
1381
|
+
"default": "human",
|
|
1382
|
+
"hasDynamicHelp": false,
|
|
1359
1383
|
"multiple": false,
|
|
1384
|
+
"options": [
|
|
1385
|
+
"json",
|
|
1386
|
+
"human",
|
|
1387
|
+
"junit",
|
|
1388
|
+
"tap"
|
|
1389
|
+
],
|
|
1360
1390
|
"type": "option"
|
|
1361
1391
|
},
|
|
1362
|
-
"
|
|
1363
|
-
"
|
|
1364
|
-
"
|
|
1392
|
+
"batch-size": {
|
|
1393
|
+
"name": "batch-size",
|
|
1394
|
+
"summary": "Number of tests per API request (max 5).",
|
|
1395
|
+
"default": 5,
|
|
1365
1396
|
"hasDynamicHelp": false,
|
|
1366
1397
|
"multiple": false,
|
|
1367
1398
|
"type": "option"
|
|
1399
|
+
},
|
|
1400
|
+
"no-normalize": {
|
|
1401
|
+
"name": "no-normalize",
|
|
1402
|
+
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
1403
|
+
"allowNo": false,
|
|
1404
|
+
"type": "boolean"
|
|
1368
1405
|
}
|
|
1369
1406
|
},
|
|
1370
1407
|
"hasDynamicHelp": true,
|
|
1408
|
+
"hidden": true,
|
|
1371
1409
|
"hiddenAliases": [],
|
|
1372
|
-
"id": "agent:test:
|
|
1410
|
+
"id": "agent:test:run-eval",
|
|
1373
1411
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1374
1412
|
"pluginName": "@salesforce/plugin-agent",
|
|
1375
1413
|
"pluginType": "core",
|
|
1414
|
+
"state": "beta",
|
|
1376
1415
|
"strict": true,
|
|
1377
|
-
"summary": "
|
|
1416
|
+
"summary": "Run evaluation tests against an Agentforce agent.",
|
|
1378
1417
|
"enableJsonFlag": true,
|
|
1379
1418
|
"isESM": true,
|
|
1380
1419
|
"relativePath": [
|
|
@@ -1382,26 +1421,26 @@
|
|
|
1382
1421
|
"commands",
|
|
1383
1422
|
"agent",
|
|
1384
1423
|
"test",
|
|
1385
|
-
"
|
|
1424
|
+
"run-eval.js"
|
|
1386
1425
|
],
|
|
1387
1426
|
"aliasPermutations": [],
|
|
1388
1427
|
"permutations": [
|
|
1389
|
-
"agent:test:
|
|
1390
|
-
"test:agent:
|
|
1391
|
-
"test:
|
|
1392
|
-
"agent:
|
|
1393
|
-
"
|
|
1394
|
-
"
|
|
1428
|
+
"agent:test:run-eval",
|
|
1429
|
+
"test:agent:run-eval",
|
|
1430
|
+
"test:run-eval:agent",
|
|
1431
|
+
"agent:run-eval:test",
|
|
1432
|
+
"run-eval:agent:test",
|
|
1433
|
+
"run-eval:test:agent"
|
|
1395
1434
|
]
|
|
1396
1435
|
},
|
|
1397
|
-
"agent:test:
|
|
1436
|
+
"agent:test:run": {
|
|
1398
1437
|
"aliases": [],
|
|
1399
1438
|
"args": {},
|
|
1400
|
-
"description": "
|
|
1439
|
+
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
1401
1440
|
"examples": [
|
|
1402
|
-
"
|
|
1403
|
-
"
|
|
1404
|
-
"
|
|
1441
|
+
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
1442
|
+
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
1443
|
+
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
1405
1444
|
],
|
|
1406
1445
|
"flags": {
|
|
1407
1446
|
"json": {
|
|
@@ -1436,15 +1475,22 @@
|
|
|
1436
1475
|
"multiple": false,
|
|
1437
1476
|
"type": "option"
|
|
1438
1477
|
},
|
|
1439
|
-
"
|
|
1440
|
-
"char": "
|
|
1441
|
-
"name": "
|
|
1442
|
-
"
|
|
1443
|
-
"summary": "Job ID of the completed agent test run.",
|
|
1478
|
+
"api-name": {
|
|
1479
|
+
"char": "n",
|
|
1480
|
+
"name": "api-name",
|
|
1481
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
1444
1482
|
"hasDynamicHelp": false,
|
|
1445
1483
|
"multiple": false,
|
|
1446
1484
|
"type": "option"
|
|
1447
1485
|
},
|
|
1486
|
+
"wait": {
|
|
1487
|
+
"char": "w",
|
|
1488
|
+
"name": "wait",
|
|
1489
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
1490
|
+
"hasDynamicHelp": true,
|
|
1491
|
+
"multiple": false,
|
|
1492
|
+
"type": "option"
|
|
1493
|
+
},
|
|
1448
1494
|
"result-format": {
|
|
1449
1495
|
"name": "result-format",
|
|
1450
1496
|
"summary": "Format of the agent test run results.",
|
|
@@ -1478,12 +1524,12 @@
|
|
|
1478
1524
|
},
|
|
1479
1525
|
"hasDynamicHelp": true,
|
|
1480
1526
|
"hiddenAliases": [],
|
|
1481
|
-
"id": "agent:test:
|
|
1527
|
+
"id": "agent:test:run",
|
|
1482
1528
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1483
1529
|
"pluginName": "@salesforce/plugin-agent",
|
|
1484
1530
|
"pluginType": "core",
|
|
1485
1531
|
"strict": true,
|
|
1486
|
-
"summary": "
|
|
1532
|
+
"summary": "Start an agent test in your org.",
|
|
1487
1533
|
"enableJsonFlag": true,
|
|
1488
1534
|
"isESM": true,
|
|
1489
1535
|
"relativePath": [
|
|
@@ -1491,26 +1537,25 @@
|
|
|
1491
1537
|
"commands",
|
|
1492
1538
|
"agent",
|
|
1493
1539
|
"test",
|
|
1494
|
-
"
|
|
1540
|
+
"run.js"
|
|
1495
1541
|
],
|
|
1496
1542
|
"aliasPermutations": [],
|
|
1497
1543
|
"permutations": [
|
|
1498
|
-
"agent:test:
|
|
1499
|
-
"test:agent:
|
|
1500
|
-
"test:
|
|
1501
|
-
"agent:
|
|
1502
|
-
"
|
|
1503
|
-
"
|
|
1544
|
+
"agent:test:run",
|
|
1545
|
+
"test:agent:run",
|
|
1546
|
+
"test:run:agent",
|
|
1547
|
+
"agent:run:test",
|
|
1548
|
+
"run:agent:test",
|
|
1549
|
+
"run:test:agent"
|
|
1504
1550
|
]
|
|
1505
1551
|
},
|
|
1506
|
-
"agent:
|
|
1552
|
+
"agent:validate:authoring-bundle": {
|
|
1507
1553
|
"aliases": [],
|
|
1508
1554
|
"args": {},
|
|
1509
|
-
"description": "
|
|
1555
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nThis command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
|
|
1510
1556
|
"examples": [
|
|
1511
|
-
"
|
|
1512
|
-
"
|
|
1513
|
-
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
1557
|
+
"Validate an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1558
|
+
"Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org"
|
|
1514
1559
|
],
|
|
1515
1560
|
"flags": {
|
|
1516
1561
|
"json": {
|
|
@@ -1545,99 +1590,57 @@
|
|
|
1545
1590
|
"multiple": false,
|
|
1546
1591
|
"type": "option"
|
|
1547
1592
|
},
|
|
1548
|
-
"
|
|
1549
|
-
"char": "
|
|
1550
|
-
"name": "
|
|
1551
|
-
"summary": "
|
|
1552
|
-
"hasDynamicHelp": false,
|
|
1553
|
-
"multiple": false,
|
|
1554
|
-
"type": "option"
|
|
1555
|
-
},
|
|
1556
|
-
"use-most-recent": {
|
|
1557
|
-
"char": "r",
|
|
1558
|
-
"name": "use-most-recent",
|
|
1559
|
-
"summary": "Use the job ID of the most recent agent test run.",
|
|
1560
|
-
"allowNo": false,
|
|
1561
|
-
"type": "boolean"
|
|
1562
|
-
},
|
|
1563
|
-
"wait": {
|
|
1564
|
-
"char": "w",
|
|
1565
|
-
"name": "wait",
|
|
1566
|
-
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
1567
|
-
"default": "5 minutes",
|
|
1568
|
-
"hasDynamicHelp": true,
|
|
1569
|
-
"multiple": false,
|
|
1570
|
-
"type": "option"
|
|
1571
|
-
},
|
|
1572
|
-
"result-format": {
|
|
1573
|
-
"name": "result-format",
|
|
1574
|
-
"summary": "Format of the agent test run results.",
|
|
1575
|
-
"default": "human",
|
|
1576
|
-
"hasDynamicHelp": false,
|
|
1577
|
-
"multiple": false,
|
|
1578
|
-
"options": [
|
|
1579
|
-
"json",
|
|
1580
|
-
"human",
|
|
1581
|
-
"junit",
|
|
1582
|
-
"tap"
|
|
1583
|
-
],
|
|
1584
|
-
"type": "option"
|
|
1585
|
-
},
|
|
1586
|
-
"output-dir": {
|
|
1587
|
-
"char": "d",
|
|
1588
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
1589
|
-
"name": "output-dir",
|
|
1590
|
-
"summary": "Directory to write the agent test results into.",
|
|
1593
|
+
"api-name": {
|
|
1594
|
+
"char": "n",
|
|
1595
|
+
"name": "api-name",
|
|
1596
|
+
"summary": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
1591
1597
|
"hasDynamicHelp": false,
|
|
1592
1598
|
"multiple": false,
|
|
1593
1599
|
"type": "option"
|
|
1594
|
-
},
|
|
1595
|
-
"verbose": {
|
|
1596
|
-
"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.",
|
|
1597
|
-
"name": "verbose",
|
|
1598
|
-
"summary": "Show generated data in the test results output.",
|
|
1599
|
-
"allowNo": false,
|
|
1600
|
-
"type": "boolean"
|
|
1601
1600
|
}
|
|
1602
1601
|
},
|
|
1603
1602
|
"hasDynamicHelp": true,
|
|
1604
1603
|
"hiddenAliases": [],
|
|
1605
|
-
"id": "agent:
|
|
1604
|
+
"id": "agent:validate:authoring-bundle",
|
|
1606
1605
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1607
1606
|
"pluginName": "@salesforce/plugin-agent",
|
|
1608
1607
|
"pluginType": "core",
|
|
1609
1608
|
"strict": true,
|
|
1610
|
-
"summary": "
|
|
1609
|
+
"summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
|
|
1611
1610
|
"enableJsonFlag": true,
|
|
1611
|
+
"requiresProject": true,
|
|
1612
|
+
"FLAGGABLE_PROMPTS": {
|
|
1613
|
+
"api-name": {
|
|
1614
|
+
"message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
1615
|
+
"promptMessage": "API name of the authoring bundle to validate"
|
|
1616
|
+
}
|
|
1617
|
+
},
|
|
1612
1618
|
"isESM": true,
|
|
1613
1619
|
"relativePath": [
|
|
1614
1620
|
"lib",
|
|
1615
1621
|
"commands",
|
|
1616
1622
|
"agent",
|
|
1617
|
-
"
|
|
1618
|
-
"
|
|
1623
|
+
"validate",
|
|
1624
|
+
"authoring-bundle.js"
|
|
1619
1625
|
],
|
|
1620
1626
|
"aliasPermutations": [],
|
|
1621
1627
|
"permutations": [
|
|
1622
|
-
"agent:
|
|
1623
|
-
"
|
|
1624
|
-
"
|
|
1625
|
-
"agent:
|
|
1626
|
-
"
|
|
1627
|
-
"
|
|
1628
|
+
"agent:validate:authoring-bundle",
|
|
1629
|
+
"validate:agent:authoring-bundle",
|
|
1630
|
+
"validate:authoring-bundle:agent",
|
|
1631
|
+
"agent:authoring-bundle:validate",
|
|
1632
|
+
"authoring-bundle:agent:validate",
|
|
1633
|
+
"authoring-bundle:validate:agent"
|
|
1628
1634
|
]
|
|
1629
1635
|
},
|
|
1630
|
-
"agent:
|
|
1631
|
-
"aliases": [],
|
|
1632
|
-
"args": {},
|
|
1633
|
-
"description": "
|
|
1634
|
-
"examples": [
|
|
1635
|
-
"
|
|
1636
|
-
"
|
|
1637
|
-
"
|
|
1638
|
-
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec tests/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
1639
|
-
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec tests/agent-with-context.yaml --target-org my-org",
|
|
1640
|
-
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
1636
|
+
"agent:preview:end": {
|
|
1637
|
+
"aliases": [],
|
|
1638
|
+
"args": {},
|
|
1639
|
+
"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.",
|
|
1640
|
+
"examples": [
|
|
1641
|
+
"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",
|
|
1642
|
+
"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",
|
|
1643
|
+
"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"
|
|
1641
1644
|
],
|
|
1642
1645
|
"flags": {
|
|
1643
1646
|
"json": {
|
|
@@ -1672,11 +1675,10 @@
|
|
|
1672
1675
|
"multiple": false,
|
|
1673
1676
|
"type": "option"
|
|
1674
1677
|
},
|
|
1675
|
-
"
|
|
1676
|
-
"
|
|
1677
|
-
"
|
|
1678
|
-
"
|
|
1679
|
-
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
1678
|
+
"session-id": {
|
|
1679
|
+
"name": "session-id",
|
|
1680
|
+
"required": false,
|
|
1681
|
+
"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.",
|
|
1680
1682
|
"hasDynamicHelp": false,
|
|
1681
1683
|
"multiple": false,
|
|
1682
1684
|
"type": "option"
|
|
@@ -1684,86 +1686,55 @@
|
|
|
1684
1686
|
"api-name": {
|
|
1685
1687
|
"char": "n",
|
|
1686
1688
|
"name": "api-name",
|
|
1687
|
-
"summary": "
|
|
1688
|
-
"hasDynamicHelp": false,
|
|
1689
|
-
"multiple": false,
|
|
1690
|
-
"type": "option"
|
|
1691
|
-
},
|
|
1692
|
-
"wait": {
|
|
1693
|
-
"char": "w",
|
|
1694
|
-
"name": "wait",
|
|
1695
|
-
"summary": "Number of minutes to wait for results.",
|
|
1696
|
-
"default": 10,
|
|
1697
|
-
"hasDynamicHelp": false,
|
|
1698
|
-
"multiple": false,
|
|
1699
|
-
"type": "option"
|
|
1700
|
-
},
|
|
1701
|
-
"result-format": {
|
|
1702
|
-
"name": "result-format",
|
|
1703
|
-
"summary": "Format of the agent test run results.",
|
|
1704
|
-
"default": "human",
|
|
1689
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1705
1690
|
"hasDynamicHelp": false,
|
|
1706
1691
|
"multiple": false,
|
|
1707
|
-
"options": [
|
|
1708
|
-
"json",
|
|
1709
|
-
"human",
|
|
1710
|
-
"junit",
|
|
1711
|
-
"tap"
|
|
1712
|
-
],
|
|
1713
1692
|
"type": "option"
|
|
1714
1693
|
},
|
|
1715
|
-
"
|
|
1716
|
-
"name": "
|
|
1717
|
-
"summary": "
|
|
1718
|
-
"default": 5,
|
|
1694
|
+
"authoring-bundle": {
|
|
1695
|
+
"name": "authoring-bundle",
|
|
1696
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1719
1697
|
"hasDynamicHelp": false,
|
|
1720
1698
|
"multiple": false,
|
|
1721
1699
|
"type": "option"
|
|
1722
|
-
},
|
|
1723
|
-
"no-normalize": {
|
|
1724
|
-
"name": "no-normalize",
|
|
1725
|
-
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
1726
|
-
"allowNo": false,
|
|
1727
|
-
"type": "boolean"
|
|
1728
1700
|
}
|
|
1729
1701
|
},
|
|
1730
1702
|
"hasDynamicHelp": true,
|
|
1731
|
-
"hidden": true,
|
|
1732
1703
|
"hiddenAliases": [],
|
|
1733
|
-
"id": "agent:
|
|
1704
|
+
"id": "agent:preview:end",
|
|
1734
1705
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1735
1706
|
"pluginName": "@salesforce/plugin-agent",
|
|
1736
1707
|
"pluginType": "core",
|
|
1737
|
-
"state": "beta",
|
|
1738
1708
|
"strict": true,
|
|
1739
|
-
"summary": "
|
|
1709
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
1740
1710
|
"enableJsonFlag": true,
|
|
1711
|
+
"requiresProject": true,
|
|
1741
1712
|
"isESM": true,
|
|
1742
1713
|
"relativePath": [
|
|
1743
1714
|
"lib",
|
|
1744
1715
|
"commands",
|
|
1745
1716
|
"agent",
|
|
1746
|
-
"
|
|
1747
|
-
"
|
|
1717
|
+
"preview",
|
|
1718
|
+
"end.js"
|
|
1748
1719
|
],
|
|
1749
1720
|
"aliasPermutations": [],
|
|
1750
1721
|
"permutations": [
|
|
1751
|
-
"agent:
|
|
1752
|
-
"
|
|
1753
|
-
"
|
|
1754
|
-
"agent:
|
|
1755
|
-
"
|
|
1756
|
-
"
|
|
1722
|
+
"agent:preview:end",
|
|
1723
|
+
"preview:agent:end",
|
|
1724
|
+
"preview:end:agent",
|
|
1725
|
+
"agent:end:preview",
|
|
1726
|
+
"end:agent:preview",
|
|
1727
|
+
"end:preview:agent"
|
|
1757
1728
|
]
|
|
1758
1729
|
},
|
|
1759
|
-
"agent:
|
|
1730
|
+
"agent:preview:send": {
|
|
1760
1731
|
"aliases": [],
|
|
1761
1732
|
"args": {},
|
|
1762
|
-
"description": "
|
|
1733
|
+
"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.",
|
|
1763
1734
|
"examples": [
|
|
1764
|
-
"
|
|
1765
|
-
"
|
|
1766
|
-
"
|
|
1735
|
+
"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>",
|
|
1736
|
+
"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",
|
|
1737
|
+
"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"
|
|
1767
1738
|
],
|
|
1768
1739
|
"flags": {
|
|
1769
1740
|
"json": {
|
|
@@ -1798,87 +1769,127 @@
|
|
|
1798
1769
|
"multiple": false,
|
|
1799
1770
|
"type": "option"
|
|
1800
1771
|
},
|
|
1801
|
-
"
|
|
1802
|
-
"
|
|
1803
|
-
"
|
|
1804
|
-
"summary": "
|
|
1772
|
+
"session-id": {
|
|
1773
|
+
"name": "session-id",
|
|
1774
|
+
"required": false,
|
|
1775
|
+
"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.",
|
|
1805
1776
|
"hasDynamicHelp": false,
|
|
1806
1777
|
"multiple": false,
|
|
1807
1778
|
"type": "option"
|
|
1808
1779
|
},
|
|
1809
|
-
"
|
|
1810
|
-
"char": "
|
|
1811
|
-
"name": "
|
|
1812
|
-
"
|
|
1813
|
-
"
|
|
1780
|
+
"utterance": {
|
|
1781
|
+
"char": "u",
|
|
1782
|
+
"name": "utterance",
|
|
1783
|
+
"required": true,
|
|
1784
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1785
|
+
"hasDynamicHelp": false,
|
|
1814
1786
|
"multiple": false,
|
|
1815
1787
|
"type": "option"
|
|
1816
1788
|
},
|
|
1817
|
-
"
|
|
1818
|
-
"
|
|
1819
|
-
"
|
|
1820
|
-
"
|
|
1789
|
+
"api-name": {
|
|
1790
|
+
"char": "n",
|
|
1791
|
+
"name": "api-name",
|
|
1792
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1821
1793
|
"hasDynamicHelp": false,
|
|
1822
1794
|
"multiple": false,
|
|
1823
|
-
"options": [
|
|
1824
|
-
"json",
|
|
1825
|
-
"human",
|
|
1826
|
-
"junit",
|
|
1827
|
-
"tap"
|
|
1828
|
-
],
|
|
1829
1795
|
"type": "option"
|
|
1830
1796
|
},
|
|
1831
|
-
"
|
|
1832
|
-
"
|
|
1833
|
-
"
|
|
1834
|
-
"name": "output-dir",
|
|
1835
|
-
"summary": "Directory to write the agent test results into.",
|
|
1797
|
+
"authoring-bundle": {
|
|
1798
|
+
"name": "authoring-bundle",
|
|
1799
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1836
1800
|
"hasDynamicHelp": false,
|
|
1837
1801
|
"multiple": false,
|
|
1838
1802
|
"type": "option"
|
|
1839
|
-
}
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
1803
|
+
}
|
|
1804
|
+
},
|
|
1805
|
+
"hasDynamicHelp": true,
|
|
1806
|
+
"hiddenAliases": [],
|
|
1807
|
+
"id": "agent:preview:send",
|
|
1808
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1809
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1810
|
+
"pluginType": "core",
|
|
1811
|
+
"strict": true,
|
|
1812
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
1813
|
+
"enableJsonFlag": true,
|
|
1814
|
+
"requiresProject": true,
|
|
1815
|
+
"isESM": true,
|
|
1816
|
+
"relativePath": [
|
|
1817
|
+
"lib",
|
|
1818
|
+
"commands",
|
|
1819
|
+
"agent",
|
|
1820
|
+
"preview",
|
|
1821
|
+
"send.js"
|
|
1822
|
+
],
|
|
1823
|
+
"aliasPermutations": [],
|
|
1824
|
+
"permutations": [
|
|
1825
|
+
"agent:preview:send",
|
|
1826
|
+
"preview:agent:send",
|
|
1827
|
+
"preview:send:agent",
|
|
1828
|
+
"agent:send:preview",
|
|
1829
|
+
"send:agent:preview",
|
|
1830
|
+
"send:preview:agent"
|
|
1831
|
+
]
|
|
1832
|
+
},
|
|
1833
|
+
"agent:preview:sessions": {
|
|
1834
|
+
"aliases": [],
|
|
1835
|
+
"args": {},
|
|
1836
|
+
"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.",
|
|
1837
|
+
"examples": [
|
|
1838
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
1839
|
+
],
|
|
1840
|
+
"flags": {
|
|
1841
|
+
"json": {
|
|
1842
|
+
"description": "Format output as json.",
|
|
1843
|
+
"helpGroup": "GLOBAL",
|
|
1844
|
+
"name": "json",
|
|
1844
1845
|
"allowNo": false,
|
|
1845
1846
|
"type": "boolean"
|
|
1847
|
+
},
|
|
1848
|
+
"flags-dir": {
|
|
1849
|
+
"helpGroup": "GLOBAL",
|
|
1850
|
+
"name": "flags-dir",
|
|
1851
|
+
"summary": "Import flag values from a directory.",
|
|
1852
|
+
"hasDynamicHelp": false,
|
|
1853
|
+
"multiple": false,
|
|
1854
|
+
"type": "option"
|
|
1846
1855
|
}
|
|
1847
1856
|
},
|
|
1848
|
-
"hasDynamicHelp":
|
|
1857
|
+
"hasDynamicHelp": false,
|
|
1849
1858
|
"hiddenAliases": [],
|
|
1850
|
-
"id": "agent:
|
|
1859
|
+
"id": "agent:preview:sessions",
|
|
1851
1860
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1852
1861
|
"pluginName": "@salesforce/plugin-agent",
|
|
1853
1862
|
"pluginType": "core",
|
|
1854
1863
|
"strict": true,
|
|
1855
|
-
"summary": "
|
|
1864
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
1856
1865
|
"enableJsonFlag": true,
|
|
1866
|
+
"requiresProject": true,
|
|
1857
1867
|
"isESM": true,
|
|
1858
1868
|
"relativePath": [
|
|
1859
1869
|
"lib",
|
|
1860
1870
|
"commands",
|
|
1861
1871
|
"agent",
|
|
1862
|
-
"
|
|
1863
|
-
"
|
|
1872
|
+
"preview",
|
|
1873
|
+
"sessions.js"
|
|
1864
1874
|
],
|
|
1865
1875
|
"aliasPermutations": [],
|
|
1866
1876
|
"permutations": [
|
|
1867
|
-
"agent:
|
|
1868
|
-
"
|
|
1869
|
-
"
|
|
1870
|
-
"agent:
|
|
1871
|
-
"
|
|
1872
|
-
"
|
|
1877
|
+
"agent:preview:sessions",
|
|
1878
|
+
"preview:agent:sessions",
|
|
1879
|
+
"preview:sessions:agent",
|
|
1880
|
+
"agent:sessions:preview",
|
|
1881
|
+
"sessions:agent:preview",
|
|
1882
|
+
"sessions:preview:agent"
|
|
1873
1883
|
]
|
|
1874
1884
|
},
|
|
1875
|
-
"agent:
|
|
1885
|
+
"agent:preview:start": {
|
|
1876
1886
|
"aliases": [],
|
|
1877
1887
|
"args": {},
|
|
1878
|
-
"description": "
|
|
1888
|
+
"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 using the authoring bundle, which contains the agent's Agent Script file, the preview uses mocked actions by default. Specify --use-live-actions for live mode, which uses the real Apex classes, flows, etc, in the org for the actions.",
|
|
1879
1889
|
"examples": [
|
|
1880
|
-
"
|
|
1881
|
-
"
|
|
1890
|
+
"Start a programmatic agent preview session by specifying an authoring bundle; uses mocked actions by default. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org",
|
|
1891
|
+
"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",
|
|
1892
|
+
"Start a preview session with an activated published agent:\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1882
1893
|
],
|
|
1883
1894
|
"flags": {
|
|
1884
1895
|
"json": {
|
|
@@ -1916,46 +1927,53 @@
|
|
|
1916
1927
|
"api-name": {
|
|
1917
1928
|
"char": "n",
|
|
1918
1929
|
"name": "api-name",
|
|
1919
|
-
"summary": "API name of the
|
|
1930
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1931
|
+
"hasDynamicHelp": false,
|
|
1932
|
+
"multiple": false,
|
|
1933
|
+
"type": "option"
|
|
1934
|
+
},
|
|
1935
|
+
"authoring-bundle": {
|
|
1936
|
+
"name": "authoring-bundle",
|
|
1937
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1920
1938
|
"hasDynamicHelp": false,
|
|
1921
1939
|
"multiple": false,
|
|
1922
1940
|
"type": "option"
|
|
1941
|
+
},
|
|
1942
|
+
"use-live-actions": {
|
|
1943
|
+
"name": "use-live-actions",
|
|
1944
|
+
"summary": "Use real actions in the org; if not specified, preview uses AI to simulate (mock) actions.",
|
|
1945
|
+
"allowNo": false,
|
|
1946
|
+
"type": "boolean"
|
|
1923
1947
|
}
|
|
1924
1948
|
},
|
|
1925
1949
|
"hasDynamicHelp": true,
|
|
1926
1950
|
"hiddenAliases": [],
|
|
1927
|
-
"id": "agent:
|
|
1951
|
+
"id": "agent:preview:start",
|
|
1928
1952
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1929
1953
|
"pluginName": "@salesforce/plugin-agent",
|
|
1930
1954
|
"pluginType": "core",
|
|
1931
1955
|
"strict": true,
|
|
1932
|
-
"summary": "
|
|
1956
|
+
"summary": "Start a programmatic agent preview session.",
|
|
1933
1957
|
"enableJsonFlag": true,
|
|
1934
1958
|
"requiresProject": true,
|
|
1935
|
-
"FLAGGABLE_PROMPTS": {
|
|
1936
|
-
"api-name": {
|
|
1937
|
-
"message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
1938
|
-
"promptMessage": "API name of the authoring bundle to validate"
|
|
1939
|
-
}
|
|
1940
|
-
},
|
|
1941
1959
|
"isESM": true,
|
|
1942
1960
|
"relativePath": [
|
|
1943
1961
|
"lib",
|
|
1944
1962
|
"commands",
|
|
1945
1963
|
"agent",
|
|
1946
|
-
"
|
|
1947
|
-
"
|
|
1964
|
+
"preview",
|
|
1965
|
+
"start.js"
|
|
1948
1966
|
],
|
|
1949
1967
|
"aliasPermutations": [],
|
|
1950
1968
|
"permutations": [
|
|
1951
|
-
"agent:
|
|
1952
|
-
"
|
|
1953
|
-
"
|
|
1954
|
-
"agent:
|
|
1955
|
-
"
|
|
1956
|
-
"
|
|
1969
|
+
"agent:preview:start",
|
|
1970
|
+
"preview:agent:start",
|
|
1971
|
+
"preview:start:agent",
|
|
1972
|
+
"agent:start:preview",
|
|
1973
|
+
"start:agent:preview",
|
|
1974
|
+
"start:preview:agent"
|
|
1957
1975
|
]
|
|
1958
1976
|
}
|
|
1959
1977
|
},
|
|
1960
|
-
"version": "1.32.
|
|
1978
|
+
"version": "1.32.11"
|
|
1961
1979
|
}
|