@salesforce/plugin-agent 1.24.14-demo.8 → 1.24.14-demo.9

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 CHANGED
@@ -112,7 +112,7 @@ EXAMPLES
112
112
  $ sf agent activate --api-name Resort_Manager --target-org my-org
113
113
  ```
114
114
 
115
- _See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/activate.ts)_
115
+ _See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/activate.ts)_
116
116
 
117
117
  ## `sf agent create`
118
118
 
@@ -174,7 +174,7 @@ EXAMPLES
174
174
  $ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
175
175
  ```
176
176
 
177
- _See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/create.ts)_
177
+ _See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/create.ts)_
178
178
 
179
179
  ## `sf agent deactivate`
180
180
 
@@ -214,7 +214,7 @@ EXAMPLES
214
214
  $ sf agent deactivate --api-name Resort_Manager --target-org my-org
215
215
  ```
216
216
 
217
- _See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/deactivate.ts)_
217
+ _See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/deactivate.ts)_
218
218
 
219
219
  ## `sf agent generate agent-spec`
220
220
 
@@ -319,11 +319,11 @@ EXAMPLES
319
319
  $ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
320
320
  ```
321
321
 
322
- _See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/generate/agent-spec.ts)_
322
+ _See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/generate/agent-spec.ts)_
323
323
 
324
324
  ## `sf agent generate authoring-bundle`
325
325
 
326
- Generate an authoring bundle from an agent specification.
326
+ Generate a local authoring bundle from an existing agent spec YAML file.
327
327
 
328
328
  ```
329
329
  USAGE
@@ -331,13 +331,13 @@ USAGE
331
331
  <value>] [-d <value>] [-n <value>]
332
332
 
333
333
  FLAGS
334
- -d, --output-dir=<value> Directory where the authoring bundle files will be generated.
335
- -f, --spec=<value> Path to the agent specification file.
334
+ -d, --output-dir=<value> Directory where the authoring bundle files are generated.
335
+ -f, --spec=<value> Path to the agent spec YAML file.
336
336
  -n, --name=<value> Name (label) of the authoring bundle.
337
337
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
338
338
  configuration variable is already set.
339
339
  --api-name=<value> API name of the new authoring bundle; if not specified, the API name is derived from the
340
- authoring bundle name (label); the API name must not exist in the org.
340
+ authoring bundle name (label); the API name can't exist in the org.
341
341
  --api-version=<value> Override the api version used for api requests made by this command
342
342
 
343
343
  GLOBAL FLAGS
@@ -345,22 +345,29 @@ GLOBAL FLAGS
345
345
  --json Format output as json.
346
346
 
347
347
  DESCRIPTION
348
- Generate an authoring bundle from an agent specification.
348
+ Generate a local authoring bundle from an existing agent spec YAML file.
349
349
 
350
- Generates an authoring bundle containing Agent and its meta.xml file from an agent specification file.
350
+ Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is
351
+ AiAuthoringBundle and they consist of a standard "\*-meta.xml" metadata file and an agent file (with extension
352
+ ".agent") that fully describes the next-gen agent. Use this command to generate an authoring bundle based on an agent
353
+ spec YAML file, which you create with the "agent create agent-spec" command.
354
+
355
+ By default, authoring bundles are generated in the force-app/main/default/aiAuthoringBundles/<api-name> directory. Use
356
+ the --output-dir to generate them elsewhere.
351
357
 
352
358
  EXAMPLES
353
- Generate an authoring bundle from a specification file:
359
+ Generate an authoring bundle from the "specs/agentSpec.yaml" agent spec YAML file and give it the label "My
360
+ Authoring Bundle":
354
361
 
355
- $ sf agent generate authoring-bundle --spec-file path/to/spec.yaml --name "My Authoring Bundle"
362
+ $ sf agent generate authoring-bundle --spec-file specs/agentSpec.yaml --name "My Authoring Bundle"
356
363
 
357
- Generate an authoring bundle with a custom output directory:
364
+ Same as previous example, but generate the files in the other-package-dir/main/default/aiAuthoringBundles directory:
358
365
 
359
- $ sf agent generate authoring-bundle --spec-file path/to/spec.yaml --name "My Authoring Bundle" --output-dir \
360
- path/to/output
366
+ $ sf agent generate authoring-bundle --spec-file specs/agentSpec.yaml --name "My Authoring Bundle" --output-dir \
367
+ other-package-dir/main/default/aiAuthoringBundles
361
368
  ```
