@salesforce/plugin-agent 1.22.6 → 1.22.7
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 +16 -16
- package/messages/agent.generate.template.md +2 -2
- package/npm-shrinkwrap.json +2 -2
- package/oclif.manifest.json +2 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -130,7 +130,7 @@ EXAMPLES
|
|
|
130
130
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
131
131
|
```
|
|
132
132
|
|
|
133
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
133
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/create.ts)_
|
|
134
134
|
|
|
135
135
|
## `sf agent generate agent-spec`
|
|
136
136
|
|
|
@@ -235,7 +235,7 @@ EXAMPLES
|
|
|
235
235
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
236
236
|
```
|
|
237
237
|
|
|
238
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
238
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/generate/agent-spec.ts)_
|
|
239
239
|
|
|
240
240
|
## `sf agent generate template`
|
|
241
241
|
|
|
@@ -258,11 +258,11 @@ DESCRIPTION
|
|
|
258
258
|
Generate an agent template from an existing agent in your DX project so you can then package the template in a managed
|
|
259
259
|
package.
|
|
260
260
|
|
|
261
|
-
At a high-level, agents are defined by the Bot, BotVersion, and
|
|
262
|
-
turn defines the agent's topics and actions. This command uses the metadata files for these
|
|
263
|
-
your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use
|
|
264
|
-
along with the
|
|
265
|
-
you can share between orgs or on AppExchange.
|
|
261
|
+
At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The
|
|
262
|
+
GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these
|
|
263
|
+
three types, located in your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use
|
|
264
|
+
the BotTemplate file, along with the GenAiPlannerBundle file that references the BotTemplate, to package the template
|
|
265
|
+
in a managed package that you can share between orgs or on AppExchange.
|
|
266
266
|
|
|
267
267
|
Use the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as
|
|
268
268
|
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple
|
|
@@ -271,7 +271,7 @@ DESCRIPTION
|
|
|
271
271
|
force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.
|
|
272
272
|
|
|
273
273
|
The new BotTemplate file is generated in the "botTemplates" directory in your local package directory, and has the
|
|
274
|
-
name <Agent_API_name
|
|
274
|
+
name <Agent_API_name>_v<Version>_Template.botTemplate-meta.xml, such as
|
|
275
275
|
force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full
|
|
276
276
|
pathname of the generated files when it completes.
|
|
277
277
|
|
|
@@ -283,7 +283,7 @@ EXAMPLES
|
|
|
283
283
|
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
286
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/generate/template.ts)_
|
|
287
287
|
|
|
288
288
|
## `sf agent generate test-spec`
|
|
289
289
|
|
|
@@ -341,7 +341,7 @@ EXAMPLES
|
|
|
341
341
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
342
342
|
```
|
|
343
343
|
|
|
344
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
344
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/generate/test-spec.ts)_
|
|
345
345
|
|
|
346
346
|
## `sf agent preview`
|
|
347
347
|
|
|
@@ -435,7 +435,7 @@ EXAMPLES
|
|
|
435
435
|
--output-dir "transcripts/my-preview"
|
|
436
436
|
```
|
|
437
437
|
|
|
438
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
438
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/preview.ts)_
|
|
439
439
|
|
|
440
440
|
## `sf agent test create`
|
|
441
441
|
|
|
@@ -490,7 +490,7 @@ EXAMPLES
|
|
|
490
490
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
491
491
|
```
|
|
492
492
|
|
|
493
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
493
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/create.ts)_
|
|
494
494
|
|
|
495
495
|
## `sf agent test list`
|
|
496
496
|
|
|
@@ -525,7 +525,7 @@ EXAMPLES
|
|
|
525
525
|
$ sf agent test list --target-org my-org
|
|
526
526
|
```
|
|
527
527
|
|
|
528
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
528
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/list.ts)_
|
|
529
529
|
|
|
530
530
|
## `sf agent test results`
|
|
531
531
|
|
|
@@ -581,7 +581,7 @@ FLAG DESCRIPTIONS
|
|
|
581
581
|
test results aren't written.
|
|
582
582
|
```
|
|
583
583
|
|
|
584
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
584
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/results.ts)_
|
|
585
585
|
|
|
586
586
|
## `sf agent test resume`
|
|
587
587
|
|
|
@@ -644,7 +644,7 @@ FLAG DESCRIPTIONS
|
|
|
644
644
|
test results aren't written.
|
|
645
645
|
```
|
|
646
646
|
|
|
647
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
647
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/resume.ts)_
|
|
648
648
|
|
|
649
649
|
## `sf agent test run`
|
|
650
650
|
|
|
@@ -708,6 +708,6 @@ FLAG DESCRIPTIONS
|
|
|
708
708
|
test results aren't written.
|
|
709
709
|
```
|
|
710
710
|
|
|
711
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.
|
|
711
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.22.7/src/commands/agent/test/run.ts)_
|
|
712
712
|
|
|
713
713
|
<!-- commandsstop -->
|
|
@@ -4,11 +4,11 @@ Generate an agent template from an existing agent in your DX project so you can
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
At a high-level, agents are defined by the Bot, BotVersion, and
|
|
7
|
+
At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use the BotTemplate file, along with the GenAiPlannerBundle file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.
|
|
8
8
|
|
|
9
9
|
Use the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion file must exist locally. For example, if you specify "--agent-version 4", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.
|
|
10
10
|
|
|
11
|
-
The new BotTemplate file is generated in the "botTemplates" directory in your local package directory, and has the name <Agent_API_name
|
|
11
|
+
The new BotTemplate file is generated in the "botTemplates" directory in your local package directory, and has the name <Agent_API_name>_v<Version>_Template.botTemplate-meta.xml, such as force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.
|
|
12
12
|
|
|
13
13
|
# examples
|
|
14
14
|
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-agent",
|
|
3
|
-
"version": "1.22.
|
|
3
|
+
"version": "1.22.7",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/plugin-agent",
|
|
9
|
-
"version": "1.22.
|
|
9
|
+
"version": "1.22.7",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@inquirer/core": "^10.1.6",
|
package/oclif.manifest.json
CHANGED
|
@@ -389,7 +389,7 @@
|
|
|
389
389
|
"agent:generate:template": {
|
|
390
390
|
"aliases": [],
|
|
391
391
|
"args": {},
|
|
392
|
-
"description": "At a high-level, agents are defined by the Bot, BotVersion, and
|
|
392
|
+
"description": "At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use the BotTemplate file, along with the GenAiPlannerBundle file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate file is generated in the \"botTemplates\" directory in your local package directory, and has the name <Agent_API_name>_v<Version>_Template.botTemplate-meta.xml, such as force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.",
|
|
393
393
|
"examples": [
|
|
394
394
|
"Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent agent; use version 1 of the agent.\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1"
|
|
395
395
|
],
|
|
@@ -1110,5 +1110,5 @@
|
|
|
1110
1110
|
]
|
|
1111
1111
|
}
|
|
1112
1112
|
},
|
|
1113
|
-
"version": "1.22.
|
|
1113
|
+
"version": "1.22.7"
|
|
1114
1114
|
}
|
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.22.
|
|
4
|
+
"version": "1.22.7",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -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.22.
|
|
233
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.22.
|
|
232
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.22.7.crt",
|
|
233
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.22.7.sig"
|
|
234
234
|
}
|
|
235
235
|
}
|