@salesforce/plugin-agent 1.26.6 → 1.26.8
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 +36 -32
- package/messages/agent.preview.md +9 -7
- package/oclif.manifest.json +3 -3
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -112,7 +112,7 @@ EXAMPLES
|
|
|
112
112
|
$ sf agent activate --api-name Resort_Manager --target-org my-org
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
115
|
+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/activate.ts)_
|
|
116
116
|
|
|
117
117
|
## `sf agent create`
|
|
118
118
|
|
|
@@ -179,7 +179,7 @@ EXAMPLES
|
|
|
179
179
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
180
180
|
```
|
|
181
181
|
|
|
182
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
182
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/create.ts)_
|
|
183
183
|
|
|
184
184
|
## `sf agent deactivate`
|
|
185
185
|
|
|
@@ -219,7 +219,7 @@ EXAMPLES
|
|
|
219
219
|
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
|
|
220
220
|
```
|
|
221
221
|
|
|
222
|
-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
222
|
+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/deactivate.ts)_
|
|
223
223
|
|
|
224
224
|
## `sf agent generate agent-spec`
|
|
225
225
|
|
|
@@ -326,7 +326,7 @@ EXAMPLES
|
|
|
326
326
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
327
327
|
```
|
|
328
328
|
|
|
329
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
329
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/generate/agent-spec.ts)_
|
|
330
330
|
|
|
331
331
|
## `sf agent generate authoring-bundle`
|
|
332
332
|
|
|
@@ -392,7 +392,7 @@ EXAMPLES
|
|
|
392
392
|
other-package-dir/main/default --target-org my-dev-org
|
|
393
393
|
```
|
|
394
394
|
|
|
395
|
-
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
395
|
+
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/generate/authoring-bundle.ts)_
|
|
396
396
|
|
|
397
397
|
## `sf agent generate template`
|
|
398
398
|
|
|
@@ -440,7 +440,7 @@ EXAMPLES
|
|
|
440
440
|
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
|
|
441
441
|
```
|
|
442
442
|
|
|
443
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
443
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/generate/template.ts)_
|
|
444
444
|
|
|
445
445
|
## `sf agent generate test-spec`
|
|
446
446
|
|
|
@@ -501,7 +501,7 @@ EXAMPLES
|
|
|
501
501
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
502
502
|
```
|
|
503
503
|
|
|
504
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
504
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/generate/test-spec.ts)_
|
|
505
505
|
|
|
506
506
|
## `sf agent preview`
|
|
507
507
|
|
|
@@ -530,37 +530,41 @@ GLOBAL FLAGS
|
|
|
530
530
|
DESCRIPTION
|
|
531
531
|
Interact with an agent to preview how it responds to your statements, questions, and commands (utterances).
|
|
532
532
|
|
|
533
|
-
Use this command to have a natural language conversation with an agent while you code its Agent Script
|
|
534
|
-
Previewing an agent
|
|
535
|
-
you can test that the agent uses a particular topic when asked a question, and
|
|
536
|
-
action associated with that topic. This command is the CLI-equivalent of the
|
|
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.
|
|
538
538
|
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
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.
|
|
542
544
|
|
|
543
|
-
|
|
545
|
+
When previewing an agent from its Agent Script file, you can use these two modes:
|
|
544
546
|
|
|
545
547
|
- 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,
|
|
548
|
+
this mode if none of the Apex classes, flows, or prompt templates that implement your actions are available yet. The
|
|
547
549
|
LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.
|
|
548
550
|
- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview.
|
|
549
551
|
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.
|
|
551
|
-
Apex classes when using live mode.
|
|
552
|
+
your development org if you want to use them in your live preview.
|
|
552
553
|
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
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.
|
|
556
560
|
|
|
557
561
|
When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default,
|
|
558
562
|
the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir
|
|
559
563
|
flag.
|
|
560
564
|
|
|
561
565
|
EXAMPLES
|
|
562
|
-
Preview an agent
|
|
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".
|
|
564
568
|
|
|
565
569
|
$ sf agent preview --target-org my-dev-org
|
|
566
570
|
|
|
@@ -570,7 +574,7 @@ EXAMPLES
|
|
|
570
574
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
571
575
|
```
|
|
572
576
|
|
|
573
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
577
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/preview.ts)_
|
|
574
578
|
|
|
575
579
|
## `sf agent publish authoring-bundle`
|
|
576
580
|
|
|
@@ -617,7 +621,7 @@ EXAMPLES
|
|
|
617
621
|
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
|
|
618
622
|
```
|
|
619
623
|
|
|
620
|
-
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
624
|
+
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/publish/authoring-bundle.ts)_
|
|
621
625
|
|
|
622
626
|
## `sf agent test create`
|
|
623
627
|
|
|
@@ -672,7 +676,7 @@ EXAMPLES
|
|
|
672
676
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
673
677
|
```
|
|
674
678
|
|
|
675
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
679
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/test/create.ts)_
|
|
676
680
|
|
|
677
681
|
## `sf agent test list`
|
|
678
682
|
|
|
@@ -707,7 +711,7 @@ EXAMPLES
|
|
|
707
711
|
$ sf agent test list --target-org my-org
|
|
708
712
|
```
|
|
709
713
|
|
|
710
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
714
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/test/list.ts)_
|
|
711
715
|
|
|
712
716
|
## `sf agent test results`
|
|
713
717
|
|
|
@@ -773,7 +777,7 @@ FLAG DESCRIPTIONS
|
|
|
773
777
|
expression when using custom evaluations.
|
|
774
778
|
```
|
|
775
779
|
|
|
776
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
780
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/test/results.ts)_
|
|
777
781
|
|
|
778
782
|
## `sf agent test resume`
|
|
779
783
|
|
|
@@ -846,7 +850,7 @@ FLAG DESCRIPTIONS
|
|
|
846
850
|
expression when using custom evaluations.
|
|
847
851
|
```
|
|
848
852
|
|
|
849
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
853
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/test/resume.ts)_
|
|
850
854
|
|
|
851
855
|
## `sf agent test run`
|
|
852
856
|
|
|
@@ -920,7 +924,7 @@ FLAG DESCRIPTIONS
|
|
|
920
924
|
expression when using custom evaluations.
|
|
921
925
|
```
|
|
922
926
|
|
|
923
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
927
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/test/run.ts)_
|
|
924
928
|
|
|
925
929
|
## `sf agent validate authoring-bundle`
|
|
926
930
|
|
|
@@ -967,6 +971,6 @@ EXAMPLES
|
|
|
967
971
|
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
|
|
968
972
|
```
|
|
969
973
|
|
|
970
|
-
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.
|
|
974
|
+
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.26.8/src/commands/agent/validate/authoring-bundle.ts)_
|
|
971
975
|
|
|
972
976
|
<!-- commandsstop -->
|
|
@@ -4,16 +4,18 @@ Interact with an agent to preview how it responds to your statements, questions,
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
Use this command to have a natural language conversation with an agent while you code its Agent Script file. Previewing an agent
|
|
7
|
+
Use this command to have a natural language conversation with an agent, either while you code its local Agent Script file or when it's published to an org. Previewing an agent acts like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Run without flags, this command provides a list of agents to preview, divided into two categories: "Agent Script", which are agents that have a local authoring bundle in your DX project, or "Published", which are agents that are published and activated in your org. Authoring bundles contain an agent's Agent Script file. You then choose the agent you want to preview from the list. Or you can use the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
When previewing an agent from its Agent Script file, you can use these two modes:
|
|
12
12
|
|
|
13
|
-
- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows,
|
|
14
|
-
- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview.
|
|
13
|
+
- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, or prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.
|
|
14
|
+
- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview.
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
You can use the Apex Replay Debugger to debug your Apex classes when using live mode for Agent Script files and for activated published agents; specify the --apex-debug flag.
|
|
17
|
+
|
|
18
|
+
Once connected to your agent, the preview interface is simple: in the "Start typing..." prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.
|
|
17
19
|
|
|
18
20
|
When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir flag.
|
|
19
21
|
|
|
@@ -39,7 +41,7 @@ Enable Apex debug logging during the agent preview conversation.
|
|
|
39
41
|
|
|
40
42
|
# examples
|
|
41
43
|
|
|
42
|
-
- Preview an agent
|
|
44
|
+
- Preview an agent by choosing from the list of available local Agent Script or published agents. If previewing a local Agent Script agent, use simulated mode. Use the org with alias "my-dev-org".
|
|
43
45
|
|
|
44
46
|
<%= config.bin %> <%= command.id %> --target-org my-dev-org
|
|
45
47
|
|
package/oclif.manifest.json
CHANGED
|
@@ -248,9 +248,9 @@
|
|
|
248
248
|
"agent:preview": {
|
|
249
249
|
"aliases": [],
|
|
250
250
|
"args": {},
|
|
251
|
-
"description": "Use this command to have a natural language conversation with an agent while you code its Agent Script file. Previewing an agent
|
|
251
|
+
"description": "Use this command to have a natural language conversation with an agent, either while you code its local Agent Script file or when it's published to an org. Previewing an agent acts like an initial test to make sure it responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce Builder UI.\n\nRun without flags, this command provides a list of agents to preview, divided into two categories: \"Agent Script\", which are agents that have a local authoring bundle in your DX project, or \"Published\", which are agents that are published and activated in your org. Authoring bundles contain an agent's Agent Script file. You then choose the agent you want to preview from the list. Or you can use the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent.\n\nWhen previewing an agent from its Agent Script file, you can use these two modes:\n\n- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use this mode if none of the Apex classes, flows, or prompt templates that implement your actions are available yet. The LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.\n- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview. If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to your development org if you want to use them in your live preview.\n\nYou can use the Apex Replay Debugger to debug your Apex classes when using live mode for Agent Script files and for activated published agents; specify the --apex-debug flag.\n\nOnce connected to your agent, the preview interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory with the --output-dir flag.",
|
|
252
252
|
"examples": [
|
|
253
|
-
"Preview an agent
|
|
253
|
+
"Preview an agent by choosing from the list of available local Agent Script or published agents. If previewing a local Agent Script agent, use simulated mode. Use the org with alias \"my-dev-org\".\n<%= config.bin %> <%= command.id %> --target-org my-dev-org",
|
|
254
254
|
"Preview an agent in live mode by choosing from a list of authoring bundles. Save the conversation transcripts to the \"./transcripts/my-preview\" directory, enable the Apex debug logs, and use your default org:\n<%= config.bin %> <%= command.id %> --use-live-actions --apex-debug --output-dir transcripts/my-preview"
|
|
255
255
|
],
|
|
256
256
|
"flags": {
|
|
@@ -1481,5 +1481,5 @@
|
|
|
1481
1481
|
]
|
|
1482
1482
|
}
|
|
1483
1483
|
},
|
|
1484
|
-
"version": "1.26.
|
|
1484
|
+
"version": "1.26.8"
|
|
1485
1485
|
}
|
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.26.
|
|
4
|
+
"version": "1.26.8",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
"exports": "./lib/index.js",
|
|
238
238
|
"type": "module",
|
|
239
239
|
"sfdx": {
|
|
240
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.
|
|
241
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.
|
|
240
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.8.crt",
|
|
241
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.26.8.sig"
|
|
242
242
|
}
|
|
243
243
|
}
|