@salesforce/plugin-agent 1.26.4 → 1.26.6

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.
@@ -248,7 +248,7 @@
248
248
  "agent:preview": {
249
249
  "aliases": [],
250
250
  "args": {},
251
- "description": "Use this command to have a natural language conversation with an agent while you code its Agent Script file. Previewing an agent works like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.\n\nThis command uses the agent's local authoring bundle, which contains its Agent Script file. You can let the command provide a list of authoring bundles (labeled \"(Agent Script)\") to choose from or use the --authoring-bundle flag to specify a bundle's API name.\n\nYou can use these two modes when previewing an agent from its Agent Script file:\n\n- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, and prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.\n- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview. You can use the Apex Replay Debugger to debug your Apex classes when using live mode.\n\nThe interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory with the --output-dir flag.\n\nNOTE: You can also use this command to connect to a published and active agent, which are labeled \"(Published)\" if you let this command provide the list of agents to preview. That use case, however, requires additional security and configuration in both your org and your DX project. The examples in this help are for previewing an agent from its Agent Script file in your DX project and require only simple authorization of your org, such as with the \"org login web\" command. The --client-app and --api-name flags are used only for previewing published and active agents, they don't apply to Agent Script agents. See \"Connect to a Published Agent\" in the \"Agentforce Developer Guide\" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.",
251
+ "description": "Use this command to have a natural language conversation with an agent while you code its Agent Script file. Previewing an agent works like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.\n\nThis command uses the agent's local authoring bundle, which contains its Agent Script file. You can let the command provide a list of authoring bundles (labeled \"(Agent Script)\") to choose from or use the --authoring-bundle flag to specify a bundle's API name.\n\nYou can use these two modes when previewing an agent from its Agent Script file:\n\n- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, and prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.\n- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview. You can use the Apex Replay Debugger to debug your Apex classes when using live mode.\n\nThe interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory with the --output-dir flag.",
252
252
  "examples": [
253
253
  "Preview an agent in simulated mode by choosing from a list of authoring bundles provided by the command; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --target-org my-dev-org",
254
254
  "Preview an agent in live mode by choosing from a list of authoring bundles. Save the conversation transcripts to the \"./transcripts/my-preview\" directory, enable the Apex debug logs, and use your default org:\n<%= config.bin %> <%= command.id %> --use-live-actions --apex-debug --output-dir transcripts/my-preview"
@@ -279,17 +279,6 @@
279
279
  "multiple": false,
280
280
  "type": "option"
281
281
  },
282
- "client-app": {
283
- "char": "c",
284
- "dependsOn": [
285
- "target-org"
286
- ],
287
- "name": "client-app",
288
- "summary": "Name of the linked client app to use for the connection to the published and active agent.",
289
- "hasDynamicHelp": false,
290
- "multiple": false,
291
- "type": "option"
292
- },
293
282
  "api-name": {
294
283
  "char": "n",
295
284
  "name": "api-name",
@@ -807,6 +796,91 @@
807
796
  "test-spec:generate:agent"
808
797
  ]
809
798
  },
799
+ "agent:publish:authoring-bundle": {
800
+ "aliases": [],
801
+ "args": {},
802
+ "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, and then the authoring bundle metadata (AiAuthoringBundle) is deployed to your org. \n\nThis command uses the API name of the authoring bundle.",
803
+ "examples": [
804
+ "Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
805
+ "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"
806
+ ],
807
+ "flags": {
808
+ "json": {
809
+ "description": "Format output as json.",
810
+ "helpGroup": "GLOBAL",
811
+ "name": "json",
812
+ "allowNo": false,
813
+ "type": "boolean"
814
+ },
815
+ "flags-dir": {
816
+ "helpGroup": "GLOBAL",
817
+ "name": "flags-dir",
818
+ "summary": "Import flag values from a directory.",
819
+ "hasDynamicHelp": false,
820
+ "multiple": false,
821
+ "type": "option"
822
+ },
823
+ "target-org": {
824
+ "char": "o",
825
+ "name": "target-org",
826
+ "noCacheDefault": true,
827
+ "required": true,
828
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
829
+ "hasDynamicHelp": true,
830
+ "multiple": false,
831
+ "type": "option"
832
+ },
833
+ "api-version": {
834
+ "description": "Override the api version used for api requests made by this command",
835
+ "name": "api-version",
836
+ "hasDynamicHelp": false,
837
+ "multiple": false,
838
+ "type": "option"
839
+ },
840
+ "api-name": {
841
+ "char": "n",
842
+ "name": "api-name",
843
+ "summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
844
+ "hasDynamicHelp": false,
845
+ "multiple": false,
846
+ "type": "option"
847
+ }
848
+ },
849
+ "hasDynamicHelp": true,
850
+ "hiddenAliases": [],
851
+ "id": "agent:publish:authoring-bundle",
852
+ "pluginAlias": "@salesforce/plugin-agent",
853
+ "pluginName": "@salesforce/plugin-agent",
854
+ "pluginType": "core",
855
+ "state": "beta",
856
+ "strict": true,
857
+ "summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
858
+ "enableJsonFlag": true,
859
+ "requiresProject": true,
860
+ "FLAGGABLE_PROMPTS": {
861
+ "api-name": {
862
+ "message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
863
+ "promptMessage": "API name of the authoring bundle to publish"
864
+ }
865
+ },
866
+ "isESM": true,
867
+ "relativePath": [
868
+ "lib",
869
+ "commands",
870
+ "agent",
871
+ "publish",
872
+ "authoring-bundle.js"
873
+ ],
874
+ "aliasPermutations": [],
875
+ "permutations": [
876
+ "agent:publish:authoring-bundle",
877
+ "publish:agent:authoring-bundle",
878
+ "publish:authoring-bundle:agent",
879
+ "agent:authoring-bundle:publish",
880
+ "authoring-bundle:agent:publish",
881
+ "authoring-bundle:publish:agent"
882
+ ]
883
+ },
810
884
  "agent:test:create": {
811
885
  "aliases": [],
812
886
  "args": {},
@@ -1405,92 +1479,7 @@
1405
1479
  "authoring-bundle:agent:validate",
1406
1480
  "authoring-bundle:validate:agent"
1407
1481
  ]