362
369
 
363
- _See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/generate/authoring-bundle.ts)_
370
+ _See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/generate/authoring-bundle.ts)_
364
371
 
365
372
  ## `sf agent generate template`
366
373
 
@@ -408,7 +415,7 @@ EXAMPLES
408
415
  force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
409
416
  ```
410
417
 
411
- _See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/generate/template.ts)_
418
+ _See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/generate/template.ts)_
412
419
 
413
420
  ## `sf agent generate test-spec`
414
421
 
@@ -469,7 +476,7 @@ EXAMPLES
469
476
  force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
470
477
  ```
471
478
 
472
- _See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/generate/test-spec.ts)_
479
+ _See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/generate/test-spec.ts)_
473
480
 
474
481
  ## `sf agent preview`
475
482
 
@@ -481,16 +488,15 @@ USAGE
481
488
  [--authoring-bundle <value>] [-d <value>] [-x]
482
489
 
483
490
  FLAGS
484
- -c, --client-app=<value> Name of the linked client app to use for the agent connection. You must have
485
- previously created this link with "org login web --client-app". Run "org display" to
486
- see the available linked client apps.
491
+ -c, --client-app=<value> Name of the linked client app to use for the agent connection.
487
492
  -d, --output-dir=<value> Directory where conversation transcripts are saved.
488
493
  -n, --api-name=<value> API name of the agent you want to interact with.
489
494
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
490
495
  configuration variable is already set.
491
496
  -x, --apex-debug Enable Apex debug logging during the agent preview conversation.
492
497
  --api-version=<value> Override the api version used for api requests made by this command
493
- --authoring-bundle=<value> Preview an ephemeral agent by specifying the API name of the Authoring Bundle metadata
498
+ --authoring-bundle=<value> Preview a next-gen agent by specifying the API name of the authoring bundle metadata
499
+ component that implements it.
494
500
 
495
501
  GLOBAL FLAGS
496
502
  --flags-dir=<value> Import flag values from a directory.
@@ -517,8 +523,9 @@ DESCRIPTION
517
523
  currently deactivated, use the "agent activate" CLI command to activate it.
518
524
 
519
525
  IMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX
520
- project. The examples in this help assume you've completed the steps. See "Preview an Agent" in the "Agentforce
521
- Developer Guide" for complete documentation:
526
+ project. For example, you must first create the link to a client connected app using the "org login web --client-app"
527
+ CLI command to then get the value of the --client-app flag of this command. The examples in this help assume you've
528
+ completed the steps. See "Preview an Agent" in the "Agentforce Developer Guide" for complete documentation:
522
529
  https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
523
530
 
524
531
  EXAMPLES
@@ -534,18 +541,18 @@ EXAMPLES
534
541
  transcripts/my-preview
535
542
  ```
536
543
 
537
- _See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/preview.ts)_
544
+ _See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/preview.ts)_
538
545
 
539
546
  ## `sf agent publish authoring-bundle`
540
547
 
541
- Publish an Agent Authoring Bundle as a new agent
548
+ Publish an authoring bundle to your org, which results in a new next-gen agent.
542
549
 
543
550
  ```
544
551
  USAGE
545
552
  $ sf agent publish authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
546
553
 
547
554
  FLAGS
548
- -n, --api-name=<value> API name of the Agent Authoring Bundle to publish.
555
+ -n, --api-name=<value> API name of the authoring bundle you want to publish.
549
556
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
550
557
  configuration variable is already set.
551
558
  --api-version=<value> Override the api version used for api requests made by this command
