@salesforce/plugin-agent 1.24.14-demo.8 → 1.24.14-nga.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +74 -46
- package/lib/commands/agent/generate/authoring-bundle.js +1 -1
- package/lib/commands/agent/generate/authoring-bundle.js.map +1 -1
- package/lib/commands/agent/preview.d.ts +4 -10
- package/lib/commands/agent/preview.js +104 -44
- package/lib/commands/agent/preview.js.map +1 -1
- package/lib/commands/agent/publish/authoring-bundle.js +9 -3
- package/lib/commands/agent/publish/authoring-bundle.js.map +1 -1
- package/lib/commands/agent/validate/authoring-bundle.js +16 -12
- package/lib/commands/agent/validate/authoring-bundle.js.map +1 -1
- package/lib/common.d.ts +8 -0
- package/lib/common.js +39 -0
- package/lib/common.js.map +1 -0
- package/lib/components/agent-preview-react.d.ts +3 -2
- package/lib/components/agent-preview-react.js +36 -13
- package/lib/components/agent-preview-react.js.map +1 -1
- package/messages/agent.generate.authoring-bundle.md +16 -12
- package/messages/agent.preview.md +7 -3
- package/messages/agent.publish.authoring-bundle.md +14 -9
- package/messages/agent.validate.authoring-bundle.md +14 -9
- package/oclif.manifest.json +29 -23
- package/package.json +7 -5
package/oclif.manifest.json
CHANGED
|
@@ -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 active agent in your org, as if you were an actual user. The 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\nThis command is useful to test if the agent 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 Conversation Preview panel in your org's Agent Builder UI.\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 by setting the environment variable \"SF_AGENT_PREVIEW_OUTPUT_DIR\" to the directory. Or you can pass the directory to the --output-dir flag.\n\nFind the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup. If your agent is currently deactivated, use the \"agent activate\" CLI command to activate it.\n\nIMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX project. The examples in this help assume you've completed the steps. See \"Preview an 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 active agent in your org, as if you were an actual user. The 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\nThis command is useful to test if the agent 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 Conversation Preview panel in your org's Agent Builder UI.\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 by setting the environment variable \"SF_AGENT_PREVIEW_OUTPUT_DIR\" to the directory. Or you can pass the directory to the --output-dir flag.\n\nFind the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup. If your agent is currently deactivated, use the \"agent activate\" CLI command to activate it.\n\nIMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX project. For example, you must first create the link to a client connected app using the \"org login web --client-app\" CLI command to then get the value of the --client-app flag of this command. The examples in this help assume you've completed the steps. See \"Preview an Agent\" in the \"Agentforce Developer Guide\" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.",
|
|
252
252
|
"examples": [
|
|
253
253
|
"Interact with an agent with API name Resort_Manager in the org with alias \"my-org\" and the linked \"agent-app\" connected app:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org --client-app agent-app",
|
|
254
254
|
"Same as the preceding example, but this time save the conversation transcripts to the \"./transcripts/my-preview\" directory rather than the default \"./temp/agent-preview\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org --client-app agent-app --output-dir transcripts/my-preview"
|
|
@@ -285,7 +285,7 @@
|
|
|
285
285
|
"target-org"
|
|
286
286
|
],
|
|
287
287
|
"name": "client-app",
|
|
288
|
-
"summary": "Name of the linked client app to use for the agent connection.
|
|
288
|
+
"summary": "Name of the linked client app to use for the agent connection.",
|
|
289
289
|
"hasDynamicHelp": false,
|
|
290
290
|
"multiple": false,
|
|
291
291
|
"type": "option"
|
|
@@ -300,7 +300,7 @@
|
|
|
300
300
|
},
|
|
301
301
|
"authoring-bundle": {
|
|
302
302
|
"name": "authoring-bundle",
|
|
303
|
-
"summary": "Preview
|
|
303
|
+
"summary": "Preview a next-gen agent by specifying the API name of the authoring bundle metadata component that implements it.",
|
|
304
304
|
"hasDynamicHelp": false,
|
|
305
305
|
"multiple": false,
|
|
306
306
|
"type": "option"
|
|
@@ -319,6 +319,12 @@
|
|
|
319
319
|
"summary": "Enable Apex debug logging during the agent preview conversation.",
|
|
320
320
|
"allowNo": false,
|
|
321
321
|
"type": "boolean"
|
|
322
|
+
},
|
|
323
|
+
"use-live-actions": {
|
|
324
|
+
"name": "use-live-actions",
|
|
325
|
+
"summary": "Use real actions in the org; if not specified, preview uses AI to mock actions.",
|
|
326
|
+
"allowNo": false,
|
|
327
|
+
"type": "boolean"
|
|
322
328
|
}
|
|
323
329
|
},
|
|
324
330
|
"hasDynamicHelp": true,
|
|
@@ -540,10 +546,10 @@
|
|
|
540
546
|
"agent:generate:authoring-bundle": {
|
|
541
547
|
"aliases": [],
|
|
542
548
|
"args": {},
|
|
543
|
-
"description": "
|
|
549
|
+
"description": "Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is AiAuthoringBundle and they consist of a standard \"\\*-meta.xml\" metadata file and an agent file (with extension \".agent\") that fully describes the next-gen agent. Use this command to generate an authoring bundle based on an agent spec YAML file, which you create with the \"agent create agent-spec\" command.\n\nBy default, authoring bundles are generated in the force-app/main/default/aiAuthoringBundles/<api-name> directory. Use the --output-dir to generate them elsewhere.",
|
|
544
550
|
"examples": [
|
|
545
|
-
"Generate an authoring bundle from
|
|
546
|
-
"
|
|
551
|
+
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\":\n<%= config.bin %> <%= command.id %> --spec-file specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
552
|
+
"Same as previous example, but generate the files in the other-package-dir/main/default/aiAuthoringBundles directory:\n<%= config.bin %> <%= command.id %> --spec-file specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default/aiAuthoringBundles"
|
|
547
553
|
],
|
|
548
554
|
"flags": {
|
|
549
555
|
"json": {
|
|
@@ -573,7 +579,7 @@
|
|
|
573
579
|
},
|
|
574
580
|
"api-name": {
|
|
575
581
|
"name": "api-name",
|
|
576
|
-
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name
|
|
582
|
+
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
577
583
|
"hasDynamicHelp": false,
|
|
578
584
|
"multiple": false,
|
|
579
585
|
"type": "option"
|
|
@@ -588,7 +594,7 @@
|
|
|
588
594
|
"spec": {
|
|
589
595
|
"char": "f",
|
|
590
596
|
"name": "spec",
|
|
591
|
-
"summary": "Path to the agent
|
|
597
|
+
"summary": "Path to the agent spec YAML file.",
|
|
592
598
|
"hasDynamicHelp": false,
|
|
593
599
|
"multiple": false,
|
|
594
600
|
"type": "option"
|
|
@@ -596,7 +602,7 @@
|
|
|
596
602
|
"output-dir": {
|
|
597
603
|
"char": "d",
|
|
598
604
|
"name": "output-dir",
|
|
599
|
-
"summary": "Directory where the authoring bundle files
|
|
605
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
600
606
|
"hasDynamicHelp": false,
|
|
601
607
|
"multiple": false,
|
|
602
608
|
"type": "option"
|
|
@@ -617,7 +623,7 @@
|
|
|
617
623
|
"pluginName": "@salesforce/plugin-agent",
|
|
618
624
|
"pluginType": "core",
|
|
619
625
|
"strict": true,
|
|
620
|
-
"summary": "Generate
|
|
626
|
+
"summary": "Generate a local authoring bundle from an existing agent spec YAML file.",
|
|
621
627
|
"enableJsonFlag": true,
|
|
622
628
|
"requiresProject": true,
|
|
623
629
|
"FLAGGABLE_PROMPTS": {
|
|
@@ -626,11 +632,11 @@
|
|
|
626
632
|
"required": true
|
|
627
633
|
},
|
|
628
634
|
"api-name": {
|
|
629
|
-
"message": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name
|
|
635
|
+
"message": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
630
636
|
"promptMessage": "API name of the new authoring bundle"
|
|
631
637
|
},
|
|
632
638
|
"spec": {
|
|
633
|
-
"message": "Path to the agent
|
|
639
|
+
"message": "Path to the agent spec YAML file.",
|
|
634
640
|
"required": true
|
|
635
641
|
}
|
|
636
642
|
},
|
|
@@ -799,9 +805,9 @@
|
|
|
799
805
|
"agent:publish:authoring-bundle": {
|
|
800
806
|
"aliases": [],
|
|
801
807
|
"args": {},
|
|
802
|
-
"description": "
|
|
808
|
+
"description": "When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the agent file (with extension \".agent\") successfully compiles. Then the authoring bundle metadata component is deployed to the org, and all associated metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated. The org then creates a new next-gen agent based on the deployed authoring bundle and associated metadata. Finally, all the metadata associated with the new agent is retrieved back to your local DX project.\n\nAuthoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is AiAuthoringBundle and they consist of a standard \"\\*-meta.xml\" metadata file and an agent file (with extension \".agent\") that fully describes the next-gen agent.\n\nThis command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the command prompts you for it.",
|
|
803
809
|
"examples": [
|
|
804
|
-
"Publish an
|
|
810
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-org\", resulting in a new agent named \"My Fab Agent\"::\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --agent-name \"My Fab Agent\" --target-org my-org"
|
|
805
811
|
],
|
|
806
812
|
"flags": {
|
|
807
813
|
"json": {
|
|
@@ -839,7 +845,7 @@
|
|
|
839
845
|
"api-name": {
|
|
840
846
|
"char": "n",
|
|
841
847
|
"name": "api-name",
|
|
842
|
-
"summary": "API name of the
|
|
848
|
+
"summary": "API name of the authoring bundle you want to publish.",
|
|
843
849
|
"hasDynamicHelp": false,
|
|
844
850
|
"multiple": false,
|
|
845
851
|
"type": "option"
|
|
@@ -852,12 +858,12 @@
|
|
|
852
858
|
"pluginName": "@salesforce/plugin-agent",
|
|
853
859
|
"pluginType": "core",
|
|
854
860
|
"strict": true,
|
|
855
|
-
"summary": "Publish an
|
|
861
|
+
"summary": "Publish an authoring bundle to your org, which results in a new next-gen agent.",
|
|
856
862
|
"enableJsonFlag": true,
|
|
857
863
|
"requiresProject": true,
|
|
858
864
|
"FLAGGABLE_PROMPTS": {
|
|
859
865
|
"api-name": {
|
|
860
|
-
"message": "API name of the
|
|
866
|
+
"message": "API name of the authoring bundle you want to publish.",
|
|
861
867
|
"promptMessage": "API name of the authoring bundle to publish"
|
|
862
868
|
}
|
|
863
869
|
},
|
|
@@ -1396,9 +1402,9 @@
|
|
|
1396
1402
|
"agent:validate:authoring-bundle": {
|
|
1397
1403
|
"aliases": [],
|
|
1398
1404
|
"args": {},
|
|
1399
|
-
"description": "
|
|
1405
|
+
"description": "Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is AiAuthoringBundle and they consist of a standard \"\\*-meta.xml\" metadata file and an agent file (with extension \".agent\") that fully describes the next-gen agent. Generate a local authoring bundle with the \"agent generate authoring-bundle\" command.\n\nThis command validates that the agent file (with extension \".agent\") that's part of the authoring bundle compiles without errors and can later be used to successfully create a next-gen agent.\n\nThis command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the command prompts you for it.",
|
|
1400
1406
|
"examples": [
|
|
1401
|
-
"Validate
|
|
1407
|
+
"Validate a local authoring bundle with API name MyAuthoringBundle:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle"
|
|
1402
1408
|
],
|
|
1403
1409
|
"flags": {
|
|
1404
1410
|
"json": {
|
|
@@ -1436,7 +1442,7 @@
|
|
|
1436
1442
|
"api-name": {
|
|
1437
1443
|
"char": "n",
|
|
1438
1444
|
"name": "api-name",
|
|
1439
|
-
"summary": "API name of the
|
|
1445
|
+
"summary": "API name of the authoring bundle you want to validate.",
|
|
1440
1446
|
"hasDynamicHelp": false,
|
|
1441
1447
|
"multiple": false,
|
|
1442
1448
|
"type": "option"
|
|
@@ -1449,12 +1455,12 @@
|
|
|
1449
1455
|
"pluginName": "@salesforce/plugin-agent",
|
|
1450
1456
|
"pluginType": "core",
|
|
1451
1457
|
"strict": true,
|
|
1452
|
-
"summary": "Validate
|
|
1458
|
+
"summary": "Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.",
|
|
1453
1459
|
"enableJsonFlag": true,
|
|
1454
1460
|
"requiresProject": true,
|
|
1455
1461
|
"FLAGGABLE_PROMPTS": {
|
|
1456
1462
|
"api-name": {
|
|
1457
|
-
"message": "API name of the
|
|
1463
|
+
"message": "API name of the authoring bundle you want to validate.",
|
|
1458
1464
|
"promptMessage": "API name of the authoring bundle to validate"
|
|
1459
1465
|
}
|
|
1460
1466
|
},
|
|
@@ -1477,5 +1483,5 @@
|
|
|
1477
1483
|
]
|
|
1478
1484
|
}
|
|
1479
1485
|
},
|
|
1480
|
-
"version": "1.24.14-
|
|
1486
|
+
"version": "1.24.14-nga.0"
|
|
1481
1487
|
}
|
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.24.14-
|
|
4
|
+
"version": "1.24.14-nga.0",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -9,14 +9,16 @@
|
|
|
9
9
|
"@inquirer/prompts": "^7.8.6",
|
|
10
10
|
"@oclif/core": "^4",
|
|
11
11
|
"@oclif/multi-stage-output": "^0.8.23",
|
|
12
|
-
"@salesforce/agents": "
|
|
12
|
+
"@salesforce/agents": "nga",
|
|
13
13
|
"@salesforce/core": "^8.23.1",
|
|
14
14
|
"@salesforce/kit": "^3.2.3",
|
|
15
15
|
"@salesforce/sf-plugins-core": "^12.2.4",
|
|
16
|
-
"@salesforce/source-deploy-retrieve": "^12.
|
|
16
|
+
"@salesforce/source-deploy-retrieve": "^12.25.0",
|
|
17
17
|
"@salesforce/types": "^1.4.0",
|
|
18
|
+
"@types/glob": "^9.0.0",
|
|
18
19
|
"ansis": "^3.3.2",
|
|
19
20
|
"fast-xml-parser": "^4.5.1",
|
|
21
|
+
"glob": "^11.0.3",
|
|
20
22
|
"ink": "5.0.1",
|
|
21
23
|
"ink-text-input": "^6.0.0",
|
|
22
24
|
"inquirer-autocomplete-standalone": "^0.8.1",
|
|
@@ -229,7 +231,7 @@
|
|
|
229
231
|
"exports": "./lib/index.js",
|
|
230
232
|
"type": "module",
|
|
231
233
|
"sfdx": {
|
|
232
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-
|
|
233
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-
|
|
234
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-nga.0.crt",
|
|
235
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-nga.0.sig"
|
|
234
236
|
}
|
|
235
237
|
}
|