1408
- },
1409
- "agent:publish:authoring-bundle": {
1410
- "aliases": [],
1411
- "args": {},
1412
- "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, and then the authoring bundle metadata (AiAuthoringBundle) is deployed to your org. \n\nThis command uses the API name of the authoring bundle.",
1413
- "examples": [
1414
- "Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
1415
- "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"
1416
- ],
1417
- "flags": {
1418
- "json": {
1419
- "description": "Format output as json.",
1420
- "helpGroup": "GLOBAL",
1421
- "name": "json",
1422
- "allowNo": false,
1423
- "type": "boolean"
1424
- },
1425
- "flags-dir": {
1426
- "helpGroup": "GLOBAL",
1427
- "name": "flags-dir",
1428
- "summary": "Import flag values from a directory.",
1429
- "hasDynamicHelp": false,
1430
- "multiple": false,
1431
- "type": "option"
1432
- },
1433
- "target-org": {
1434
- "char": "o",
1435
- "name": "target-org",
1436
- "noCacheDefault": true,
1437
- "required": true,
1438
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1439
- "hasDynamicHelp": true,
1440
- "multiple": false,
1441
- "type": "option"
1442
- },
1443
- "api-version": {
1444
- "description": "Override the api version used for api requests made by this command",
1445
- "name": "api-version",
1446
- "hasDynamicHelp": false,
1447
- "multiple": false,
1448
- "type": "option"
1449
- },
1450
- "api-name": {
1451
- "char": "n",
1452
- "name": "api-name",
1453
- "summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
1454
- "hasDynamicHelp": false,
1455
- "multiple": false,
1456
- "type": "option"
1457
- }
1458
- },
1459
- "hasDynamicHelp": true,
1460
- "hiddenAliases": [],
1461
- "id": "agent:publish:authoring-bundle",
1462
- "pluginAlias": "@salesforce/plugin-agent",
1463
- "pluginName": "@salesforce/plugin-agent",
1464
- "pluginType": "core",
1465
- "state": "beta",
1466
- "strict": true,
1467
- "summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
1468
- "enableJsonFlag": true,
1469
- "requiresProject": true,
1470
- "FLAGGABLE_PROMPTS": {
1471
- "api-name": {
1472
- "message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
1473
- "promptMessage": "API name of the authoring bundle to publish"
1474
- }
1475
- },
1476
- "isESM": true,
1477
- "relativePath": [
1478
- "lib",
1479
- "commands",
1480
- "agent",
1481
- "publish",
1482
- "authoring-bundle.js"
1483
- ],
1484
- "aliasPermutations": [],
1485
- "permutations": [
1486
- "agent:publish:authoring-bundle",
1487
- "publish:agent:authoring-bundle",
1488
- "publish:authoring-bundle:agent",
1489
- "agent:authoring-bundle:publish",
1490
- "authoring-bundle:agent:publish",
1491
- "authoring-bundle:publish:agent"
1492
- ]
1493
1482
  }
1494
1483
  },
1495
- "version": "1.26.4"
1484
+ "version": "1.26.6"
1496
1485
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-agent",
3
3
  "description": "Commands to interact with Salesforce agents",
4
- "version": "1.26.4",
4
+ "version": "1.26.6",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -9,11 +9,11 @@
9
9
  "@inquirer/prompts": "^7.10.1",
10
10
  "@oclif/core": "^4",
11
11
  "@oclif/multi-stage-output": "^0.8.29",
12
- "@salesforce/agents": "^0.20.0",
12
+ "@salesforce/agents": "^0.21.1",
13
13
  "@salesforce/core": "^8.24.3",
14
14
  "@salesforce/kit": "^3.2.3",
15
15
  "@salesforce/sf-plugins-core": "^12.2.6",
16
- "@salesforce/source-deploy-retrieve": "^12.31.6",
16
+ "@salesforce/source-deploy-retrieve": "^12.31.7",
17
17
  "@salesforce/types": "^1.5.0",
18
18
  "ansis": "^3.3.2",
19
19
  "fast-xml-parser": "^4.5.1",
@@ -237,7 +237,7 @@
237
237
  "exports": "./lib/index.js",
238
238
  "type": "module",
239
239
  "sfdx": {
240
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.4.crt",
241
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.4.sig"
240
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.6.crt",
241
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.6.sig"
242
242
  }
243
243
  }