@salesforce/plugin-agent 1.32.13 → 1.32.15
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 +30 -30
- package/lib/commands/agent/activate.d.ts +2 -0
- package/lib/commands/agent/activate.js +33 -4
- package/lib/commands/agent/activate.js.map +1 -1
- package/lib/commands/agent/deactivate.d.ts +2 -0
- package/lib/commands/agent/deactivate.js +33 -4
- package/lib/commands/agent/deactivate.js.map +1 -1
- package/lib/commands/agent/preview/end.d.ts +2 -0
- package/lib/commands/agent/preview/end.js +49 -12
- package/lib/commands/agent/preview/end.js.map +1 -1
- package/lib/commands/agent/preview/send.d.ts +2 -0
- package/lib/commands/agent/preview/send.js +47 -9
- package/lib/commands/agent/preview/send.js.map +1 -1
- package/lib/commands/agent/preview/sessions.d.ts +1 -0
- package/lib/commands/agent/preview/sessions.js +4 -1
- package/lib/commands/agent/preview/sessions.js.map +1 -1
- package/lib/commands/agent/preview/start.d.ts +2 -0
- package/lib/commands/agent/preview/start.js +55 -6
- package/lib/commands/agent/preview/start.js.map +1 -1
- package/lib/commands/agent/test/create.d.ts +2 -0
- package/lib/commands/agent/test/create.js +34 -6
- package/lib/commands/agent/test/create.js.map +1 -1
- package/lib/commands/agent/test/list.d.ts +2 -0
- package/lib/commands/agent/test/list.js +15 -3
- package/lib/commands/agent/test/list.js.map +1 -1
- package/lib/commands/agent/test/results.d.ts +2 -0
- package/lib/commands/agent/test/results.js +23 -3
- package/lib/commands/agent/test/results.js.map +1 -1
- package/lib/commands/agent/test/resume.d.ts +6 -0
- package/lib/commands/agent/test/resume.js +55 -7
- package/lib/commands/agent/test/resume.js.map +1 -1
- package/lib/commands/agent/test/run-eval.d.ts +2 -0
- package/lib/commands/agent/test/run-eval.js +38 -7
- package/lib/commands/agent/test/run-eval.js.map +1 -1
- package/lib/commands/agent/test/run.d.ts +2 -0
- package/lib/commands/agent/test/run.js +32 -8
- package/lib/commands/agent/test/run.js.map +1 -1
- package/lib/commands/agent/validate/authoring-bundle.d.ts +2 -0
- package/lib/commands/agent/validate/authoring-bundle.js +9 -2
- package/lib/commands/agent/validate/authoring-bundle.js.map +1 -1
- package/lib/previewSessionStore.js +0 -6
- package/lib/previewSessionStore.js.map +1 -1
- package/messages/agent.activate.md +8 -0
- package/messages/agent.deactivate.md +8 -0
- package/messages/agent.preview.end.md +18 -6
- package/messages/agent.preview.send.md +16 -4
- package/messages/agent.preview.start.md +19 -7
- package/oclif.manifest.json +447 -94
- package/package.json +3 -3
package/oclif.manifest.json
CHANGED
|
@@ -66,6 +66,32 @@
|
|
|
66
66
|
"strict": true,
|
|
67
67
|
"summary": "Activate an agent in an org.",
|
|
68
68
|
"enableJsonFlag": true,
|
|
69
|
+
"envVariablesSection": {
|
|
70
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
71
|
+
"body": [
|
|
72
|
+
{
|
|
73
|
+
"name": "SF_TARGET_ORG",
|
|
74
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
75
|
+
}
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
"errorCodes": {
|
|
79
|
+
"header": "ERROR CODES",
|
|
80
|
+
"body": [
|
|
81
|
+
{
|
|
82
|
+
"name": "Succeeded (0)",
|
|
83
|
+
"description": "Agent activated successfully."
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "NotFound (2)",
|
|
87
|
+
"description": "Agent not found in the org."
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"name": "ActivationFailed (4)",
|
|
91
|
+
"description": "Failed to activate the agent due to API or network errors."
|
|
92
|
+
}
|
|
93
|
+
]
|
|
94
|
+
},
|
|
69
95
|
"isESM": true,
|
|
70
96
|
"relativePath": [
|
|
71
97
|
"lib",
|
|
@@ -239,6 +265,32 @@
|
|
|
239
265
|
"strict": true,
|
|
240
266
|
"summary": "Deactivate an agent in an org.",
|
|
241
267
|
"enableJsonFlag": true,
|
|
268
|
+
"envVariablesSection": {
|
|
269
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
270
|
+
"body": [
|
|
271
|
+
{
|
|
272
|
+
"name": "SF_TARGET_ORG",
|
|
273
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
274
|
+
}
|
|
275
|
+
]
|
|
276
|
+
},
|
|
277
|
+
"errorCodes": {
|
|
278
|
+
"header": "ERROR CODES",
|
|
279
|
+
"body": [
|
|
280
|
+
{
|
|
281
|
+
"name": "Succeeded (0)",
|
|
282
|
+
"description": "Agent deactivated successfully."
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
"name": "NotFound (2)",
|
|
286
|
+
"description": "Agent not found in the org."
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"name": "DeactivationFailed (4)",
|
|
290
|
+
"description": "Failed to deactivate the agent due to API or network errors."
|
|
291
|
+
}
|
|
292
|
+
]
|
|
293
|
+
},
|
|
242
294
|
"isESM": true,
|
|
243
295
|
"relativePath": [
|
|
244
296
|
"lib",
|
|
@@ -816,100 +868,10 @@
|
|
|
816
868
|
"test-spec:generate:agent"
|
|
817
869
|
]
|
|
818
870
|
},
|
|
819
|
-
"agent:publish:authoring-bundle": {
|
|
820
|
-
"aliases": [],
|
|
821
|
-
"args": {},
|
|
822
|
-
"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\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
823
|
-
"examples": [
|
|
824
|
-
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
825
|
-
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org"
|
|
826
|
-
],
|
|
827
|
-
"flags": {
|
|
828
|
-
"json": {
|
|
829
|
-
"description": "Format output as json.",
|
|
830
|
-
"helpGroup": "GLOBAL",
|
|
831
|
-
"name": "json",
|
|
832
|
-
"allowNo": false,
|
|
833
|
-
"type": "boolean"
|
|
834
|
-
},
|
|
835
|
-
"flags-dir": {
|
|
836
|
-
"helpGroup": "GLOBAL",
|
|
837
|
-
"name": "flags-dir",
|
|
838
|
-
"summary": "Import flag values from a directory.",
|
|
839
|
-
"hasDynamicHelp": false,
|
|
840
|
-
"multiple": false,
|
|
841
|
-
"type": "option"
|
|
842
|
-
},
|
|
843
|
-
"target-org": {
|
|
844
|
-
"char": "o",
|
|
845
|
-
"name": "target-org",
|
|
846
|
-
"noCacheDefault": true,
|
|
847
|
-
"required": true,
|
|
848
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
849
|
-
"hasDynamicHelp": true,
|
|
850
|
-
"multiple": false,
|
|
851
|
-
"type": "option"
|
|
852
|
-
},
|
|
853
|
-
"api-version": {
|
|
854
|
-
"description": "Override the api version used for api requests made by this command",
|
|
855
|
-
"name": "api-version",
|
|
856
|
-
"hasDynamicHelp": false,
|
|
857
|
-
"multiple": false,
|
|
858
|
-
"type": "option"
|
|
859
|
-
},
|
|
860
|
-
"api-name": {
|
|
861
|
-
"char": "n",
|
|
862
|
-
"name": "api-name",
|
|
863
|
-
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
864
|
-
"hasDynamicHelp": false,
|
|
865
|
-
"multiple": false,
|
|
866
|
-
"type": "option"
|
|
867
|
-
},
|
|
868
|
-
"skip-retrieve": {
|
|
869
|
-
"name": "skip-retrieve",
|
|
870
|
-
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
871
|
-
"allowNo": false,
|
|
872
|
-
"type": "boolean"
|
|
873
|
-
}
|
|
874
|
-
},
|
|
875
|
-
"hasDynamicHelp": true,
|
|
876
|
-
"hiddenAliases": [],
|
|
877
|
-
"id": "agent:publish:authoring-bundle",
|
|
878
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
879
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
880
|
-
"pluginType": "core",
|
|
881
|
-
"strict": true,
|
|
882
|
-
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
883
|
-
"enableJsonFlag": true,
|
|
884
|
-
"requiresProject": true,
|
|
885
|
-
"FLAGGABLE_PROMPTS": {
|
|
886
|
-
"api-name": {
|
|
887
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
888
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
889
|
-
}
|
|
890
|
-
},
|
|
891
|
-
"isESM": true,
|
|
892
|
-
"relativePath": [
|
|
893
|
-
"lib",
|
|
894
|
-
"commands",
|
|
895
|
-
"agent",
|
|
896
|
-
"publish",
|
|
897
|
-
"authoring-bundle.js"
|
|
898
|
-
],
|
|
899
|
-
"aliasPermutations": [],
|
|
900
|
-
"permutations": [
|
|
901
|
-
"agent:publish:authoring-bundle",
|
|
902
|
-
"publish:agent:authoring-bundle",
|
|
903
|
-
"publish:authoring-bundle:agent",
|
|
904
|
-
"agent:authoring-bundle:publish",
|
|
905
|
-
"authoring-bundle:agent:publish",
|
|
906
|
-
"authoring-bundle:publish:agent"
|
|
907
|
-
]
|
|
908
|
-
},
|
|
909
871
|
"agent:preview:end": {
|
|
910
872
|
"aliases": [],
|
|
911
873
|
"args": {},
|
|
912
|
-
"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
|
|
874
|
+
"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.",
|
|
913
875
|
"examples": [
|
|
914
876
|
"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",
|
|
915
877
|
"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",
|
|
@@ -982,6 +944,36 @@
|
|
|
982
944
|
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
983
945
|
"enableJsonFlag": true,
|
|
984
946
|
"requiresProject": true,
|
|
947
|
+
"envVariablesSection": {
|
|
948
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
949
|
+
"body": [
|
|
950
|
+
{
|
|
951
|
+
"name": "SF_TARGET_ORG",
|
|
952
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
953
|
+
}
|
|
954
|
+
]
|
|
955
|
+
},
|
|
956
|
+
"errorCodes": {
|
|
957
|
+
"header": "ERROR CODES",
|
|
958
|
+
"body": [
|
|
959
|
+
{
|
|
960
|
+
"name": "Succeeded (0)",
|
|
961
|
+
"description": "Preview session ended successfully and traces saved."
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"name": "NotFound (2)",
|
|
965
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
966
|
+
},
|
|
967
|
+
{
|
|
968
|
+
"name": "PreviewEndFailed (4)",
|
|
969
|
+
"description": "Failed to end the preview session."
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"name": "SessionAmbiguous (5)",
|
|
973
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
974
|
+
}
|
|
975
|
+
]
|
|
976
|
+
},
|
|
985
977
|
"isESM": true,
|
|
986
978
|
"relativePath": [
|
|
987
979
|
"lib",
|
|
@@ -1003,7 +995,7 @@
|
|
|
1003
995
|
"agent:preview:send": {
|
|
1004
996
|
"aliases": [],
|
|
1005
997
|
"args": {},
|
|
1006
|
-
"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.
|
|
998
|
+
"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.",
|
|
1007
999
|
"examples": [
|
|
1008
1000
|
"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>",
|
|
1009
1001
|
"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",
|
|
@@ -1085,6 +1077,36 @@
|
|
|
1085
1077
|
"summary": "Send a message to an existing agent preview session.",
|
|
1086
1078
|
"enableJsonFlag": true,
|
|
1087
1079
|
"requiresProject": true,
|
|
1080
|
+
"envVariablesSection": {
|
|
1081
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1082
|
+
"body": [
|
|
1083
|
+
{
|
|
1084
|
+
"name": "SF_TARGET_ORG",
|
|
1085
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1086
|
+
}
|
|
1087
|
+
]
|
|
1088
|
+
},
|
|
1089
|
+
"errorCodes": {
|
|
1090
|
+
"header": "ERROR CODES",
|
|
1091
|
+
"body": [
|
|
1092
|
+
{
|
|
1093
|
+
"name": "Succeeded (0)",
|
|
1094
|
+
"description": "Message sent successfully and agent response received."
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"name": "NotFound (2)",
|
|
1098
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "PreviewSendFailed (4)",
|
|
1102
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
"name": "SessionAmbiguous (5)",
|
|
1106
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1107
|
+
}
|
|
1108
|
+
]
|
|
1109
|
+
},
|
|
1088
1110
|
"isESM": true,
|
|
1089
1111
|
"relativePath": [
|
|
1090
1112
|
"lib",
|
|
@@ -1137,6 +1159,15 @@
|
|
|
1137
1159
|
"summary": "List all known programmatic agent preview sessions.",
|
|
1138
1160
|
"enableJsonFlag": true,
|
|
1139
1161
|
"requiresProject": true,
|
|
1162
|
+
"errorCodes": {
|
|
1163
|
+
"header": "ERROR CODES",
|
|
1164
|
+
"body": [
|
|
1165
|
+
{
|
|
1166
|
+
"name": "Succeeded (0)",
|
|
1167
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
1168
|
+
}
|
|
1169
|
+
]
|
|
1170
|
+
},
|
|
1140
1171
|
"isESM": true,
|
|
1141
1172
|
"relativePath": [
|
|
1142
1173
|
"lib",
|
|
@@ -1158,7 +1189,7 @@
|
|
|
1158
1189
|
"agent:preview:start": {
|
|
1159
1190
|
"aliases": [],
|
|
1160
1191
|
"args": {},
|
|
1161
|
-
"description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent.
|
|
1192
|
+
"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.",
|
|
1162
1193
|
"examples": [
|
|
1163
1194
|
"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",
|
|
1164
1195
|
"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",
|
|
@@ -1229,6 +1260,40 @@
|
|
|
1229
1260
|
"summary": "Start a programmatic agent preview session.",
|
|
1230
1261
|
"enableJsonFlag": true,
|
|
1231
1262
|
"requiresProject": true,
|
|
1263
|
+
"envVariablesSection": {
|
|
1264
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1265
|
+
"body": [
|
|
1266
|
+
{
|
|
1267
|
+
"name": "SF_TARGET_ORG",
|
|
1268
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1269
|
+
}
|
|
1270
|
+
]
|
|
1271
|
+
},
|
|
1272
|
+
"errorCodes": {
|
|
1273
|
+
"header": "ERROR CODES",
|
|
1274
|
+
"body": [
|
|
1275
|
+
{
|
|
1276
|
+
"name": "Succeeded (0)",
|
|
1277
|
+
"description": "Preview session started successfully."
|
|
1278
|
+
},
|
|
1279
|
+
{
|
|
1280
|
+
"name": "Failed (1)",
|
|
1281
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"name": "NotFound (2)",
|
|
1285
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
"name": "ServerError (3)",
|
|
1289
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
1290
|
+
},
|
|
1291
|
+
{
|
|
1292
|
+
"name": "PreviewStartFailed (4)",
|
|
1293
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
1294
|
+
}
|
|
1295
|
+
]
|
|
1296
|
+
},
|
|
1232
1297
|
"isESM": true,
|
|
1233
1298
|
"relativePath": [
|
|
1234
1299
|
"lib",
|
|
@@ -1247,6 +1312,96 @@
|
|
|
1247
1312
|
"start:preview:agent"
|
|
1248
1313
|
]
|
|
1249
1314
|
},
|
|
1315
|
+
"agent:publish:authoring-bundle": {
|
|
1316
|
+
"aliases": [],
|
|
1317
|
+
"args": {},
|
|
1318
|
+
"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\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
1319
|
+
"examples": [
|
|
1320
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1321
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org"
|
|
1322
|
+
],
|
|
1323
|
+
"flags": {
|
|
1324
|
+
"json": {
|
|
1325
|
+
"description": "Format output as json.",
|
|
1326
|
+
"helpGroup": "GLOBAL",
|
|
1327
|
+
"name": "json",
|
|
1328
|
+
"allowNo": false,
|
|
1329
|
+
"type": "boolean"
|
|
1330
|
+
},
|
|
1331
|
+
"flags-dir": {
|
|
1332
|
+
"helpGroup": "GLOBAL",
|
|
1333
|
+
"name": "flags-dir",
|
|
1334
|
+
"summary": "Import flag values from a directory.",
|
|
1335
|
+
"hasDynamicHelp": false,
|
|
1336
|
+
"multiple": false,
|
|
1337
|
+
"type": "option"
|
|
1338
|
+
},
|
|
1339
|
+
"target-org": {
|
|
1340
|
+
"char": "o",
|
|
1341
|
+
"name": "target-org",
|
|
1342
|
+
"noCacheDefault": true,
|
|
1343
|
+
"required": true,
|
|
1344
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1345
|
+
"hasDynamicHelp": true,
|
|
1346
|
+
"multiple": false,
|
|
1347
|
+
"type": "option"
|
|
1348
|
+
},
|
|
1349
|
+
"api-version": {
|
|
1350
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1351
|
+
"name": "api-version",
|
|
1352
|
+
"hasDynamicHelp": false,
|
|
1353
|
+
"multiple": false,
|
|
1354
|
+
"type": "option"
|
|
1355
|
+
},
|
|
1356
|
+
"api-name": {
|
|
1357
|
+
"char": "n",
|
|
1358
|
+
"name": "api-name",
|
|
1359
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
1360
|
+
"hasDynamicHelp": false,
|
|
1361
|
+
"multiple": false,
|
|
1362
|
+
"type": "option"
|
|
1363
|
+
},
|
|
1364
|
+
"skip-retrieve": {
|
|
1365
|
+
"name": "skip-retrieve",
|
|
1366
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
1367
|
+
"allowNo": false,
|
|
1368
|
+
"type": "boolean"
|
|
1369
|
+
}
|
|
1370
|
+
},
|
|
1371
|
+
"hasDynamicHelp": true,
|
|
1372
|
+
"hiddenAliases": [],
|
|
1373
|
+
"id": "agent:publish:authoring-bundle",
|
|
1374
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1375
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1376
|
+
"pluginType": "core",
|
|
1377
|
+
"strict": true,
|
|
1378
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
1379
|
+
"enableJsonFlag": true,
|
|
1380
|
+
"requiresProject": true,
|
|
1381
|
+
"FLAGGABLE_PROMPTS": {
|
|
1382
|
+
"api-name": {
|
|
1383
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
1384
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
1385
|
+
}
|
|
1386
|
+
},
|
|
1387
|
+
"isESM": true,
|
|
1388
|
+
"relativePath": [
|
|
1389
|
+
"lib",
|
|
1390
|
+
"commands",
|
|
1391
|
+
"agent",
|
|
1392
|
+
"publish",
|
|
1393
|
+
"authoring-bundle.js"
|
|
1394
|
+
],
|
|
1395
|
+
"aliasPermutations": [],
|
|
1396
|
+
"permutations": [
|
|
1397
|
+
"agent:publish:authoring-bundle",
|
|
1398
|
+
"publish:agent:authoring-bundle",
|
|
1399
|
+
"publish:authoring-bundle:agent",
|
|
1400
|
+
"agent:authoring-bundle:publish",
|
|
1401
|
+
"authoring-bundle:agent:publish",
|
|
1402
|
+
"authoring-bundle:publish:agent"
|
|
1403
|
+
]
|
|
1404
|
+
},
|
|
1250
1405
|
"agent:test:create": {
|
|
1251
1406
|
"aliases": [],
|
|
1252
1407
|
"args": {},
|
|
@@ -1325,6 +1480,36 @@
|
|
|
1325
1480
|
"strict": true,
|
|
1326
1481
|
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
1327
1482
|
"enableJsonFlag": true,
|
|
1483
|
+
"envVariablesSection": {
|
|
1484
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1485
|
+
"body": [
|
|
1486
|
+
{
|
|
1487
|
+
"name": "SF_TARGET_ORG",
|
|
1488
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1489
|
+
}
|
|
1490
|
+
]
|
|
1491
|
+
},
|
|
1492
|
+
"errorCodes": {
|
|
1493
|
+
"header": "ERROR CODES",
|
|
1494
|
+
"body": [
|
|
1495
|
+
{
|
|
1496
|
+
"name": "Succeeded (0)",
|
|
1497
|
+
"description": "Test created and deployed successfully."
|
|
1498
|
+
},
|
|
1499
|
+
{
|
|
1500
|
+
"name": "Failed (1)",
|
|
1501
|
+
"description": "Test validation errors or metadata format issues."
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"name": "NotFound (2)",
|
|
1505
|
+
"description": "Test spec file not found or org connection failed."
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
"name": "DeploymentFailed (4)",
|
|
1509
|
+
"description": "Deployment failed due to API or network errors."
|
|
1510
|
+
}
|
|
1511
|
+
]
|
|
1512
|
+
},
|
|
1328
1513
|
"isESM": true,
|
|
1329
1514
|
"relativePath": [
|
|
1330
1515
|
"lib",
|
|
@@ -1394,6 +1579,28 @@
|
|
|
1394
1579
|
"strict": true,
|
|
1395
1580
|
"summary": "List the available agent tests in your org.",
|
|
1396
1581
|
"enableJsonFlag": true,
|
|
1582
|
+
"envVariablesSection": {
|
|
1583
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1584
|
+
"body": [
|
|
1585
|
+
{
|
|
1586
|
+
"name": "SF_TARGET_ORG",
|
|
1587
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1588
|
+
}
|
|
1589
|
+
]
|
|
1590
|
+
},
|
|
1591
|
+
"errorCodes": {
|
|
1592
|
+
"header": "ERROR CODES",
|
|
1593
|
+
"body": [
|
|
1594
|
+
{
|
|
1595
|
+
"name": "Succeeded (0)",
|
|
1596
|
+
"description": "Agent tests listed successfully."
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "Failed (4)",
|
|
1600
|
+
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
1601
|
+
}
|
|
1602
|
+
]
|
|
1603
|
+
},
|
|
1397
1604
|
"isESM": true,
|
|
1398
1605
|
"relativePath": [
|
|
1399
1606
|
"lib",
|
|
@@ -1503,6 +1710,32 @@
|
|
|
1503
1710
|
"strict": true,
|
|
1504
1711
|
"summary": "Get the results of a completed agent test run.",
|
|
1505
1712
|
"enableJsonFlag": true,
|
|
1713
|
+
"envVariablesSection": {
|
|
1714
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1715
|
+
"body": [
|
|
1716
|
+
{
|
|
1717
|
+
"name": "SF_TARGET_ORG",
|
|
1718
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1719
|
+
}
|
|
1720
|
+
]
|
|
1721
|
+
},
|
|
1722
|
+
"errorCodes": {
|
|
1723
|
+
"header": "ERROR CODES",
|
|
1724
|
+
"body": [
|
|
1725
|
+
{
|
|
1726
|
+
"name": "Succeeded (0)",
|
|
1727
|
+
"description": "Results retrieved successfully. Test results (passed/failed) are in the output."
|
|
1728
|
+
},
|
|
1729
|
+
{
|
|
1730
|
+
"name": "NotFound (2)",
|
|
1731
|
+
"description": "Job ID not found or invalid."
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"name": "Failed (4)",
|
|
1735
|
+
"description": "Failed to retrieve results due to API or network errors."
|
|
1736
|
+
}
|
|
1737
|
+
]
|
|
1738
|
+
},
|
|
1506
1739
|
"isESM": true,
|
|
1507
1740
|
"relativePath": [
|
|
1508
1741
|
"lib",
|
|
@@ -1627,6 +1860,36 @@
|
|
|
1627
1860
|
"strict": true,
|
|
1628
1861
|
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
1629
1862
|
"enableJsonFlag": true,
|
|
1863
|
+
"envVariablesSection": {
|
|
1864
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1865
|
+
"body": [
|
|
1866
|
+
{
|
|
1867
|
+
"name": "SF_TARGET_ORG",
|
|
1868
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1869
|
+
}
|
|
1870
|
+
]
|
|
1871
|
+
},
|
|
1872
|
+
"errorCodes": {
|
|
1873
|
+
"header": "ERROR CODES",
|
|
1874
|
+
"body": [
|
|
1875
|
+
{
|
|
1876
|
+
"name": "Succeeded (0)",
|
|
1877
|
+
"description": "Test completed successfully (with test results in the output)."
|
|
1878
|
+
},
|
|
1879
|
+
{
|
|
1880
|
+
"name": "Failed (1)",
|
|
1881
|
+
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"name": "NotFound (2)",
|
|
1885
|
+
"description": "Job ID not found or invalid."
|
|
1886
|
+
},
|
|
1887
|
+
{
|
|
1888
|
+
"name": "OperationFailed (4)",
|
|
1889
|
+
"description": "Failed to poll test due to API or network errors."
|
|
1890
|
+
}
|
|
1891
|
+
]
|
|
1892
|
+
},
|
|
1630
1893
|
"isESM": true,
|
|
1631
1894
|
"relativePath": [
|
|
1632
1895
|
"lib",
|
|
@@ -1756,6 +2019,36 @@
|
|
|
1756
2019
|
"strict": true,
|
|
1757
2020
|
"summary": "Run evaluation tests against an Agentforce agent.",
|
|
1758
2021
|
"enableJsonFlag": true,
|
|
2022
|
+
"envVariablesSection": {
|
|
2023
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2024
|
+
"body": [
|
|
2025
|
+
{
|
|
2026
|
+
"name": "SF_TARGET_ORG",
|
|
2027
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2028
|
+
}
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
"errorCodes": {
|
|
2032
|
+
"header": "ERROR CODES",
|
|
2033
|
+
"body": [
|
|
2034
|
+
{
|
|
2035
|
+
"name": "Succeeded (0)",
|
|
2036
|
+
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
2037
|
+
},
|
|
2038
|
+
{
|
|
2039
|
+
"name": "Failed (1)",
|
|
2040
|
+
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "NotFound (2)",
|
|
2044
|
+
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"name": "OperationFailed (4)",
|
|
2048
|
+
"description": "Failed to execute tests due to API or network errors."
|
|
2049
|
+
}
|
|
2050
|
+
]
|
|
2051
|
+
},
|
|
1759
2052
|
"isESM": true,
|
|
1760
2053
|
"relativePath": [
|
|
1761
2054
|
"lib",
|
|
@@ -1872,6 +2165,36 @@
|
|
|
1872
2165
|
"strict": true,
|
|
1873
2166
|
"summary": "Start an agent test in your org.",
|
|
1874
2167
|
"enableJsonFlag": true,
|
|
2168
|
+
"envVariablesSection": {
|
|
2169
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2170
|
+
"body": [
|
|
2171
|
+
{
|
|
2172
|
+
"name": "SF_TARGET_ORG",
|
|
2173
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2174
|
+
}
|
|
2175
|
+
]
|
|
2176
|
+
},
|
|
2177
|
+
"errorCodes": {
|
|
2178
|
+
"header": "ERROR CODES",
|
|
2179
|
+
"body": [
|
|
2180
|
+
{
|
|
2181
|
+
"name": "Succeeded (0)",
|
|
2182
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
2183
|
+
},
|
|
2184
|
+
{
|
|
2185
|
+
"name": "Failed (1)",
|
|
2186
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
2187
|
+
},
|
|
2188
|
+
{
|
|
2189
|
+
"name": "NotFound (2)",
|
|
2190
|
+
"description": "Test definition not found or invalid test name."
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "OperationFailed (4)",
|
|
2194
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
2195
|
+
}
|
|
2196
|
+
]
|
|
2197
|
+
},
|
|
1875
2198
|
"isESM": true,
|
|
1876
2199
|
"relativePath": [
|
|
1877
2200
|
"lib",
|
|
@@ -1950,6 +2273,36 @@
|
|
|
1950
2273
|
"summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
|
|
1951
2274
|
"enableJsonFlag": true,
|
|
1952
2275
|
"requiresProject": true,
|
|
2276
|
+
"envVariablesSection": {
|
|
2277
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2278
|
+
"body": [
|
|
2279
|
+
{
|
|
2280
|
+
"name": "SF_TARGET_ORG",
|
|
2281
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2282
|
+
}
|
|
2283
|
+
]
|
|
2284
|
+
},
|
|
2285
|
+
"errorCodes": {
|
|
2286
|
+
"header": "ERROR CODES",
|
|
2287
|
+
"body": [
|
|
2288
|
+
{
|
|
2289
|
+
"name": "Succeeded (0)",
|
|
2290
|
+
"description": "Agent Script file compiled successfully without errors."
|
|
2291
|
+
},
|
|
2292
|
+
{
|
|
2293
|
+
"name": "Failed (1)",
|
|
2294
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
2295
|
+
},
|
|
2296
|
+
{
|
|
2297
|
+
"name": "NotFound (2)",
|
|
2298
|
+
"description": "Validation/compilation API returned HTTP 404. The API endpoint may not be available in your org or region."
|
|
2299
|
+
},
|
|
2300
|
+
{
|
|
2301
|
+
"name": "ServerError (3)",
|
|
2302
|
+
"description": "Validation/compilation API returned HTTP 500. A server error occurred during compilation."
|
|
2303
|
+
}
|
|
2304
|
+
]
|
|
2305
|
+
},
|
|
1953
2306
|
"FLAGGABLE_PROMPTS": {
|
|
1954
2307
|
"api-name": {
|
|
1955
2308
|
"message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
@@ -1975,5 +2328,5 @@
|
|
|
1975
2328
|
]
|
|
1976
2329
|
}
|
|
1977
2330
|
},
|
|
1978
|
-
"version": "1.32.
|
|
2331
|
+
"version": "1.32.15"
|
|
1979
2332
|
}
|