@salesforce/plugin-agent 1.14.1-dev.1 → 1.14.2
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 -15
- package/messages/agent.create.md +4 -4
- package/messages/agent.generate.agent-spec.md +1 -1
- package/npm-shrinkwrap.json +2 -2
- package/oclif.manifest.json +4 -4
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -111,13 +111,14 @@ DESCRIPTION
|
|
|
111
111
|
new agent to your local Salesforce DX project.
|
|
112
112
|
|
|
113
113
|
Use the --preview flag to review what the agent looks like without actually saving it in your org. When previewing,
|
|
114
|
-
the command creates a JSON file in the current directory with all the agent details.
|
|
114
|
+
the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the
|
|
115
|
+
agent's API name and a timestamp.
|
|
115
116
|
|
|
116
117
|
To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <agent-api-name>".
|
|
117
118
|
|
|
118
119
|
EXAMPLES
|
|
119
|
-
Create an agent by being prompted for the required information, such as the agent spec file
|
|
120
|
-
|
|
120
|
+
Create an agent by being prompted for the required information, such as the agent spec file and agent name, and then
|
|
121
|
+
create it in your default org:
|
|
121
122
|
|
|
122
123
|
$ sf agent create
|
|
123
124
|
|
|
@@ -132,7 +133,7 @@ EXAMPLES
|
|
|
132
133
|
$ sf agent create --agent-name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
133
134
|
```
|
|
134
135
|
|
|
135
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
136
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/create.ts)_
|
|
136
137
|
|
|
137
138
|
## `sf agent generate agent-spec`
|
|
138
139
|
|
|
@@ -161,7 +162,7 @@ FLAGS
|
|
|
161
162
|
--full-interview Prompt for both required and optional flags.
|
|
162
163
|
--grounding-context=<value> Context information and personalization that's added to your prompts when using a
|
|
163
164
|
custom prompt template.
|
|
164
|
-
--max-topics=<value> Maximum number of topics to generate in the agent spec; default is
|
|
165
|
+
--max-topics=<value> Maximum number of topics to generate in the agent spec; default is 5.
|
|
165
166
|
--output-file=<value> [default: specs/agentSpec.yaml] Path for the generated YAML agent spec file; can be
|
|
166
167
|
an absolute or relative path.
|
|
167
168
|
--prompt-template=<value> API name of a customized prompt template to use instead of the default prompt
|
|
@@ -236,7 +237,7 @@ EXAMPLES
|
|
|
236
237
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
237
238
|
```
|
|
238
239
|
|
|
239
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
240
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/generate/agent-spec.ts)_
|
|
240
241
|
|
|
241
242
|
## `sf agent generate template`
|
|
242
243
|
|
|
@@ -269,7 +270,7 @@ EXAMPLES
|
|
|
269
270
|
$ sf agent generate template --agent-api-name My_Packaged_Agent
|
|
270
271
|
```
|
|
271
272
|
|
|
272
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
273
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/generate/template.ts)_
|
|
273
274
|
|
|
274
275
|
## `sf agent generate test-spec`
|
|
275
276
|
|
|
@@ -292,7 +293,7 @@ EXAMPLES
|
|
|
292
293
|
$ sf agent generate test-spec
|
|
293
294
|
```
|
|
294
295
|
|
|
295
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
296
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/generate/test-spec.ts)_
|
|
296
297
|
|
|
297
298
|
## `sf agent preview`
|
|
298
299
|
|
|
@@ -327,7 +328,7 @@ FLAG DESCRIPTIONS
|
|
|
327
328
|
the API name of the agent? (TBD based on agents library)
|
|
328
329
|
```
|
|
329
330
|
|
|
330
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
331
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/preview.ts)_
|
|
331
332
|
|
|
332
333
|
## `sf agent test cancel`
|
|
333
334
|
|
|
@@ -364,7 +365,7 @@ EXAMPLES
|
|
|
364
365
|
$ sf agent test cancel --job-id 4KBfake0000003F4AQ --target-org my-org
|
|
365
366
|
```
|
|
366
367
|
|
|
367
|
-
_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
368
|
+
_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/test/cancel.ts)_
|
|
368
369
|
|
|
369
370
|
## `sf agent test create`
|
|
370
371
|
|
|
@@ -400,7 +401,7 @@ FLAG DESCRIPTIONS
|
|
|
400
401
|
More information about a flag. Don't repeat the summary.
|
|
401
402
|
```
|
|
402
403
|
|
|
403
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
404
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/test/create.ts)_
|
|
404
405
|
|
|
405
406
|
## `sf agent test list`
|
|
406
407
|
|
|
@@ -429,7 +430,7 @@ EXAMPLES
|
|
|
429
430
|
$ sf agent test list
|
|
430
431
|
```
|
|
431
432
|
|
|
432
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
433
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/test/list.ts)_
|
|
433
434
|
|
|
434
435
|
## `sf agent test results`
|
|
435
436
|
|
|
@@ -485,7 +486,7 @@ FLAG DESCRIPTIONS
|
|
|
485
486
|
test results aren't written.
|
|
486
487
|
```
|
|
487
488
|
|
|
488
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
489
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/test/results.ts)_
|
|
489
490
|
|
|
490
491
|
## `sf agent test resume`
|
|
491
492
|
|
|
@@ -548,7 +549,7 @@ FLAG DESCRIPTIONS
|
|
|
548
549
|
test results aren't written.
|
|
549
550
|
```
|
|
550
551
|
|
|
551
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
552
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/test/resume.ts)_
|
|
552
553
|
|
|
553
554
|
## `sf agent test run`
|
|
554
555
|
|
|
@@ -611,6 +612,6 @@ FLAG DESCRIPTIONS
|
|
|
611
612
|
test results aren't written.
|
|
612
613
|
```
|
|
613
614
|
|
|
614
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.
|
|
615
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.14.2/src/commands/agent/test/run.ts)_
|
|
615
616
|
|
|
616
617
|
<!-- commandsstop -->
|
package/messages/agent.create.md
CHANGED
|
@@ -8,7 +8,7 @@ To run this comand, you must have an agent spec file, which is a YAML file that
|
|
|
8
8
|
|
|
9
9
|
When this command completes, your org contains the new agent, which you can then edit and customize in the Agent Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have some AI-generated actions, or you can add them. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.
|
|
10
10
|
|
|
11
|
-
Use the --preview flag to review what the agent looks like without actually saving it in your org. When previewing, the command creates a JSON file in the current directory with all the agent details.
|
|
11
|
+
Use the --preview flag to review what the agent looks like without actually saving it in your org. When previewing, the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the agent's API name and a timestamp.
|
|
12
12
|
|
|
13
13
|
To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <agent-api-name>".
|
|
14
14
|
|
|
@@ -30,7 +30,7 @@ API name of the new agent; if not specified, the API name is derived from the ag
|
|
|
30
30
|
|
|
31
31
|
# flags.agent-api-name.prompt
|
|
32
32
|
|
|
33
|
-
API name of the new agent
|
|
33
|
+
API name of the new agent
|
|
34
34
|
|
|
35
35
|
# flags.planner-id.summary
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ An existing GenAiPlanner ID to associate with the agent.
|
|
|
38
38
|
|
|
39
39
|
# error.missingRequiredFlags
|
|
40
40
|
|
|
41
|
-
Missing required flags: %s
|
|
41
|
+
Missing required flags: %s.
|
|
42
42
|
|
|
43
43
|
# error.missingRequiredSpecProperties
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Your agent spec file is missing these required properties: %s.
|
|
|
46
46
|
|
|
47
47
|
# examples
|
|
48
48
|
|
|
49
|
-
- Create an agent by being prompted for the required information, such as the agent spec file
|
|
49
|
+
- Create an agent by being prompted for the required information, such as the agent spec file and agent name, and then create it in your default org:
|
|
50
50
|
|
|
51
51
|
<%= config.bin %> <%= command.id %>
|
|
52
52
|
|
|
@@ -44,7 +44,7 @@ Path for the generated YAML agent spec file; can be an absolute or relative path
|
|
|
44
44
|
|
|
45
45
|
# flags.max-topics.summary
|
|
46
46
|
|
|
47
|
-
Maximum number of topics to generate in the agent spec; default is
|
|
47
|
+
Maximum number of topics to generate in the agent spec; default is 5.
|
|
48
48
|
|
|
49
49
|
# flags.max-topics.prompt
|
|
50
50
|
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-agent",
|
|
3
|
-
"version": "1.14.
|
|
3
|
+
"version": "1.14.2",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/plugin-agent",
|
|
9
|
-
"version": "1.14.
|
|
9
|
+
"version": "1.14.2",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@inquirer/figures": "^1.0.7",
|
package/oclif.manifest.json
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"agent:create": {
|
|
4
4
|
"aliases": [],
|
|
5
5
|
"args": {},
|
|
6
|
-
"description": "To run this comand, you must have an agent spec file, which is a YAML file that define the agent properties and contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the \"agent generate agent-spec\" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag, along with the name (label) of the new agent with the --agent-name flag. If you don't specify any of the required flags, the command prompts you.\n\nWhen this command completes, your org contains the new agent, which you can then edit and customize in the Agent Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have some AI-generated actions, or you can add them. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.\n\nUse the --preview flag to review what the agent looks like without actually saving it in your org. When previewing, the command creates a JSON file in the current directory with all the agent details.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <agent-api-name>\".",
|
|
6
|
+
"description": "To run this comand, you must have an agent spec file, which is a YAML file that define the agent properties and contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the \"agent generate agent-spec\" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag, along with the name (label) of the new agent with the --agent-name flag. If you don't specify any of the required flags, the command prompts you.\n\nWhen this command completes, your org contains the new agent, which you can then edit and customize in the Agent Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have some AI-generated actions, or you can add them. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.\n\nUse the --preview flag to review what the agent looks like without actually saving it in your org. When previewing, the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the agent's API name and a timestamp.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <agent-api-name>\".",
|
|
7
7
|
"examples": [
|
|
8
|
-
"Create an agent by being prompted for the required information, such as the agent spec file
|
|
8
|
+
"Create an agent by being prompted for the required information, such as the agent spec file and agent name, and then create it in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
9
9
|
"Create an agent by specifying the agent name, API name, and spec file with flags; use the org with alias \"my-org\"; the command fails if the API name is already being used in your org:\n<%= config.bin %> <%= command.id %> --agent-name \"Resort Manager\" --agent-api-name Resort_Manager --spec specs/resortManagerAgent.yaml --target-org my-org",
|
|
10
10
|
"Preview the creation of an agent named \"Resort Manager\" and use your default org:\n<%= config.bin %> <%= command.id %> --agent-name \"Resort Manager\" --spec specs/resortManagerAgent.yaml --preview"
|
|
11
11
|
],
|
|
@@ -255,7 +255,7 @@
|
|
|
255
255
|
},
|
|
256
256
|
"max-topics": {
|
|
257
257
|
"name": "max-topics",
|
|
258
|
-
"summary": "Maximum number of topics to generate in the agent spec; default is
|
|
258
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
259
259
|
"hasDynamicHelp": false,
|
|
260
260
|
"multiple": false,
|
|
261
261
|
"type": "option"
|
|
@@ -1074,5 +1074,5 @@
|
|
|
1074
1074
|
]
|
|
1075
1075
|
}
|
|
1076
1076
|
},
|
|
1077
|
-
"version": "1.14.
|
|
1077
|
+
"version": "1.14.2"
|
|
1078
1078
|
}
|
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.14.
|
|
4
|
+
"version": "1.14.2",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -226,7 +226,7 @@
|
|
|
226
226
|
"exports": "./lib/index.js",
|
|
227
227
|
"type": "module",
|
|
228
228
|
"sfdx": {
|
|
229
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.14.
|
|
230
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.14.
|
|
229
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.14.2.crt",
|
|
230
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.14.2.sig"
|
|
231
231
|
}
|
|
232
232
|
}
|