@salesforce/plugin-agent 1.11.1 → 1.12.0
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 +19 -124
- package/lib/commands/agent/create.d.ts +8 -5
- package/lib/commands/agent/create.js +129 -39
- package/lib/commands/agent/create.js.map +1 -1
- package/lib/commands/agent/generate/spec.d.ts +76 -26
- package/lib/commands/agent/generate/spec.js +183 -82
- package/lib/commands/agent/generate/spec.js.map +1 -1
- package/messages/agent.create.md +33 -7
- package/messages/agent.generate.spec.md +84 -12
- package/npm-shrinkwrap.json +2 -2
- package/oclif.manifest.json +5 -217
- package/package.json +3 -3
- package/schemas/agent-create.json +129 -5
- package/schemas/agent-generate-spec.json +54 -6
- package/lib/commands/agent/create-v2.d.ts +0 -22
- package/lib/commands/agent/create-v2.js +0 -164
- package/lib/commands/agent/create-v2.js.map +0 -1
- package/lib/commands/agent/generate/spec-v2.d.ts +0 -92
- package/lib/commands/agent/generate/spec-v2.js +0 -268
- package/lib/commands/agent/generate/spec-v2.js.map +0 -1
- package/messages/agent.create-v2.md +0 -51
- package/messages/agent.generate.spec-v2.md +0 -121
- package/schemas/agent-create__v2.json +0 -145
- package/schemas/agent-generate-spec__v2.json +0 -85
|
@@ -4,18 +4,16 @@
|
|
|
4
4
|
* Licensed under the BSD 3-Clause license.
|
|
5
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
6
|
*/
|
|
7
|
-
import { join } from 'node:path';
|
|
8
|
-
import { writeFileSync } from 'node:fs';
|
|
9
|
-
import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
|
|
7
|
+
import { join, resolve, dirname } from 'node:path';
|
|
8
|
+
import { mkdirSync, readFileSync, writeFileSync, existsSync } from 'node:fs';
|
|
9
|
+
import { SfCommand, Flags, prompts } from '@salesforce/sf-plugins-core';
|
|
10
10
|
import { Messages } from '@salesforce/core';
|
|
11
|
-
import
|
|
12
|
-
import { select, input as inquirerInput } from '@inquirer/prompts';
|
|
13
|
-
import figures from '@inquirer/figures';
|
|
11
|
+
import YAML from 'yaml';
|
|
14
12
|
import { Agent } from '@salesforce/agents';
|
|
15
|
-
import {
|
|
13
|
+
import { makeFlags, promptForFlag, validateAgentType, validateMaxTopics } from '../../../flags.js';
|
|
16
14
|
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
|
|
17
15
|
const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.generate.spec');
|
|
18
|
-
const FLAGGABLE_PROMPTS = {
|
|
16
|
+
export const FLAGGABLE_PROMPTS = {
|
|
19
17
|
type: {
|
|
20
18
|
message: messages.getMessage('flags.type.summary'),
|
|
21
19
|
validate: (d) => d.length > 0 || 'Type cannot be empty',
|
|
@@ -45,7 +43,10 @@ const FLAGGABLE_PROMPTS = {
|
|
|
45
43
|
if (d.length === 0)
|
|
46
44
|
return true;
|
|
47
45
|
try {
|
|
48
|
-
new
|
|
46
|
+
const regExp = new RegExp('^(http|https)://', 'i');
|
|
47
|
+
const companySite = regExp.test(d) ? d : `https://${d}`;
|
|
48
|
+
new URL(companySite);
|
|
49
|
+
d = companySite;
|
|
49
50
|
return true;
|
|
50
51
|
}
|
|
51
52
|
catch (e) {
|
|
@@ -53,28 +54,39 @@ const FLAGGABLE_PROMPTS = {
|
|
|
53
54
|
}
|
|
54
55
|
},
|
|
55
56
|
},
|
|
57
|
+
'max-topics': {
|
|
58
|
+
message: messages.getMessage('flags.max-topics.summary'),
|
|
59
|
+
promptMessage: messages.getMessage('flags.max-topics.prompt'),
|
|
60
|
+
validate: () => true,
|
|
61
|
+
// min: 1,
|
|
62
|
+
// max: 30,
|
|
63
|
+
},
|
|
64
|
+
'agent-user': {
|
|
65
|
+
message: messages.getMessage('flags.agent-user.summary'),
|
|
66
|
+
promptMessage: messages.getMessage('flags.agent-user.prompt'),
|
|
67
|
+
validate: () => true,
|
|
68
|
+
},
|
|
69
|
+
'enrich-logs': {
|
|
70
|
+
message: messages.getMessage('flags.enrich-logs.summary'),
|
|
71
|
+
promptMessage: messages.getMessage('flags.enrich-logs.prompt'),
|
|
72
|
+
validate: () => true,
|
|
73
|
+
options: ['true', 'false'],
|
|
74
|
+
default: 'false',
|
|
75
|
+
},
|
|
76
|
+
tone: {
|
|
77
|
+
message: messages.getMessage('flags.tone.summary'),
|
|
78
|
+
promptMessage: messages.getMessage('flags.tone.prompt'),
|
|
79
|
+
validate: () => true,
|
|
80
|
+
options: ['formal', 'casual', 'neutral'],
|
|
81
|
+
default: 'casual',
|
|
82
|
+
},
|
|
83
|
+
// 'primary-language': {
|
|
84
|
+
// message: messages.getMessage('flags.primary-language.summary'),
|
|
85
|
+
// validate: (): boolean | string => true,
|
|
86
|
+
// options: ['en_US'],
|
|
87
|
+
// default: 'en_US',
|
|
88
|
+
// },
|
|
56
89
|
};
|
|
57
|
-
function validateInput(input, validate) {
|
|
58
|
-
const result = validate(input);
|
|
59
|
-
if (typeof result === 'string')
|
|
60
|
-
throw new Error(result);
|
|
61
|
-
return input;
|
|
62
|
-
}
|
|
63
|
-
function makeFlags(flaggablePrompts) {
|
|
64
|
-
return Object.fromEntries(Object.entries(flaggablePrompts).map(([key, value]) => [
|
|
65
|
-
key,
|
|
66
|
-
Flags.string({
|
|
67
|
-
summary: value.message,
|
|
68
|
-
options: value.options,
|
|
69
|
-
char: value.char,
|
|
70
|
-
// eslint-disable-next-line @typescript-eslint/require-await
|
|
71
|
-
async parse(input) {
|
|
72
|
-
return validateInput(input, value.validate);
|
|
73
|
-
},
|
|
74
|
-
// NOTE: we purposely omit the required property here because we want to allow the flag to be missing in interactive mode
|
|
75
|
-
}),
|
|
76
|
-
]));
|
|
77
|
-
}
|
|
78
90
|
export default class AgentCreateSpec extends SfCommand {
|
|
79
91
|
static summary = messages.getMessage('summary');
|
|
80
92
|
static description = messages.getMessage('description');
|
|
@@ -85,83 +97,172 @@ export default class AgentCreateSpec extends SfCommand {
|
|
|
85
97
|
'target-org': Flags.requiredOrg(),
|
|
86
98
|
'api-version': Flags.orgApiVersion(),
|
|
87
99
|
...makeFlags(FLAGGABLE_PROMPTS),
|
|
88
|
-
|
|
89
|
-
|
|
100
|
+
// a spec file can be used as input. Allows iterative spec development.
|
|
101
|
+
spec: Flags.file({
|
|
102
|
+
summary: messages.getMessage('flags.spec.summary'),
|
|
90
103
|
exists: true,
|
|
91
|
-
summary: messages.getMessage('flags.output-dir.summary'),
|
|
92
|
-
default: 'config',
|
|
93
104
|
}),
|
|
94
|
-
'file
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
105
|
+
'output-file': Flags.file({
|
|
106
|
+
summary: messages.getMessage('flags.output-file.summary'),
|
|
107
|
+
default: join('config', 'agentSpec.yaml'),
|
|
108
|
+
}),
|
|
109
|
+
'full-interview': Flags.boolean({
|
|
110
|
+
summary: messages.getMessage('flags.full-interview.summary'),
|
|
111
|
+
}),
|
|
112
|
+
'prompt-template': Flags.string({
|
|
113
|
+
summary: messages.getMessage('flags.prompt-template.summary'),
|
|
114
|
+
}),
|
|
115
|
+
'grounding-context': Flags.string({
|
|
116
|
+
summary: messages.getMessage('flags.grounding-context.summary'),
|
|
117
|
+
dependsOn: ['prompt-template'],
|
|
118
|
+
}),
|
|
119
|
+
'no-prompt': Flags.boolean({
|
|
120
|
+
summary: messages.getMessage('flags.no-prompt.summary'),
|
|
98
121
|
}),
|
|
99
122
|
};
|
|
123
|
+
// eslint-disable-next-line complexity
|
|
100
124
|
async run() {
|
|
101
125
|
const { flags } = await this.parse(AgentCreateSpec);
|
|
126
|
+
let outputFile;
|
|
127
|
+
try {
|
|
128
|
+
outputFile = await resolveOutputFile(flags['output-file'], flags['no-prompt']);
|
|
129
|
+
}
|
|
130
|
+
catch (e) {
|
|
131
|
+
this.log(messages.getMessage('commandCanceled'));
|
|
132
|
+
// @ts-expect-error expected due to command cancelation.
|
|
133
|
+
return;
|
|
134
|
+
}
|
|
102
135
|
// throw error if --json is used and not all required flags are provided
|
|
103
136
|
if (this.jsonEnabled()) {
|
|
104
137
|
const missingFlags = Object.entries(FLAGGABLE_PROMPTS)
|
|
105
138
|
.filter(([key, prompt]) => 'required' in prompt && prompt.required && !(key in flags))
|
|
106
139
|
.map(([key]) => key);
|
|
107
140
|
if (missingFlags.length) {
|
|
108
|
-
throw
|
|
141
|
+
throw messages.createError('error.missingRequiredFlags', [missingFlags.join(', ')]);
|
|
109
142
|
}
|
|
110
143
|
}
|
|
111
144
|
this.log();
|
|
112
145
|
this.styledHeader('Agent Details');
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
146
|
+
// If spec is provided, read it first
|
|
147
|
+
let inputSpec = {};
|
|
148
|
+
if (flags.spec) {
|
|
149
|
+
inputSpec = YAML.parse(readFileSync(resolve(flags.spec), 'utf8'));
|
|
150
|
+
}
|
|
151
|
+
// Flags override inputSpec values. Prompt if neither is set.
|
|
152
|
+
const type = flags.type ?? validateAgentType(inputSpec?.agentType) ?? (await promptForFlag(FLAGGABLE_PROMPTS.type));
|
|
153
|
+
const companyName = flags['company-name'] ?? inputSpec?.companyName ?? (await promptForFlag(FLAGGABLE_PROMPTS['company-name']));
|
|
154
|
+
const companyDescription = flags['company-description'] ??
|
|
155
|
+
inputSpec?.companyDescription ??
|
|
156
|
+
(await promptForFlag(FLAGGABLE_PROMPTS['company-description']));
|
|
157
|
+
const role = flags.role ?? inputSpec?.role ?? (await promptForFlag(FLAGGABLE_PROMPTS.role));
|
|
158
|
+
// full interview prompts
|
|
159
|
+
const companyWebsite = flags['company-website'] ??
|
|
160
|
+
inputSpec?.companyWebsite ??
|
|
161
|
+
(flags['full-interview'] ? await promptForFlag(FLAGGABLE_PROMPTS['company-website']) : undefined);
|
|
162
|
+
const maxNumOfTopics = flags['max-topics'] ??
|
|
163
|
+
validateMaxTopics(inputSpec?.maxNumOfTopics) ??
|
|
164
|
+
(flags['full-interview'] ? await promptForFlag(FLAGGABLE_PROMPTS['max-topics']) : 10);
|
|
165
|
+
const agentUser = flags['agent-user'] ??
|
|
166
|
+
inputSpec?.agentUser ??
|
|
167
|
+
(flags['full-interview'] ? await promptForFlag(FLAGGABLE_PROMPTS['agent-user']) : undefined);
|
|
168
|
+
let enrichLogs = flags['enrich-logs'] ??
|
|
169
|
+
inputSpec?.enrichLogs ??
|
|
170
|
+
(flags['full-interview'] ? await promptForFlag(FLAGGABLE_PROMPTS['enrich-logs']) : undefined);
|
|
171
|
+
enrichLogs = Boolean(enrichLogs === 'true' || enrichLogs === true);
|
|
172
|
+
const tone = flags.tone ??
|
|
173
|
+
inputSpec?.tone ??
|
|
174
|
+
(flags['full-interview'] ? await promptForFlag(FLAGGABLE_PROMPTS.tone) : undefined);
|
|
175
|
+
// const primaryLanguage =
|
|
176
|
+
// flags['primary-language'] ??
|
|
177
|
+
// inputSpec?.primaryLanguage ??
|
|
178
|
+
// (flags['full-interview'] ? await promptForFlag(FLAGGABLE_PROMPTS['primary-language']) : undefined);
|
|
118
179
|
this.log();
|
|
119
180
|
this.spinner.start('Creating agent spec');
|
|
120
181
|
const connection = flags['target-org'].getConnection(flags['api-version']);
|
|
121
182
|
const agent = new Agent(connection, this.project);
|
|
122
|
-
const
|
|
123
|
-
|
|
124
|
-
type,
|
|
125
|
-
role,
|
|
183
|
+
const specConfig = {
|
|
184
|
+
agentType: type,
|
|
126
185
|
companyName,
|
|
127
186
|
companyDescription,
|
|
128
|
-
|
|
129
|
-
});
|
|
130
|
-
// Write a file with the returned job specs
|
|
131
|
-
const filePath = join(flags['output-dir'], flags['file-name']);
|
|
132
|
-
writeFileSync(filePath, JSON.stringify({ type, role, companyName, companyDescription, companyWebsite, jobSpec: agentSpec }, null, 4));
|
|
133
|
-
this.spinner.stop();
|
|
134
|
-
this.log(`\nSaved agent spec: ${filePath}`);
|
|
135
|
-
return {
|
|
136
|
-
isSuccess: true,
|
|
137
|
-
jobSpec: filePath,
|
|
187
|
+
role,
|
|
138
188
|
};
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
* Get a flag value or prompt the user for a value.
|
|
142
|
-
*
|
|
143
|
-
* Resolution order:
|
|
144
|
-
* - Flag value provided by the user
|
|
145
|
-
* - Prompt the user for a value
|
|
146
|
-
*/
|
|
147
|
-
async getFlagOrPrompt(valueFromFlag, flagDef) {
|
|
148
|
-
const message = flagDef.message.replace(/\.$/, '');
|
|
149
|
-
if (valueFromFlag) {
|
|
150
|
-
this.log(`${ansis.green(figures.tick)} ${ansis.bold(message)} ${ansis.cyan(valueFromFlag)}`);
|
|
151
|
-
return valueFromFlag;
|
|
189
|
+
if (companyWebsite) {
|
|
190
|
+
specConfig.companyWebsite = companyWebsite;
|
|
152
191
|
}
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
192
|
+
const promptTemplateName = flags['prompt-template'] ?? inputSpec?.promptTemplateName;
|
|
193
|
+
if (promptTemplateName) {
|
|
194
|
+
specConfig.promptTemplateName = promptTemplateName;
|
|
195
|
+
const groundingContext = flags['grounding-context'] ?? inputSpec?.groundingContext;
|
|
196
|
+
if (groundingContext) {
|
|
197
|
+
specConfig.groundingContext = groundingContext;
|
|
198
|
+
}
|
|
159
199
|
}
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
});
|
|
200
|
+
if (maxNumOfTopics) {
|
|
201
|
+
specConfig.maxNumOfTopics = Number(maxNumOfTopics);
|
|
202
|
+
}
|
|
203
|
+
// Should we log the specConfig being used? It's returned in the JSON and the generated spec.
|
|
204
|
+
// this.log(`${ansis.green(figures.tick)} ${ansis.bold(message)} ${ansis.cyan(valueFromFlag)}`);
|
|
205
|
+
const specResponse = await agent.createSpecV2(specConfig);
|
|
206
|
+
// @ts-expect-error Need better typing
|
|
207
|
+
const specFileContents = buildSpecFile(specResponse, { agentUser, enrichLogs, tone });
|
|
208
|
+
const outputFilePath = writeSpecFile(outputFile, specFileContents);
|
|
209
|
+
this.spinner.stop();
|
|
210
|
+
this.log(`\nSaved agent spec: ${outputFilePath}`);
|
|
211
|
+
return { ...{ isSuccess: true, specPath: outputFilePath }, ...specResponse, ...specFileContents };
|
|
165
212
|
}
|
|
166
213
|
}
|
|
214
|
+
// Builds spec file contents from the spec response and any additional flags
|
|
215
|
+
// in a specific order.
|
|
216
|
+
const buildSpecFile = (specResponse, extraProps) => {
|
|
217
|
+
const propertyOrder = [
|
|
218
|
+
'agentType',
|
|
219
|
+
'companyName',
|
|
220
|
+
'companyDescription',
|
|
221
|
+
'companyWebsite',
|
|
222
|
+
'role',
|
|
223
|
+
'maxNumOfTopics',
|
|
224
|
+
'agentUser',
|
|
225
|
+
'enrichLogs',
|
|
226
|
+
'tone',
|
|
227
|
+
// 'primaryLanguage',
|
|
228
|
+
'promptTemplateName',
|
|
229
|
+
'groundingContext',
|
|
230
|
+
'topics',
|
|
231
|
+
];
|
|
232
|
+
const specFileContents = {};
|
|
233
|
+
propertyOrder.map((prop) => {
|
|
234
|
+
// @ts-expect-error need better typing of the array.
|
|
235
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
236
|
+
const val = specResponse[prop] ?? extraProps[prop];
|
|
237
|
+
if (val != null || (typeof val === 'string' && val.length > 0)) {
|
|
238
|
+
// @ts-expect-error need better typing of the array.
|
|
239
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
240
|
+
specFileContents[prop] = val;
|
|
241
|
+
}
|
|
242
|
+
});
|
|
243
|
+
return specFileContents;
|
|
244
|
+
};
|
|
245
|
+
const writeSpecFile = (outputFile, agentSpec) => {
|
|
246
|
+
// create the directory if not already created
|
|
247
|
+
const outputFilePath = resolve(outputFile);
|
|
248
|
+
mkdirSync(dirname(outputFilePath), { recursive: true });
|
|
249
|
+
// Write a yaml file with the returned job specs
|
|
250
|
+
writeFileSync(outputFilePath, YAML.stringify(agentSpec));
|
|
251
|
+
return outputFilePath;
|
|
252
|
+
};
|
|
253
|
+
const resolveOutputFile = async (outputFile, noPrompt = false) => {
|
|
254
|
+
let resolvedOutputFile = resolve(outputFile);
|
|
255
|
+
if (!noPrompt) {
|
|
256
|
+
if (existsSync(resolvedOutputFile)) {
|
|
257
|
+
const message = messages.getMessage('confirmSpecOverwrite', [resolvedOutputFile]);
|
|
258
|
+
if (!(await prompts.confirm({ message }))) {
|
|
259
|
+
throw Error('NoOverwrite');
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
if (!resolvedOutputFile.endsWith('.yaml')) {
|
|
264
|
+
resolvedOutputFile = `${resolvedOutputFile}.yaml`;
|
|
265
|
+
}
|
|
266
|
+
return resolvedOutputFile;
|
|
267
|
+
};
|
|
167
268
|
//# sourceMappingURL=spec.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../../../src/commands/agent/generate/spec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../../../src/commands/agent/generate/spec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,KAAK,EAA8C,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAmB,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEpH,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,qBAAqB,CAAC,CAAC;AAiB1F,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE;QACJ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB;QACjF,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;QACjC,QAAQ,EAAE,IAAI;KACf;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB;QACjF,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;QAC1D,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,8BAA8B;QACzF,QAAQ,EAAE,IAAI;KACf;IACD,qBAAqB,EAAE;QACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,mCAAmC,CAAC;QACjE,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,qCAAqC;QAChG,QAAQ,EAAE,IAAI;KACf;IACD,iBAAiB,EAAE;QACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;QAC7D,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE;YACxC,qBAAqB;YACrB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEhC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;gBACnD,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;gBACxD,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;gBACrB,CAAC,GAAG,WAAW,CAAC;gBAChB,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,0BAA0B,CAAC;YACpC,CAAC;QACH,CAAC;KACF;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;QACxD,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;QAC7D,QAAQ,EAAE,GAAqB,EAAE,CAAC,IAAI;QACtC,UAAU;QACV,WAAW;KACZ;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;QACxD,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;QAC7D,QAAQ,EAAE,GAAqB,EAAE,CAAC,IAAI;KACvC;IACD,aAAa,EAAE;QACb,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;QACzD,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;QAC9D,QAAQ,EAAE,GAAqB,EAAE,CAAC,IAAI;QACtC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;QAC1B,OAAO,EAAE,OAAO;KACjB;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC;QACvD,QAAQ,EAAE,GAAqB,EAAE,CAAC,IAAI;QACtC,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC;QACxC,OAAO,EAAE,QAAQ;KAClB;IACD,wBAAwB;IACxB,oEAAoE;IACpE,4CAA4C;IAC5C,wBAAwB;IACxB,sBAAsB;IACtB,KAAK;CACoC,CAAC;AAE5C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,SAAgC;IACpE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IACtB,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IAEvC,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,GAAG,SAAS,CAAC,iBAAiB,CAAC;QAC/B,uEAAuE;QACvE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,MAAM,EAAE,IAAI;SACb,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC;YACxB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;YACzD,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;SAC1C,CAAC;QACF,gBAAgB,EAAE,KAAK,CAAC,OAAO,CAAC;YAC9B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;SAC7D,CAAC;QACF,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC9B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;SAC9D,CAAC;QACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,iCAAiC,CAAC;YAC/D,SAAS,EAAE,CAAC,iBAAiB,CAAC;SAC/B,CAAC;QACF,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC;YACzB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;SACxD,CAAC;KACH,CAAC;IAEF,sCAAsC;IAC/B,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEpD,IAAI,UAAkB,CAAC;QACvB,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,iBAAiB,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QACjF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC;YACjD,wDAAwD;YACxD,OAAO;QACT,CAAC;QAED,wEAAwE;QACxE,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC;iBACnD,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,UAAU,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC;iBACrF,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;YAEvB,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxB,MAAM,QAAQ,CAAC,WAAW,CAAC,4BAA4B,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAEnC,qCAAqC;QACrC,IAAI,SAAS,GAAmC,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAA0B,CAAC;QAC7F,CAAC;QAED,8DAA8D;QAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;QACpH,MAAM,WAAW,GACf,KAAK,CAAC,cAAc,CAAC,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QAC9G,MAAM,kBAAkB,GACtB,KAAK,CAAC,qBAAqB,CAAC;YAC5B,SAAS,EAAE,kBAAkB;YAC7B,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAClE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,SAAS,EAAE,IAAI,IAAI,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5F,yBAAyB;QACzB,MAAM,cAAc,GAClB,KAAK,CAAC,iBAAiB,CAAC;YACxB,SAAS,EAAE,cAAc;YACzB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACpG,MAAM,cAAc,GAClB,KAAK,CAAC,YAAY,CAAC;YACnB,iBAAiB,CAAC,SAAS,EAAE,cAAc,CAAC;YAC5C,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACxF,MAAM,SAAS,GACb,KAAK,CAAC,YAAY,CAAC;YACnB,SAAS,EAAE,SAAS;YACpB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC/F,IAAI,UAAU,GACZ,KAAK,CAAC,aAAa,CAAC;YACpB,SAAS,EAAE,UAAU;YACrB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAChG,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,IAAI,CAAC,CAAC;QACnE,MAAM,IAAI,GACR,KAAK,CAAC,IAAI;YACV,SAAS,EAAE,IAAI;YACf,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACtF,0BAA0B;QAC1B,iCAAiC;QACjC,kCAAkC;QAClC,wGAAwG;QAExG,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAC3E,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAC;QACnD,MAAM,UAAU,GAA+B;YAC7C,SAAS,EAAE,IAA+B;YAC1C,WAAW;YACX,kBAAkB;YAClB,IAAI;SACL,CAAC;QACF,IAAI,cAAc,EAAE,CAAC;YACnB,UAAU,CAAC,cAAc,GAAG,cAAc,CAAC;QAC7C,CAAC;QACD,MAAM,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC,IAAI,SAAS,EAAE,kBAAkB,CAAC;QACrF,IAAI,kBAAkB,EAAE,CAAC;YACvB,UAAU,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;YACnD,MAAM,gBAAgB,GAAG,KAAK,CAAC,mBAAmB,CAAC,IAAI,SAAS,EAAE,gBAAgB,CAAC;YACnF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,UAAU,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;YACjD,CAAC;QACH,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,UAAU,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;QACrD,CAAC;QACD,8FAA8F;QAC9F,gGAAgG;QAChG,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC1D,sCAAsC;QACtC,MAAM,gBAAgB,GAAG,aAAa,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAEtF,MAAM,cAAc,GAAG,aAAa,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QAEnE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,IAAI,CAAC,GAAG,CAAC,uBAAuB,cAAc,EAAE,CAAC,CAAC;QAElD,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,gBAAgB,EAAE,CAAC;IACpG,CAAC;;AAGH,4EAA4E;AAC5E,uBAAuB;AACvB,MAAM,aAAa,GAAG,CACpB,YAA4B,EAC5B,UAA0C,EACnB,EAAE;IACzB,MAAM,aAAa,GAAG;QACpB,WAAW;QACX,aAAa;QACb,oBAAoB;QACpB,gBAAgB;QAChB,MAAM;QACN,gBAAgB;QAChB,WAAW;QACX,YAAY;QACZ,MAAM;QACN,qBAAqB;QACrB,oBAAoB;QACpB,kBAAkB;QAClB,QAAQ;KACT,CAAC;IACF,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,oDAAoD;QACpD,mEAAmE;QACnE,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YAC/D,oDAAoD;YACpD,mEAAmE;YACnE,gBAAgB,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,gBAAyC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,UAAkB,EAAE,SAAyB,EAAU,EAAE;IAC9E,8CAA8C;IAC9C,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAExD,gDAAgD;IAChD,aAAa,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEzD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,KAAK,EAAE,UAAkB,EAAE,QAAQ,GAAG,KAAK,EAAmB,EAAE;IACxF,IAAI,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,IAAI,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnC,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;YAClF,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC1C,MAAM,KAAK,CAAC,aAAa,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1C,kBAAkB,GAAG,GAAG,kBAAkB,OAAO,CAAC;IACpD,CAAC;IACD,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC"}
|
package/messages/agent.create.md
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
Create an agent in your org
|
|
3
|
+
Create an agent in your org using a local agent spec file.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Before you run this command, you must first generate an agent spec file by running the "agent generate spec" CLI command, which outputs a YAML file with the agent properties and list of AI-generated topics. Topics define the range of jobs the agent can handle. Then specify the generated agent spec file to this command using the --spec flag, along with the name (label) of the new agent using the --agent-name flag.
|
|
8
8
|
|
|
9
|
-
When this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent
|
|
9
|
+
When this command finishes, your org contains the new agent, which you can then edit 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. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.
|
|
10
|
+
|
|
11
|
+
Use the --preview flag to review what the agent looks like without actually saving it in your org. Rather, the command creates a JSON file with all the agent details in the current directory.
|
|
10
12
|
|
|
11
13
|
To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <api-name-of-your-agent>".
|
|
12
14
|
|
|
@@ -14,12 +16,36 @@ To open the new agent in your org's Agent Builder UI, run this command: "sf org
|
|
|
14
16
|
|
|
15
17
|
Path to an agent spec file.
|
|
16
18
|
|
|
17
|
-
# flags.
|
|
19
|
+
# flags.preview.summary
|
|
20
|
+
|
|
21
|
+
Preview the agent without saving it in your org.
|
|
22
|
+
|
|
23
|
+
# flags.agent-name.summary
|
|
24
|
+
|
|
25
|
+
Name (label) of the new agent.
|
|
26
|
+
|
|
27
|
+
# flags.agent-api-name.summary
|
|
28
|
+
|
|
29
|
+
API name of the new agent; if not specified, the API name is derived from the agent name (label); the API name must not exist in the org.
|
|
30
|
+
|
|
31
|
+
# flags.planner-id.summary
|
|
18
32
|
|
|
19
|
-
|
|
33
|
+
An existing GenAiPlanner ID to associate with the agent.
|
|
34
|
+
|
|
35
|
+
# error.missingRequiredFlags
|
|
36
|
+
|
|
37
|
+
Missing required flags: %s
|
|
38
|
+
|
|
39
|
+
# error.missingRequiredSpecProperties
|
|
40
|
+
|
|
41
|
+
Missing required spec file properties: %s
|
|
20
42
|
|
|
21
43
|
# examples
|
|
22
44
|
|
|
23
|
-
- Create an agent called "
|
|
45
|
+
- Create an agent called "ResortManager" in an org with alias "my-org" using the specified agent spec file:
|
|
46
|
+
|
|
47
|
+
<%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --target-org my-org
|
|
48
|
+
|
|
49
|
+
- Preview the creation of an agent called "ResortManager" and use your default org:
|
|
24
50
|
|
|
25
|
-
<%= config.bin %> <%= command.id %> --name
|
|
51
|
+
<%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --preview
|
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
Generate an agent spec, which is
|
|
3
|
+
Generate an agent spec, which is a YAML file that captures what an agent can do.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Before you use Salesforce CLI to create an agent in your org, you must first generate an agent spec with this command. An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company description, and then an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Use flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the information. Upon command execution, the large language model (LLM) associated with your org uses the information you provided to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply to your agent or change the description of a particular topic.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
You can iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.
|
|
12
|
+
|
|
13
|
+
You can also specify a custom prompt template that the agent uses, and ground the prompt template to add context and personalization to the agent's prompts.
|
|
14
|
+
|
|
15
|
+
When your agent spec is ready, you then create the agent in your org by running the "agent create" CLI command and specifying the spec with the --spec flag.
|
|
12
16
|
|
|
13
17
|
# flags.type.summary
|
|
14
18
|
|
|
@@ -30,20 +34,88 @@ Description of your company.
|
|
|
30
34
|
|
|
31
35
|
Website URL of your company.
|
|
32
36
|
|
|
33
|
-
# flags.output-
|
|
37
|
+
# flags.output-file.summary
|
|
38
|
+
|
|
39
|
+
Path for the generated YAML agent spec file; can be an absolute or relative path.
|
|
40
|
+
|
|
41
|
+
# flags.max-topics.summary
|
|
42
|
+
|
|
43
|
+
Maximum number of topics to generate in the agent spec; default is 10.
|
|
44
|
+
|
|
45
|
+
# flags.max-topics.prompt
|
|
46
|
+
|
|
47
|
+
Max number of topics to generate (1-30)
|
|
48
|
+
|
|
49
|
+
# flags.prompt-template.summary
|
|
50
|
+
|
|
51
|
+
API name of a customized prompt template to use instead of the default prompt template.
|
|
52
|
+
|
|
53
|
+
# flags.grounding-context.summary
|
|
54
|
+
|
|
55
|
+
Context information and personalization that's added to your prompts when using a custom prompt template.
|
|
56
|
+
|
|
57
|
+
# flags.spec.summary
|
|
58
|
+
|
|
59
|
+
Agent spec file, in YAML format, to use as input to the command.
|
|
60
|
+
|
|
61
|
+
# flags.full-interview.summary
|
|
62
|
+
|
|
63
|
+
Prompt for both required and optional flags.
|
|
64
|
+
|
|
65
|
+
# flags.agent-user.summary
|
|
66
|
+
|
|
67
|
+
Username of a user in your org to assign to your agent; determines what your agent can access and do.
|
|
68
|
+
|
|
69
|
+
# flags.agent-user.prompt
|
|
34
70
|
|
|
35
|
-
|
|
71
|
+
Username for agent
|
|
36
72
|
|
|
37
|
-
# flags.
|
|
73
|
+
# flags.enrich-logs.summary
|
|
38
74
|
|
|
39
|
-
|
|
75
|
+
Adds agent conversation data to event logs so you can view all agent session activity in one place.
|
|
76
|
+
|
|
77
|
+
# flags.enrich-logs.prompt
|
|
78
|
+
|
|
79
|
+
Enrich event logs
|
|
80
|
+
|
|
81
|
+
# flags.tone.summary
|
|
82
|
+
|
|
83
|
+
Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.
|
|
84
|
+
|
|
85
|
+
# flags.tone.prompt
|
|
86
|
+
|
|
87
|
+
Agent conversation tone
|
|
88
|
+
|
|
89
|
+
# flags.primary-language.summary
|
|
90
|
+
|
|
91
|
+
Language the agent uses in conversations.
|
|
92
|
+
|
|
93
|
+
# flags.no-prompt.summary
|
|
94
|
+
|
|
95
|
+
Don't prompt the user to confirm spec file overwrite.
|
|
40
96
|
|
|
41
97
|
# examples
|
|
42
98
|
|
|
43
|
-
-
|
|
99
|
+
- Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:
|
|
100
|
+
|
|
101
|
+
<%= config.bin %> <%= command.id %> --type customer --role "Field customer complaints and manage employee schedules." --company-name "Coral Cloud Resorts" --company-description "Provide customers with exceptional destination activities, unforgettable experiences, and reservation services."
|
|
102
|
+
|
|
103
|
+
- Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the "specs/resortManagerSpec.yaml" file and use the org with alias "my-org":
|
|
104
|
+
|
|
105
|
+
<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
|
|
106
|
+
|
|
107
|
+
- Specify an existing agent spec file called "specs/resortManagerAgent.yaml", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:
|
|
108
|
+
|
|
109
|
+
<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role "Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly" --target-org my-org
|
|
110
|
+
|
|
111
|
+
# error.missingRequiredFlags
|
|
112
|
+
|
|
113
|
+
Missing required flags: %s
|
|
114
|
+
|
|
115
|
+
# confirmSpecOverwrite
|
|
44
116
|
|
|
45
|
-
|
|
117
|
+
Confirm overwrite of spec file %s?
|
|
46
118
|
|
|
47
|
-
|
|
119
|
+
# commandCanceled
|
|
48
120
|
|
|
49
|
-
|
|
121
|
+
Command canceled by user confirmation.
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-agent",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.12.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/plugin-agent",
|
|
9
|
-
"version": "1.
|
|
9
|
+
"version": "1.12.0",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@inquirer/figures": "^1.0.7",
|