@@ -555,18 +562,29 @@ GLOBAL FLAGS
555
562
  --json Format output as json.
556
563
 
557
564
  DESCRIPTION
558
- Publish an Agent Authoring Bundle as a new agent
565
+ Publish an authoring bundle to your org, which results in a new next-gen agent.
566
+
567
+ When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the
568
+ agent file (with extension ".agent") successfully compiles. Then the authoring bundle metadata component is deployed
569
+ to the org, and all associated metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either
570
+ created or updated. The org then creates a new next-gen agent based on the deployed authoring bundle and associated
571
+ metadata. Finally, all the metadata associated with the new agent is retrieved back to your local DX project.
572
+
573
+ Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is
574
+ AiAuthoringBundle and they consist of a standard "\*-meta.xml" metadata file and an agent file (with extension
575
+ ".agent") that fully describes the next-gen agent.
559
576
 
560
- Publishes an Agent Authoring Bundle by compiling the .agent file and creating a new agent in your org.
577
+ This command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the
578
+ command prompts you for it.
561
579
 
562
580
  EXAMPLES
563
- Publish an Agent Authoring Bundle:
581
+ Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-org", resulting in a new agent
582
+ named "My Fab Agent"::
564
583
 
565
- $ sf agent publish authoring-bundle --api-name path/to/bundle --agent-name "My New Agent" --target-org \
566
- myorg@example.com
584
+ $ sf agent publish authoring-bundle --api-name MyAuthoringbundle --agent-name "My Fab Agent" --target-org my-org
567
585
  ```
568
586
 
569
- _See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/publish/authoring-bundle.ts)_
587
+ _See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/publish/authoring-bundle.ts)_
570
588
 
571
589
  ## `sf agent test create`
572
590
 
@@ -621,7 +639,7 @@ EXAMPLES
621
639
  $ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
622
640
  ```
623
641
 
624
- _See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/test/create.ts)_
642
+ _See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/test/create.ts)_
625
643
 
626
644
  ## `sf agent test list`
627
645
 
@@ -656,7 +674,7 @@ EXAMPLES
656
674
  $ sf agent test list --target-org my-org
657
675
  ```
658
676
 
659
- _See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/test/list.ts)_
677
+ _See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/test/list.ts)_
660
678
 
661
679
  ## `sf agent test results`
662
680
 
@@ -722,7 +740,7 @@ FLAG DESCRIPTIONS
722
740
  expression when using custom evaluations.
723
741
  ```
724
742
 
725
- _See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/test/results.ts)_
743
+ _See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/test/results.ts)_
726
744
 
727
745
  ## `sf agent test resume`
728
746
 
@@ -795,7 +813,7 @@ FLAG DESCRIPTIONS
795
813
  expression when using custom evaluations.
796
814
  ```
797
815
 
798
- _See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/test/resume.ts)_
816
+ _See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/test/resume.ts)_
799
817
 
800
818
  ## `sf agent test run`
801
819
 
@@ -869,18 +887,18 @@ FLAG DESCRIPTIONS
869
887
  expression when using custom evaluations.
870
888
  ```
871
889
 
872
- _See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/test/run.ts)_
890
+ _See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/test/run.ts)_
873
891
 
874
892
  ## `sf agent validate authoring-bundle`
875
893
 
876
- Validate an Agent Authoring Bundle
894
+ Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.
877
895
 
