Skip to content

Commit 3053651

Browse files
committed
chore(release): 1.24.14-nga.2 [skip ci]
1 parent 7f75692 commit 3053651

File tree

2 files changed

+82
-61
lines changed

2 files changed

+82
-61
lines changed

README.md

Lines changed: 81 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ EXAMPLES
112112
$ sf agent activate --api-name Resort_Manager --target-org my-org
113113
```
114114

115-
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/activate.ts)_
115+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/activate.ts)_
116116

117117
## `sf agent create`
118118

@@ -140,6 +140,11 @@ GLOBAL FLAGS
140140
DESCRIPTION
141141
Create an agent in your org using a local agent spec file.
142142
143+
NOTE: This command creates an agent that doesn't use Agent Script as its blueprint. We generally don't recommend you
144+
use this workflow to create an agent. Rather, use the "agent generate|validate|publish authoring-bundle" commands to
145+
author agents that use the Agent Script language. See "Author an Agent"
146+
(https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-nga-author-agent.html) for details.
147+
143148
To run this command, you must have an agent spec file, which is a YAML file that define the agent properties and
144149
contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the "agent generate
145150
agent-spec" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag,
@@ -174,7 +179,7 @@ EXAMPLES
174179
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
175180
```
176181

177-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/create.ts)_
182+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/create.ts)_
178183

179184
## `sf agent deactivate`
180185

@@ -214,7 +219,7 @@ EXAMPLES
214219
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
215220
```
216221

217-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/deactivate.ts)_
222+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/deactivate.ts)_
218223

219224
## `sf agent generate agent-spec`
220225

@@ -265,10 +270,9 @@ GLOBAL FLAGS
265270
DESCRIPTION
266271
Generate an agent spec, which is a YAML file that captures what an agent can do.
267272
268-
The first step in creating an agent in your org with Salesforce CLI is to generate an agent spec using this command.
269-
An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company
270-
description, and then an AI-generated list of topics based on this information. Topics define the range of jobs your
271-
agent can handle.
273+
An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company
274+
description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent
275+
can handle.
272276
273277
Use flags, such as --role and --company-description, to provide details about your company and the role that the agent
274278
plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be
@@ -286,8 +290,11 @@ DESCRIPTION
286290
add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the
287291
agent.
288292
289-
When your agent spec is ready, you then create the agent in your org by running the "agent create" CLI command and
290-
specifying the spec with the --spec flag.
293+
When your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the
294+
"agent generate authoring-bundle" CLI command. An authoring bundle is a metadata type that contains an Agent Script
295+
file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately
296+
create an agent with the "agent create" command. We don't recommend this workflow because these types of agents don't
297+
use Agent Script, and are thus less flexible and more difficult to maintain.)
291298
292299
EXAMPLES
293300
Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and
@@ -319,11 +326,11 @@ EXAMPLES
319326
$ sf agent generate agent-spec --tone formal --agent-user [email protected]
320327
```
321328

322-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/generate/agent-spec.ts)_
329+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/generate/agent-spec.ts)_
323330

324331
## `sf agent generate authoring-bundle`
325332

326-
Generate a local authoring bundle from an existing agent spec YAML file.
333+
Generate an authoring bundle from an existing agent spec YAML file.
327334

