@@ -112,7 +112,7 @@ EXAMPLES
112112 $ sf agent activate --api-name Resort_Manager --target-org my-org
113113```
114114
115- _ See code: [ src/commands/agent/activate.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/activate.ts ) _
115+ _ See code: [ src/commands/agent/activate.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/activate.ts ) _
116116
117117## ` sf agent create `
118118
@@ -179,7 +179,7 @@ EXAMPLES
179179 $ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
180180```
181181
182- _ See code: [ src/commands/agent/create.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/create.ts ) _
182+ _ See code: [ src/commands/agent/create.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/create.ts ) _
183183
184184## ` sf agent deactivate `
185185
@@ -219,7 +219,7 @@ EXAMPLES
219219 $ sf agent deactivate --api-name Resort_Manager --target-org my-org
220220```
221221
222- _ See code: [ src/commands/agent/deactivate.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/deactivate.ts ) _
222+ _ See code: [ src/commands/agent/deactivate.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/deactivate.ts ) _
223223
224224## ` sf agent generate agent-spec `
225225
@@ -326,7 +326,7 @@ EXAMPLES
326326 $ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
327327```
328328
329- _ See code: [ src/commands/agent/generate/agent-spec.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/generate/agent-spec.ts ) _
329+ _ See code: [ src/commands/agent/generate/agent-spec.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/generate/agent-spec.ts ) _
330330
331331## ` sf agent generate authoring-bundle `
332332
@@ -392,7 +392,7 @@ EXAMPLES
392392 other-package-dir/main/default --target-org my-dev-org
393393```
394394
395- _ See code: [ src/commands/agent/generate/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/generate/authoring-bundle.ts ) _
395+ _ See code: [ src/commands/agent/generate/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/generate/authoring-bundle.ts ) _
396396
397397## ` sf agent generate template `
398398
@@ -440,7 +440,7 @@ EXAMPLES
440440 force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
441441```
442442
443- _ See code: [ src/commands/agent/generate/template.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/generate/template.ts ) _
443+ _ See code: [ src/commands/agent/generate/template.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/generate/template.ts ) _
444444
445445## ` sf agent generate test-spec `
446446
@@ -501,7 +501,7 @@ EXAMPLES
501501 force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
502502```
503503
504- _ See code: [ src/commands/agent/generate/test-spec.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/generate/test-spec.ts ) _
504+ _ See code: [ src/commands/agent/generate/test-spec.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/generate/test-spec.ts ) _
505505
506506## ` sf agent preview `
507507
@@ -530,37 +530,41 @@ GLOBAL FLAGS
530530DESCRIPTION
531531 Interact with an agent to preview how it responds to your statements, questions, and commands (utterances).
532532
533- Use this command to have a natural language conversation with an agent while you code its Agent Script file.
534- Previewing an agent works like an initial test to make sure it responds to your utterances as you expect. For example,
535- you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct
536- action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce
537- Builder UI.
533+ Use this command to have a natural language conversation with an agent, either while you code its local Agent Script
534+ file or when it's published to an org. Previewing an agent acts like an initial test to make sure it responds to your
535+ utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and
536+ then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the
537+ Preview panel in your org's Agentforce Builder UI.
538538
539- This command uses the agent's local authoring bundle, which contains its Agent Script file. You can let the command
540- provide a list of authoring bundles (labeled "(Agent Script)") to choose from or use the --authoring-bundle flag to
541- specify a bundle's API name.
539+ Run without flags, this command provides a list of agents to preview, divided into two categories: "Agent Script",
540+ which are agents that have a local authoring bundle in your DX project, or "Published", which are agents that are
541+ published and activated in your org. Authoring bundles contain an agent's Agent Script file. You then choose the agent
542+ you want to preview from the list. Or you can use the --authoring-bundle flag to specify a local authoring bundle's
543+ API name or --api-name to specify an activated published agent.
542544
543- You can use these two modes when previewing an agent from its Agent Script file:
545+ When previewing an agent from its Agent Script file, you can use these two modes :
544546
545547 - Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use
546- this mode if none of the Apex classes, flows, and prompt templates that implement your actions are available yet. The
548+ this mode if none of the Apex classes, flows, or prompt templates that implement your actions are available yet. The
547549 LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.
548550 - Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview.
549551 If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to
550- your development org if you want to use them in your live preview. You can use the Apex Replay Debugger to debug your
551- Apex classes when using live mode.
552+ your development org if you want to use them in your live preview.
552553
553- The interface is simple: in the "Start typing..." prompt, enter a statement, question, or command; when you're done,
554- enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To
555- exit the conversation, hit ESC or Control+C.
554+ You can use the Apex Replay Debugger to debug your Apex classes when using live mode for Agent Script files and for
555+ activated published agents; specify the --apex-debug flag.
556+
557+ Once connected to your agent, the preview interface is simple: in the "Start typing..." prompt, enter a statement,
558+ question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp.
559+ The agent then responds on the left. To exit the conversation, hit ESC or Control+C.
556560
557561 When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default,
558562 the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir
559563 flag.
560564
561565EXAMPLES
562- Preview an agent in simulated mode by choosing from a list of authoring bundles provided by the command; use the org
563- with alias "my-dev-org":
566+ Preview an agent by choosing from the list of available local Agent Script or published agents. If previewing a
567+ local Agent Script agent, use simulated mode. Use the org with alias "my-dev-org".
564568
565569 $ sf agent preview --target-org my-dev-org
566570
@@ -570,7 +574,7 @@ EXAMPLES
570574 $ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
571575```
572576
573- _ See code: [ src/commands/agent/preview.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/preview.ts ) _
577+ _ See code: [ src/commands/agent/preview.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/preview.ts ) _
574578
575579## ` sf agent publish authoring-bundle `
576580
@@ -617,7 +621,7 @@ EXAMPLES
617621 $ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
618622```
619623
620- _ See code: [ src/commands/agent/publish/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/publish/authoring-bundle.ts ) _
624+ _ See code: [ src/commands/agent/publish/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/publish/authoring-bundle.ts ) _
621625
622626## ` sf agent test create `
623627
@@ -672,7 +676,7 @@ EXAMPLES
672676 $ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
673677```
674678
675- _ See code: [ src/commands/agent/test/create.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/test/create.ts ) _
679+ _ See code: [ src/commands/agent/test/create.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/test/create.ts ) _
676680
677681## ` sf agent test list `
678682
@@ -707,7 +711,7 @@ EXAMPLES
707711 $ sf agent test list --target-org my-org
708712```
709713
710- _ See code: [ src/commands/agent/test/list.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/test/list.ts ) _
714+ _ See code: [ src/commands/agent/test/list.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/test/list.ts ) _
711715
712716## ` sf agent test results `
713717
@@ -773,7 +777,7 @@ FLAG DESCRIPTIONS
773777 expression when using custom evaluations.
774778```
775779
776- _ See code: [ src/commands/agent/test/results.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/test/results.ts ) _
780+ _ See code: [ src/commands/agent/test/results.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/test/results.ts ) _
777781
778782## ` sf agent test resume `
779783
@@ -846,7 +850,7 @@ FLAG DESCRIPTIONS
846850 expression when using custom evaluations.
847851```
848852
849- _ See code: [ src/commands/agent/test/resume.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/test/resume.ts ) _
853+ _ See code: [ src/commands/agent/test/resume.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/test/resume.ts ) _
850854
851855## ` sf agent test run `
852856
@@ -920,7 +924,7 @@ FLAG DESCRIPTIONS
920924 expression when using custom evaluations.
921925```
922926
923- _ See code: [ src/commands/agent/test/run.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/test/run.ts ) _
927+ _ See code: [ src/commands/agent/test/run.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/test/run.ts ) _
924928
925929## ` sf agent validate authoring-bundle `
926930
@@ -967,6 +971,6 @@ EXAMPLES
967971 $ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
968972```
969973
970- _ See code: [ src/commands/agent/validate/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.6 /src/commands/agent/validate/authoring-bundle.ts ) _
974+ _ See code: [ src/commands/agent/validate/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-agent/blob/1.26.7 /src/commands/agent/validate/authoring-bundle.ts ) _
971975
972976<!-- commandsstop -->
0 commit comments