@salesforce/plugin-agent 1.5.0 → 1.5.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.
@@ -3,9 +3,9 @@
3
3
  "agent:create": {
4
4
  "aliases": [],
5
5
  "args": {},
6
- "description": "Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.",
6
+ "description": "To generate an agent spec file, run the \"agent generate spec\" CLI command, which outputs a JSON file with the list of jobs and descriptions that the new agent can perform. Then specify this generated spec file to the --job-spec flag of this command, along with the name of the new agent.\n\nWhen this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent already has a list of topics and actions that were automatically created from the list of jobs in the provided agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX project.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <api-name-of-your-agent>\".",
7
7
  "examples": [
8
- "Create an Agent:\n<%= config.bin %> <%= command.id %> --spec ./agent-spec.json"
8
+ "Create an agent called \"CustomerSupportAgent\" in an org with alias \"my-org\" using the specified agent spec file:\n<%= config.bin %> <%= command.id %> --name CustomerSupportAgent --job-spec ./config/agentSpec.json --target-org my-org"
9
9
  ],
10
10
  "flags": {
11
11
  "json": {
@@ -42,10 +42,9 @@
42
42
  },
43
43
  "job-spec": {
44
44
  "char": "f",
45
- "description": "The agent spec file defines job titles and descriptions for the agent and can be created using the `sf agent create spec` command.",
46
45
  "name": "job-spec",
47
46
  "required": true,
48
- "summary": "The path to an agent spec file.",
47
+ "summary": "Path to an agent spec file.",
49
48
  "hasDynamicHelp": false,
50
49
  "multiple": false,
51
50
  "type": "option"
@@ -54,7 +53,7 @@
54
53
  "char": "n",
55
54
  "name": "name",
56
55
  "required": true,
57
- "summary": "The name of the agent.",
56
+ "summary": "API name of the new agent.",
58
57
  "hasDynamicHelp": false,
59
58
  "multiple": false,
60
59
  "type": "option"
@@ -68,8 +67,9 @@
68
67
  "pluginType": "core",
69
68
  "state": "beta",
70
69
  "strict": true,
71
- "summary": "Create an Agent from an agent spec.",
70
+ "summary": "Create an agent in your org from a local agent spec file.",
72
71
  "enableJsonFlag": true,
72
+ "requiresProject": true,
73
73
  "isESM": true,
74
74
  "relativePath": [
75
75
  "lib",
@@ -154,9 +154,10 @@
154
154
  "agent:generate:spec": {
155
155
  "aliases": [],
156
156
  "args": {},
157
- "description": "Create an Agent spec, which is a list of job titles and descriptions that the agent performs.",
157
+ "description": "When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent spec file with this command.\n\nAn agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and --company-description to provide details about your company and the role that the agent plays in your company; you can also enter the information interactively if you prefer. When you then execute this command, the large language model (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs. We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can remove jobs that don't apply to your agent.\n\nWhen your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the --job-spec flag of the \"agent create\" CLI command.",
158
158
  "examples": [
159
- "Create an Agent spec in the default location:\n<%= config.bin %> <%= command.id %> --type customer_facing --role Support --company-name \"Coral Cloud\" --company-description \"A meaningful description\""
159
+ "Create an agent spec for your default org in the default location and use flags to specify the agent's role and your company details:\n<%= config.bin %> <%= command.id %> --type customer --role \"Assist users in navigating and managing bookings\" --company-name \"Coral Cloud\" --company-description \"Resort that manages guests and their reservations and experiences\"",
160
+ "Create an agent spec by being prompted for role and company details interactively; write the generated file to the \"specs\" directory and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --output-dir specs --target-org my-org"
160
161
  ],
161
162
  "flags": {
162
163
  "json": {
@@ -194,7 +195,7 @@
194
195
  "type": {
195
196
  "char": "t",
196
197
  "name": "type",
197
- "summary": "The type of agent to create.",
198
+ "summary": "Type of agent to create.",
198
199
  "hasDynamicHelp": false,
199
200
  "multiple": false,
200
201
  "options": [
@@ -205,28 +206,28 @@
205
206
  },
206
207
  "role": {
207
208
  "name": "role",
208
- "summary": "The role of the agent.",
209
+ "summary": "Role of the agent.",
209
210
  "hasDynamicHelp": false,
210
211
  "multiple": false,
211
212
  "type": "option"
212
213
  },
213
214
  "company-name": {
214
215
  "name": "company-name",
215
- "summary": "The name of the company.",
216
+ "summary": "Name of your company.",
216
217
  "hasDynamicHelp": false,
217
218
  "multiple": false,
218
219
  "type": "option"
219
220
  },
220
221
  "company-description": {
221
222
  "name": "company-description",
222
- "summary": "The description of the company, containing details to be used when generating agent job descriptions.",
223
+ "summary": "Description of your company.",
223
224
  "hasDynamicHelp": false,
224
225
  "multiple": false,
225
226
  "type": "option"
226
227
  },
227
228
  "company-website": {
228
229
  "name": "company-website",
229
- "summary": "The website URL for the company.",
230
+ "summary": "Website URL of your company.",
230
231
  "hasDynamicHelp": false,
231
232
  "multiple": false,
232
233
  "type": "option"
@@ -234,7 +235,7 @@
234
235
  "output-dir": {
235
236
  "char": "d",
236
237
  "name": "output-dir",
237
- "summary": "The location within the project where the agent spec will be written.",
238
+ "summary": "Directory where the agent spec file is written; can be an absolute or relative path.",
238
239
  "default": "config",
239
240
  "hasDynamicHelp": false,
240
241
  "multiple": false,
@@ -243,7 +244,7 @@
243
244
  "file-name": {
244
245
  "char": "f",
245
246
  "name": "file-name",
246
- "summary": "The name of the file to write the agent spec to.",
247
+ "summary": "Name of the generated agent spec file.",
247
248
  "default": "agentSpec.json",
248
249
  "hasDynamicHelp": false,
249
250
  "multiple": false,
@@ -258,7 +259,7 @@
258
259
  "pluginType": "core",
259
260
  "state": "beta",
260
261
  "strict": true,
261
- "summary": "Create an Agent spec.",
262
+ "summary": "Generate an agent spec, which is the list of jobs that the agent performs.",
262
263
  "enableJsonFlag": true,
263
264
  "requiresProject": true,
264
265
  "isESM": true,
@@ -690,5 +691,5 @@
690
691
  ]
691
692
  }
692
693
  },
693
- "version": "1.5.0"
694
+ "version": "1.5.2"
694
695
  }
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.5.0",
4
+ "version": "1.5.2",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -10,7 +10,7 @@
10
10
  "@inquirer/select": "^4.0.1",
11
11
  "@oclif/core": "^4",
12
12
  "@oclif/multi-stage-output": "^0.7.12",
13
- "@salesforce/agents": "^0.4.0",
13
+ "@salesforce/agents": "^0.4.2",
14
14
  "@salesforce/core": "^8.8.0",
15
15
  "@salesforce/kit": "^3.2.1",
16
16
  "@salesforce/sf-plugins-core": "^12.1.0",
@@ -221,7 +221,7 @@
221
221
  "exports": "./lib/index.js",
222
222
  "type": "module",
223
223
  "sfdx": {
224
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.0.crt",
225
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.0.sig"
224
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.2.crt",
225
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.2.sig"
226
226
  }
227
227
  }