328335
```
329336
USAGE
@@ -345,29 +352,40 @@ GLOBAL FLAGS
345352
--json Format output as json.
346353
347354
DESCRIPTION
348-
Generate a local authoring bundle from an existing agent spec YAML file.
355+
Generate an authoring bundle from an existing agent spec YAML file.
356+
357+
Authoring bundles are metadata components that contain an agent's Agent Script file. The Agent Script file is the
358+
agent's blueprint; it fully describes what the agent can do using the Agent Script language.
359+
360+
Use this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the "agent
361+
generate agent-spec" command. The agent spec YAML file is a high-level description of the agent; it describes its
362+
essence rather than exactly what it can do.
363+
364+
The metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard
365+
"<bundle-name>.bundle-meta.xml" metadata file and the Agent Script file (with extension ".agent"). When you run this
366+
command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-name>
367+
directory. Use the --output-dir flag to generate them elsewhere.
349368
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.
369+
After you generate the initial authoring bundle, vibe code (modify using natural language) the Agent Script file so
370+
your agent behaves exactly as you want. The generated Agent Script file is just a first draft of your agent! Then
371+
publish the agent to your org with the "agent publish authoring-bundle" command.
354372
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.
373+
This command requires an org because it uses it to access an LLM for generating the Agent Script file.
357374
358375
EXAMPLES
359376
Generate an authoring bundle from the "specs/agentSpec.yaml" agent spec YAML file and give it the label "My
360-
Authoring Bundle":
377+
Authoring Bundle"; use your default org:
361378
362-
$ sf agent generate authoring-bundle --spec-file specs/agentSpec.yaml --name "My Authoring Bundle"
379+
$ sf agent generate authoring-bundle --spec specs/agentSpec.yaml --name "My Authoring Bundle"
363380
364-
Same as previous example, but generate the files in the other-package-dir/main/default/aiAuthoringBundles directory:
381+
Same as previous example, but generate the files in the "other-package-dir/main/default" package directory; use the
382+
org with alias "my-dev-org":
365383
366-
$ sf agent generate authoring-bundle --spec-file specs/agentSpec.yaml --name "My Authoring Bundle" --output-dir \
367-
other-package-dir/main/default/aiAuthoringBundles
384+
$ sf agent generate authoring-bundle --spec specs/agentSpec.yaml --name "My Authoring Bundle" --output-dir \
385+
other-package-dir/main/default --target-org my-dev-org
368386
```
369387

370-
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/generate/authoring-bundle.ts)_
388+
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/generate/authoring-bundle.ts)_
371389

372390
## `sf agent generate template`
373391

@@ -415,7 +433,7 @@ EXAMPLES
415433
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
416434
```
417435

418-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/generate/template.ts)_
436+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/generate/template.ts)_
419437

420438
## `sf agent generate test-spec`
421439

@@ -476,7 +494,7 @@ EXAMPLES
476494
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
477495
```
478496

479-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/generate/test-spec.ts)_
497+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/generate/test-spec.ts)_
480498

481499
## `sf agent preview`
482500

@@ -542,11 +560,11 @@ EXAMPLES
542560
transcripts/my-preview
543561
```
544562

545-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/preview.ts)_
563+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/preview.ts)_
546564

547565
## `sf agent publish authoring-bundle`
548566

549-
Publish an authoring bundle to your org, which results in a new next-gen agent.
567+
Publish an authoring bundle to your org, which results in a new or updated agent.
550568

551569
```
552570
USAGE
@@ -563,29 +581,30 @@ GLOBAL FLAGS
563581
--json Format output as json.
564582
565583
DESCRIPTION
566-
Publish an authoring bundle to your org, which results in a new next-gen agent.
584+
Publish an authoring bundle to your org, which results in a new or updated agent.
567585
568-
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the
569-
agent file (with extension ".agent") successfully compiles. Then the authoring bundle metadata component is deployed
570-
to the org, and all associated metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either
571-
created or updated. The org then creates a new next-gen agent based on the deployed authoring bundle and associated
572-
metadata. Finally, all the metadata associated with the new agent is retrieved back to your local DX project.
586+
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The
587+
metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that
588+
fully describes the agent using the Agent Script language.
573589
574-
Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is
575-
AiAuthoringBundle and they consist of a standard "\*-meta.xml" metadata file and an agent file (with extension
576-
".agent") that fully describes the next-gen agent.
590+
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the
591+
Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent
592+
Script file to continue. Once the Agent Script file compiles, then the authoring bundle metadata component is deployed
593+
to the org, and all associated agent metadata components, such as the Bot, BotVersion, and GenAiXXX components, are
594+
either created or updated. The org then either creates a new agent based on the deployed authoring bundle, or creates
595+
a new version of the agent if it already existed. Finally, all the new or changed metadata components associated with
596+
the new agent are retrieved back to your local DX project.
577597
578-
This command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the
579-
command prompts you for it.
598+
This command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the
599+
command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.
580600
581601
EXAMPLES
582-
Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-org", resulting in a new agent
583-
named "My Fab Agent"::
602+
Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-org":
584603
585-
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --agent-name "My Fab Agent" --target-org my-org
604+
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-org
586605
```
587606

588-
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/publish/authoring-bundle.ts)_
607+
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/publish/authoring-bundle.ts)_
589608

590609
## `sf agent test create`
591610

@@ -640,7 +659,7 @@ EXAMPLES
640659
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
641660
```
642661