878
896
  ```
879
897
  USAGE
880
898
  $ sf agent validate authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
881
899
 
882
900
  FLAGS
883
- -n, --api-name=<value> API name of the Agent Authoring Bundle to validate.
901
+ -n, --api-name=<value> API name of the authoring bundle you want to validate.
884
902
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
885
903
  configuration variable is already set.
886
904
  --api-version=<value> Override the api version used for api requests made by this command
@@ -890,16 +908,25 @@ GLOBAL FLAGS
890
908
  --json Format output as json.
891
909
 
892
910
  DESCRIPTION
893
- Validate an Agent Authoring Bundle
911
+ Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.
912
+
913
+ Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is
914
+ AiAuthoringBundle and they consist of a standard "\*-meta.xml" metadata file and an agent file (with extension
915
+ ".agent") that fully describes the next-gen agent. Generate a local authoring bundle with the "agent generate
916
+ authoring-bundle" command.
917
+
918
+ This command validates that the agent file (with extension ".agent") that's part of the authoring bundle compiles
919
+ without errors and can later be used to successfully create a next-gen agent.
894
920
 
895
- Validates an Agent Authoring Bundle by compiling the .agent file and checking for errors.
921
+ This command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the
922
+ command prompts you for it.
896
923
 
897
924
  EXAMPLES
898
- Validate an Agent Authoring Bundle:
925
+ Validate a local authoring bundle with API name MyAuthoringBundle:
899
926
 
900
- $ sf agent validate authoring-bundle --api-name path/to/bundle
927
+ $ sf agent validate authoring-bundle --api-name MyAuthoringBundle
901
928
  ```
902
929
 
903
- _See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.8/src/commands/agent/validate/authoring-bundle.ts)_
930
+ _See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-demo.9/src/commands/agent/validate/authoring-bundle.ts)_
904
931
 
905
932
  <!-- commandsstop -->
@@ -1,18 +1,20 @@
1
1
  # summary
2
2
 
3
- Generate an authoring bundle from an agent specification.
3
+ Generate a local authoring bundle from an existing agent spec YAML file.
4
4
 
5
5
  # description
6
6
 
7
- Generates an authoring bundle containing Agent and its meta.xml file from an agent specification file.
7
+ 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.
8
+
9
+ By default, authoring bundles are generated in the force-app/main/default/aiAuthoringBundles/<api-name> directory. Use the --output-dir to generate them elsewhere.
8
10
 
9
11
  # flags.spec.summary
10
12
 
11
- Path to the agent specification file.
13
+ Path to the agent spec YAML file.
12
14
 
13
15
  # flags.output-dir.summary
14
16
 
15
- Directory where the authoring bundle files will be generated.
17
+ Directory where the authoring bundle files are generated.
16
18
 
17
19
  # flags.name.summary
18
20
 
@@ -20,7 +22,7 @@ Name (label) of the authoring bundle.
20
22
 
21
23
  # flags.api-name.summary
22
24
 
23
- API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name must not exist in the org.
25
+ 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.
24
26
 
25
27
  # flags.api-name.prompt
26
28
 
@@ -28,20 +30,22 @@ API name of the new authoring bundle
28
30
 
29
31
  # examples
30
32
 
31
- - Generate an authoring bundle from a specification file:
32
- <%= config.bin %> <%= command.id %> --spec-file path/to/spec.yaml --name "My Authoring Bundle"
33
+ - Generate an authoring bundle from the "specs/agentSpec.yaml" agent spec YAML file and give it the label "My Authoring Bundle":
34
+
35
+ <%= config.bin %> <%= command.id %> --spec-file specs/agentSpec.yaml --name "My Authoring Bundle"
36
+
37
+ - Same as previous example, but generate the files in the other-package-dir/main/default/aiAuthoringBundles directory:
33
38
 
34
- - Generate an authoring bundle with a custom output directory:
35
- <%= config.bin %> <%= command.id %> --spec-file path/to/spec.yaml --name "My Authoring Bundle" --output-dir path/to/output
39
+ <%= config.bin %> <%= command.id %> --spec-file specs/agentSpec.yaml --name "My Authoring Bundle" --output-dir other-package-dir/main/default/aiAuthoringBundles
36
40
 
37
41
  # error.no-spec-file
38
42
 
39
- No agent specification file found at the specified path.
43
+ No agent spec YAML file found at the specified path.
40
44
 
41
45
  # error.invalid-spec-file
42
46
 
43
- The specified file is not a valid agent specification file.
47
+ The specified file is not a valid agent spec YAML file.
44
48
 
