@@ -61,22 +61,16 @@ sf plugins
6161
6262<!-- commands -->
6363
64- - [ plugin-agent - PREVIEW] ( #plugin-agent---preview )
65- - [ THIS PLUGIN IS A PREVIEW VERSION AND IS NOT MEANT FOR PRODUCTION USAGE UNTIL ANNOUNCED.] ( #this-plugin-is-a-preview-version-and-is-not-meant-for-production-usage-until-announced )
66- - [ Install] ( #install )
67- - [ Contributing] ( #contributing )
68- - [ CLA] ( #cla )
69- - [ Build] ( #build )
70- - [ Commands] ( #commands )
71- - [ ` sf agent create ` ] ( #sf-agent-create )
72- - [ ` sf agent generate spec ` ] ( #sf-agent-generate-spec )
73- - [ ` sf agent generate test-cases ` ] ( #sf-agent-generate-test-cases )
74- - [ ` sf agent generate test-definition ` ] ( #sf-agent-generate-test-definition )
75- - [ ` sf agent preview ` ] ( #sf-agent-preview )
76- - [ ` sf agent test cancel ` ] ( #sf-agent-test-cancel )
77- - [ ` sf agent test results ` ] ( #sf-agent-test-results )
78- - [ ` sf agent test resume ` ] ( #sf-agent-test-resume )
79- - [ ` sf agent test run ` ] ( #sf-agent-test-run )
64+ - [ ` sf agent create ` ] ( #sf-agent-create )
65+ - [ ` sf agent generate spec ` ] ( #sf-agent-generate-spec )
66+ - [ ` sf agent generate spec-v2 ` ] ( #sf-agent-generate-spec-v2 )
67+ - [ ` sf agent generate test-cases ` ] ( #sf-agent-generate-test-cases )
68+ - [ ` sf agent generate test-definition ` ] ( #sf-agent-generate-test-definition )
69+ - [ ` sf agent preview ` ] ( #sf-agent-preview )
70+ - [ ` sf agent test cancel ` ] ( #sf-agent-test-cancel )
71+ - [ ` sf agent test results ` ] ( #sf-agent-test-results )
72+ - [ ` sf agent test resume ` ] ( #sf-agent-test-resume )
73+ - [ ` sf agent test run ` ] ( #sf-agent-test-run )
8074
8175## ` sf agent create `
8276
@@ -118,7 +112,7 @@ EXAMPLES
118112 $ sf agent create --name CustomerSupportAgent --spec ./config/agentSpec.json --target-org my-org
119113```
120114
121- _ See code: [ src/commands/agent/create.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/create.ts ) _
115+ _ See code: [ src/commands/agent/create.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/create.ts ) _
122116
123117## ` sf agent generate spec `
124118
@@ -179,7 +173,71 @@ EXAMPLES
179173 $ sf agent generate spec --output-dir specs --target-org my-org
180174```
181175
182- _ See code: [ src/commands/agent/generate/spec.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5/src/commands/agent/generate/spec.ts ) _
176+ _ See code: [ src/commands/agent/generate/spec.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0/src/commands/agent/generate/spec.ts ) _
177+
178+ ## ` sf agent generate spec-v2 `
179+
180+ Generate an agent spec, which is the list of jobs that the agent performs.
181+
182+ ```
183+ USAGE
184+ $ sf agent generate spec-v2 -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t customer|internal]
185+ [--role <value>] [--company-name <value>] [--company-description <value>] [--company-website <value>] [--spec
186+ <value>] [--output-file <value>] [--max-topics <value>] [--grounding-context <value> --prompt-template <value>]
187+
188+ FLAGS
189+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
190+ configuration variable is already set.
191+ -t, --type=<option> Type of agent to create.
192+ <options: customer|internal>
193+ --api-version=<value> Override the api version used for api requests made by this command
194+ --company-description=<value> Description of your company.
195+ --company-name=<value> Name of your company.
196+ --company-website=<value> Website URL of your company.
197+ --grounding-context=<value> Context information to be used with the customized prompt template.
198+ --max-topics=<value> Maximum number of agent job topics to generate in the spec; default is 10.
199+ --output-file=<value> [default: config/agentSpec.yaml] Path for the generated agent spec file (yaml); can
200+ be an absolute or relative path.
201+ --prompt-template=<value> Developer name of a customized prompt template to use instead of the default.
202+ --role=<value> Role of the agent.
203+ --spec=<value> Spec file (yaml) to use as input to the command.
204+
205+ GLOBAL FLAGS
206+ --flags-dir=<value> Import flag values from a directory.
207+ --json Format output as json.
208+
209+ DESCRIPTION
210+ Generate an agent spec, which is the list of jobs that the agent performs.
211+
212+ When using Salesforce CLI to create an agent in your org, you can choose to generate a YAML-formatted agent spec file
213+ with this command as a first step.
214+
215+ An agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and
216+ --company-description to provide details about your company and the role that the agent plays in your company; you can
217+ also enter the information interactively if you prefer. When you then execute this command, the large language model
218+ (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs.
219+ We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the
220+ best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can
221+ remove jobs that don't apply to your agent.
222+
223+ When your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the
224+ --job-spec flag of the "agent create" CLI command.
225+
226+ EXAMPLES
227+ Create an agent spec for your default org in the default location and use flags to specify the agent's role and your
228+ company details:
229+
230+ $ sf agent generate spec-v2 --type customer --role "Assist users in navigating and managing bookings" \
231+ --company-name "Coral Cloud" --company-description "Resort that manages guests and their reservations and \
232+ experiences"
233+
234+ Create an agent spec by being prompted for role and company details interactively; write the generated file to the
235+ "specs" directory and use the org with alias "my-org":
236+
237+ $ sf agent generate spec-v2 --output-dir specs --target-org my-org
238+ ```
239+
240+ _ See code: [ src/commands/agent/generate/spec-v2.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0/src/commands/agent/generate/spec-v2.ts ) _
183241
184242## ` sf agent generate test-cases `
185243
@@ -202,7 +260,7 @@ EXAMPLES
202260 $ sf agent generate test-cases
203261```
204262
205- _ See code: [ src/commands/agent/generate/test-cases.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/generate/test-cases.ts ) _
263+ _ See code: [ src/commands/agent/generate/test-cases.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/generate/test-cases.ts ) _
206264
207265## ` sf agent generate test-definition `
208266
@@ -227,7 +285,7 @@ EXAMPLES
227285 $ sf agent generate test-definition
228286```
229287
230- _ See code: [ src/commands/agent/generate/test-definition.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/generate/test-definition.ts ) _
288+ _ See code: [ src/commands/agent/generate/test-definition.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/generate/test-definition.ts ) _
231289
232290## ` sf agent preview `
233291
@@ -262,7 +320,7 @@ FLAG DESCRIPTIONS
262320 the API name of the agent? (TBD based on agents library)
263321```
264322
265- _ See code: [ src/commands/agent/preview.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/preview.ts ) _
323+ _ See code: [ src/commands/agent/preview.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/preview.ts ) _
266324
267325## ` sf agent test cancel `
268326
@@ -299,7 +357,7 @@ EXAMPLES
299357 $ sf agent test cancel --job-id 4KBfake0000003F4AQ --target-org my-org
300358```
301359
302- _ See code: [ src/commands/agent/test/cancel.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/test/cancel.ts ) _
360+ _ See code: [ src/commands/agent/test/cancel.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/test/cancel.ts ) _
303361
304362## ` sf agent test results `
305363
@@ -355,7 +413,7 @@ FLAG DESCRIPTIONS
355413 test results aren't written.
356414```
357415
358- _ See code: [ src/commands/agent/test/results.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/test/results.ts ) _
416+ _ See code: [ src/commands/agent/test/results.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/test/results.ts ) _
359417
360418## ` sf agent test resume `
361419
@@ -418,7 +476,7 @@ FLAG DESCRIPTIONS
418476 test results aren't written.
419477```
420478
421- _ See code: [ src/commands/agent/test/resume.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/test/resume.ts ) _
479+ _ See code: [ src/commands/agent/test/resume.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/test/resume.ts ) _
422480
423481## ` sf agent test run `
424482
@@ -481,6 +539,6 @@ FLAG DESCRIPTIONS
481539 test results aren't written.
482540```
483541
484- _ See code: [ src/commands/agent/test/run.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.7.3-dev.5 /src/commands/agent/test/run.ts ) _
542+ _ See code: [ src/commands/agent/test/run.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.9.0 /src/commands/agent/test/run.ts ) _
485543
486544<!-- commandsstop -->
0 commit comments