643-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/test/create.ts)_
662+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/test/create.ts)_
644663

645664
## `sf agent test list`
646665

@@ -675,7 +694,7 @@ EXAMPLES
675694
$ sf agent test list --target-org my-org
676695
```
677696

678-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/test/list.ts)_
697+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/test/list.ts)_
679698

680699
## `sf agent test results`
681700

@@ -741,7 +760,7 @@ FLAG DESCRIPTIONS
741760
expression when using custom evaluations.
742761
```
743762

744-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/test/results.ts)_
763+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/test/results.ts)_
745764

746765
## `sf agent test resume`
747766

@@ -814,7 +833,7 @@ FLAG DESCRIPTIONS
814833
expression when using custom evaluations.
815834
```
816835

817-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/test/resume.ts)_
836+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/test/resume.ts)_
818837

819838
## `sf agent test run`
820839

@@ -888,11 +907,11 @@ FLAG DESCRIPTIONS
888907
expression when using custom evaluations.
889908
```
890909

891-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/test/run.ts)_
910+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/test/run.ts)_
892911

893912
## `sf agent validate authoring-bundle`
894913

895-
Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.
914+
Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.
896915

897916
```
898917
USAGE
@@ -909,25 +928,27 @@ GLOBAL FLAGS
909928
--json Format output as json.
910929
911930
DESCRIPTION
912-
Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.
931+
Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an
932+
agent.
913933
914-
Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is
915-
AiAuthoringBundle and they consist of a standard "\*-meta.xml" metadata file and an agent file (with extension
916-
".agent") that fully describes the next-gen agent. Generate a local authoring bundle with the "agent generate
917-
authoring-bundle" command.
934+
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The
935+
metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that
936+
fully describes the agent using the Agent Script language.
918937
919-
This command validates that the agent file (with extension ".agent") that's part of the authoring bundle compiles
920-
without errors and can later be used to successfully create a next-gen agent.
938+
This command validates that the Agent Script file in the authoring bundle compiles without errors so that you can
939+
later publish the bundle to your org. Use this command while you vibe code (modify with natural language) the Agent
940+
Script file to ensure that it's always valid. If the validation fails, the command outputs the list of syntax errors,
941+
a brief description of the error, and the location in the Agent Script file where the error occurred.
921942
922-
This command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the
923-
command prompts you for it.
943+
This command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the
944+
command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.
924945
925946
EXAMPLES
926-
Validate a local authoring bundle with API name MyAuthoringBundle:
947+
Validate an authoring bundle with API name MyAuthoringBundle:
927948
928949
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle
929950
```
930951

931-
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.1/src/commands/agent/validate/authoring-bundle.ts)_
952+
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.14-nga.2/src/commands/agent/validate/authoring-bundle.ts)_
932953

933954
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-agent",
33
"description": "Commands to interact with Salesforce agents",
4-
"version": "1.24.14-nga.1",
4+
"version": "1.24.14-nga.2",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)