45
49
  # error.failed-to-create-agent
46
50
 
47
- Failed to create Agent from the agent specification.
51
+ Failed to create a next-gen agent from the agent spec YAML file.
@@ -12,7 +12,7 @@ When the session concludes, the command asks if you want to save the API respons
12
12
 
13
13
  Find 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.
14
14
 
15
- IMPORTANT: 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.
15
+ IMPORTANT: 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.
16
16
 
17
17
  # flags.api-name.summary
18
18
 
@@ -20,11 +20,11 @@ API name of the agent you want to interact with.
20
20
 
21
21
  # flags.authoring-bundle.summary
22
22
 
23
- Preview an ephemeral agent by specifying the API name of the Authoring Bundle metadata
23
+ Preview a next-gen agent by specifying the API name of the authoring bundle metadata component that implements it.
24
24
 
25
25
  # flags.client-app.summary
26
26
 
27
- Name of the linked client app to use for the agent connection. You must have previously created this link with "org login web --client-app". Run "org display" to see the available linked client apps.
27
+ Name of the linked client app to use for the agent connection.
28
28
 
29
29
  # flags.output-dir.summary
30
30
 
@@ -1,19 +1,24 @@
1
1
  # summary
2
2
 
3
- Publish an Agent Authoring Bundle as a new agent
3
+ Publish an authoring bundle to your org, which results in a new next-gen agent.
4
4
 
5
5
  # description
6
6
 
7
- Publishes an Agent Authoring Bundle by compiling the .agent file and creating a new agent in your org.
7
+ 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.
8
+
9
+ 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.
10
+
11
+ This 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.
8
12
 
9
13
  # examples
10
14
 
11
- - Publish an Agent Authoring Bundle:
12
- <%= config.bin %> <%= command.id %> --api-name path/to/bundle --agent-name "My New Agent" --target-org myorg@example.com
15
+ - Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-org", resulting in a new agent named "My Fab Agent"::
16
+
17
+ <%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --agent-name "My Fab Agent" --target-org my-org
13
18
 
14
19
  # flags.api-name.summary
15
20
 
16
- API name of the Agent Authoring Bundle to publish.
21
+ API name of the authoring bundle you want to publish.
17
22
 
18
23
  # flags.api-name.prompt
19
24
 
@@ -21,15 +26,15 @@ API name of the authoring bundle to publish
21
26
 
22
27
  # flags.agent-name.summary
23
28
 
24
- Name for the new agent to be created
29
+ Name for the new agent that is created from the published authoring bundle.
25
30
 
26
31
  # error.missingRequiredFlags
27
32
 
28
- Required flag(s) missing: %s
33
+ Required flag(s) missing: %s.
29
34
 
30
35
  # error.invalidBundlePath
31
36
 
32
- Invalid bundle path. Please provide a valid path to an Agent Authoring Bundle.
37
+ Invalid bundle path. Provide a valid directory path to an authoring bundle.
33
38
 
34
39
  # error.publishFailed
35
40
 
@@ -42,4 +47,4 @@ Could not find a .bundle-meta.xml file with API name '%s' in the project.
42
47
 
43
48
  # error.agentNotFoundAction
44
49
 
45
- Please check that the API name is correct and that the .agent file exists in your project directory.
50
+ Check that the API name is correct and that the .agent file exists in your project directory.
@@ -1,19 +1,24 @@
1
1
  # summary
2
2
 
3
- Validate an Agent Authoring Bundle
3
+ Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.
4
4
 
5
5
  # description
6
6
 
7
- Validates an Agent Authoring Bundle by compiling the .agent file and checking for errors.
7
+ 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.
8
+
9
+ This 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.
10
+
11
+ This 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.
8
12
 
9
13
  # examples
10
14
 
11
- - Validate an Agent Authoring Bundle:
12
- <%= config.bin %> <%= command.id %> --api-name path/to/bundle
15
+ - Validate a local authoring bundle with API name MyAuthoringBundle:
16
+
17
+ <%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle
13
18
 
14
19
  # flags.api-name.summary
15
20
 
16
- API name of the Agent Authoring Bundle to validate.
21
+ API name of the authoring bundle you want to validate.
17
22
 
18
23
  # flags.api-name.prompt
19
24
 
@@ -21,15 +26,15 @@ API name of the authoring bundle to validate
21
26
 
22
27
  # error.missingRequiredFlags
23
28
 
24
- Required flag(s) missing: %s
29
+ Required flag(s) missing: %s.
25
30
 
26
31
  # error.invalidBundlePath
27
32
 
28
- Invalid bundle path. Please provide a valid path to an Agent Authoring Bundle.
33
+ Invalid authoring bundle path. Provide a valid directory path to the authoring bundle you want to validate.
29
34
 
30
35
  # error.compilationFailed
31
36
 
32
- Agent compilation failed with the following errors:
37
+ Compilation of the agent file failed with the following errors:
33
38
  %s
34
39
 
35
40
  # error.agentNotFound
@@ -38,4 +43,4 @@ Could not find a .bundle-meta.xml file with API name '%s' in the project.
38
43
 
39
44
  # error.agentNotFoundAction
40
45
 
41
- Please check that the API name is correct and that the .agent file exists in your project directory.
46
+ Check that the API name is correct and that the ".agent" file exists in your project directory.
@@ -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. You must have previously created this link with \"org login web --client-app\". Run \"org display\" to see the available linked client apps.",
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 an ephemeral agent by specifying the API name of the Authoring Bundle metadata",
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"
@@ -540,10 +540,10 @@
540
540
  "agent:generate:authoring-bundle": {
541
541
  "aliases": [],
542
542
  "args": {},
543
- "description": "Generates an authoring bundle containing Agent and its meta.xml file from an agent specification file.",
543
+ "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
544
  "examples": [
545
- "Generate an authoring bundle from a specification file:\n<%= config.bin %> <%= command.id %> --spec-file path/to/spec.yaml --name \"My Authoring Bundle\"",
546
- "Generate an authoring bundle with a custom output directory:\n<%= config.bin %> <%= command.id %> --spec-file path/to/spec.yaml --name \"My Authoring Bundle\" --output-dir path/to/output"
545
+ "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\"",
546
+ "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
547
  ],
548
548
  "flags": {
549
549
  "json": {
@@ -573,7 +573,7 @@
573
573
  },
574
574
  "api-name": {
575
575
  "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 must not exist in the org.",
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 can't exist in the org.",
577
577
  "hasDynamicHelp": false,
578
578
  "multiple": false,
579
579
  "type": "option"
@@ -588,7 +588,7 @@
588
588
  "spec": {
589
589
  "char": "f",
590
590
  "name": "spec",
591
- "summary": "Path to the agent specification file.",
591
+ "summary": "Path to the agent spec YAML file.",
592
592
  "hasDynamicHelp": false,
593
593
  "multiple": false,
594
594
  "type": "option"
@@ -596,7 +596,7 @@
596
596
  "output-dir": {
597
597
  "char": "d",
598
598
  "name": "output-dir",
599
- "summary": "Directory where the authoring bundle files will be generated.",
599
+ "summary": "Directory where the authoring bundle files are generated.",
600
600
  "hasDynamicHelp": false,
601
601
  "multiple": false,
602
602
  "type": "option"
@@ -617,7 +617,7 @@
617
617
  "pluginName": "@salesforce/plugin-agent",
618
618
  "pluginType": "core",
619
619
  "strict": true,
620
- "summary": "Generate an authoring bundle from an agent specification.",
620
+ "summary": "Generate a local authoring bundle from an existing agent spec YAML file.",
621
621
  "enableJsonFlag": true,
622
622
  "requiresProject": true,
623
623
  "FLAGGABLE_PROMPTS": {
@@ -626,11 +626,11 @@
626
626
  "required": true
627
627
  },
628
628
  "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 must not exist in the org.",
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 can't exist in the org.",
630
630
  "promptMessage": "API name of the new authoring bundle"
631
631
  },
632
632
  "spec": {
633
- "message": "Path to the agent specification file.",
633
+ "message": "Path to the agent spec YAML file.",
634
634
  "required": true
635
635
  }
636
636
  },
@@ -796,12 +796,12 @@
796
796
  "test-spec:generate:agent"
797
797
  ]
798
798
  },
799
- "agent:publish:authoring-bundle": {
799
+ "agent:validate:authoring-bundle": {
800
800
  "aliases": [],
801
801
  "args": {},
802
- "description": "Publishes an Agent Authoring Bundle by compiling the .agent file and creating a new agent in your org.",
802
+ "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.",
803
803
  "examples": [
804
- "Publish an Agent Authoring Bundle:\n<%= config.bin %> <%= command.id %> --api-name path/to/bundle --agent-name \"My New Agent\" --target-org myorg@example.com"
804
+ "Validate a local authoring bundle with API name MyAuthoringBundle:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle"
805
805
  ],
806
806
  "flags": {
807
807
  "json": {
@@ -839,7 +839,7 @@
839
839
  "api-name": {
840
840
  "char": "n",
841
841
  "name": "api-name",
842
- "summary": "API name of the Agent Authoring Bundle to publish.",
842
+ "summary": "API name of the authoring bundle you want to validate.",
843
843
  "hasDynamicHelp": false,
844
844
  "multiple": false,
845
845
  "type": "option"
@@ -847,18 +847,18 @@
847
847
  },
848
848
  "hasDynamicHelp": true,
849
849
  "hiddenAliases": [],
850
- "id": "agent:publish:authoring-bundle",
850
+ "id": "agent:validate:authoring-bundle",
851
851
  "pluginAlias": "@salesforce/plugin-agent",
852
852
  "pluginName": "@salesforce/plugin-agent",
853
853
  "pluginType": "core",
854
854
  "strict": true,
855
- "summary": "Publish an Agent Authoring Bundle as a new agent",
855
+ "summary": "Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.",
856
856
  "enableJsonFlag": true,
857
857
  "requiresProject": true,
858
858
  "FLAGGABLE_PROMPTS": {
859
859
  "api-name": {
860
- "message": "API name of the Agent Authoring Bundle to publish.",
861
- "promptMessage": "API name of the authoring bundle to publish"
860
+ "message": "API name of the authoring bundle you want to validate.",
861
+ "promptMessage": "API name of the authoring bundle to validate"
862
862
  }
863
863
  },
864
864
  "isESM": true,
@@ -866,17 +866,17 @@
866
866
  "lib",
867
867
  "commands",
868
868
  "agent",
869
- "publish",
869
+ "validate",
870
870
  "authoring-bundle.js"
871
871
  ],
872
872
  "aliasPermutations": [],
873
873
  "permutations": [
874
- "agent:publish:authoring-bundle",
875
- "publish:agent:authoring-bundle",
876
- "publish:authoring-bundle:agent",
877
- "agent:authoring-bundle:publish",
878
- "authoring-bundle:agent:publish",
879
- "authoring-bundle:publish:agent"
874
+ "agent:validate:authoring-bundle",
875
+ "validate:agent:authoring-bundle",
876
+ "validate:authoring-bundle:agent",
877
+ "agent:authoring-bundle:validate",
878
+ "authoring-bundle:agent:validate",
879
+ "authoring-bundle:validate:agent"
880
880
  ]
881
881
  },
882
882
  "agent:test:create": {
@@ -1393,12 +1393,12 @@
1393
1393
  "run:test:agent"
1394
1394
  ]
1395
1395
  },
1396
- "agent:validate:authoring-bundle": {
1396
+ "agent:publish:authoring-bundle": {
1397
1397
  "aliases": [],
1398
1398
  "args": {},
1399
- "description": "Validates an Agent Authoring Bundle by compiling the .agent file and checking for errors.",
1399
+ "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.",
1400
1400
  "examples": [
1401
- "Validate an Agent Authoring Bundle:\n<%= config.bin %> <%= command.id %> --api-name path/to/bundle"
1401
+ "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"
1402
1402
  ],
1403
1403
  "flags": {
1404
1404
  "json": {
@@ -1436,7 +1436,7 @@
1436
1436
  "api-name": {
1437
1437
  "char": "n",
1438
1438
  "name": "api-name",
1439
- "summary": "API name of the Agent Authoring Bundle to validate.",
1439
+ "summary": "API name of the authoring bundle you want to publish.",
1440
1440
  "hasDynamicHelp": false,
1441
1441
  "multiple": false,
1442
1442
  "type": "option"
@@ -1444,18 +1444,18 @@
1444
1444
  },
1445
1445
  "hasDynamicHelp": true,
1446
1446
  "hiddenAliases": [],
1447
- "id": "agent:validate:authoring-bundle",
1447
+ "id": "agent:publish:authoring-bundle",
1448
1448
  "pluginAlias": "@salesforce/plugin-agent",
1449
1449
  "pluginName": "@salesforce/plugin-agent",
1450
1450
  "pluginType": "core",
1451
1451
  "strict": true,
1452
- "summary": "Validate an Agent Authoring Bundle",
1452
+ "summary": "Publish an authoring bundle to your org, which results in a new next-gen agent.",
1453
1453
  "enableJsonFlag": true,
1454
1454
  "requiresProject": true,
1455
1455
  "FLAGGABLE_PROMPTS": {
1456
1456
  "api-name": {
1457
- "message": "API name of the Agent Authoring Bundle to validate.",
1458
- "promptMessage": "API name of the authoring bundle to validate"
1457
+ "message": "API name of the authoring bundle you want to publish.",
1458
+ "promptMessage": "API name of the authoring bundle to publish"
1459
1459
  }
1460
1460
  },
1461
1461
  "isESM": true,
@@ -1463,19 +1463,19 @@
1463
1463
  "lib",
1464
1464
  "commands",
1465
1465
  "agent",
1466
- "validate",
1466
+ "publish",
1467
1467
  "authoring-bundle.js"
1468
1468
  ],
1469
1469
  "aliasPermutations": [],
1470
1470
  "permutations": [
1471
- "agent:validate:authoring-bundle",
1472
- "validate:agent:authoring-bundle",
1473
- "validate:authoring-bundle:agent",
1474
- "agent:authoring-bundle:validate",
1475
- "authoring-bundle:agent:validate",
1476
- "authoring-bundle:validate:agent"
1471
+ "agent:publish:authoring-bundle",
1472
+ "publish:agent:authoring-bundle",
1473
+ "publish:authoring-bundle:agent",
1474
+ "agent:authoring-bundle:publish",
1475
+ "authoring-bundle:agent:publish",
1476
+ "authoring-bundle:publish:agent"
1477
1477
  ]
1478
1478
  }
1479
1479
  },
1480
- "version": "1.24.14-demo.8"
1480
+ "version": "1.24.14-demo.9"
1481
1481
  }
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-demo.8",
4
+ "version": "1.24.14-demo.9",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -9,7 +9,7 @@
9
9
  "@inquirer/prompts": "^7.8.6",
10
10
  "@oclif/core": "^4",
11
11
  "@oclif/multi-stage-output": "^0.8.23",
12
- "@salesforce/agents": "^0.18.1",
12
+ "@salesforce/agents": "^0.18.2",
13
13
  "@salesforce/core": "^8.23.1",
14
14
  "@salesforce/kit": "^3.2.3",
15
15
  "@salesforce/sf-plugins-core": "^12.2.4",
@@ -229,7 +229,7 @@
229
229
  "exports": "./lib/index.js",
230
230
  "type": "module",
231
231
  "sfdx": {
232
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-demo.8.crt",
233
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-demo.8.sig"
232
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-demo.9.crt",
233
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-demo.9.sig"
234
234
  }
235
235
  }