@salesforce/plugin-agent 1.24.0 → 1.24.1
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 +15 -12
- package/messages/agent.generate.test-spec.md +2 -0
- package/npm-shrinkwrap.json +2 -2
- package/oclif.manifest.json +2 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -109,7 +109,7 @@ EXAMPLES
|
|
|
109
109
|
$ sf agent activate --api-name Resort_Manager --target-org my-org
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
112
|
+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/activate.ts)_
|
|
113
113
|
|
|
114
114
|
## `sf agent create`
|
|
115
115
|
|
|
@@ -171,7 +171,7 @@ EXAMPLES
|
|
|
171
171
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
172
172
|
```
|
|
173
173
|
|
|
174
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
174
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/create.ts)_
|
|
175
175
|
|
|
176
176
|
## `sf agent deactivate`
|
|
177
177
|
|
|
@@ -211,7 +211,7 @@ EXAMPLES
|
|
|
211
211
|
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
|
|
212
212
|
```
|
|
213
213
|
|
|
214
|
-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
214
|
+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/deactivate.ts)_
|
|
215
215
|
|
|
216
216
|
## `sf agent generate agent-spec`
|
|
217
217
|
|
|
@@ -316,7 +316,7 @@ EXAMPLES
|
|
|
316
316
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
317
317
|
```
|
|
318
318
|
|
|
319
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
319
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/generate/agent-spec.ts)_
|
|
320
320
|
|
|
321
321
|
## `sf agent generate template`
|
|
322
322
|
|
|
@@ -364,7 +364,7 @@ EXAMPLES
|
|
|
364
364
|
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
|
|
365
365
|
```
|
|
366
366
|
|
|
367
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
367
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/generate/template.ts)_
|
|
368
368
|
|
|
369
369
|
## `sf agent generate test-spec`
|
|
370
370
|
|
|
@@ -399,6 +399,9 @@ DESCRIPTION
|
|
|
399
399
|
- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.
|
|
400
400
|
- Expected actions: One or more API names of the expection actions the agent takes.
|
|
401
401
|
- Expected outcome: Natural language description of the outcome you expect.
|
|
402
|
+
- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.
|
|
403
|
+
- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a
|
|
404
|
+
conversation history.
|
|
402
405
|
|
|
403
406
|
When your test spec is ready, you then run the "agent test create" command to actually create the test in your org and
|
|
404
407
|
synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.
|
|
@@ -422,7 +425,7 @@ EXAMPLES
|
|
|
422
425
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
423
426
|
```
|
|
424
427
|
|
|
425
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
428
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/generate/test-spec.ts)_
|
|
426
429
|
|
|
427
430
|
## `sf agent preview`
|
|
428
431
|
|
|
@@ -486,7 +489,7 @@ EXAMPLES
|
|
|
486
489
|
transcripts/my-preview
|
|
487
490
|
```
|
|
488
491
|
|
|
489
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
492
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/preview.ts)_
|
|
490
493
|
|
|
491
494
|
## `sf agent test create`
|
|
492
495
|
|
|
@@ -541,7 +544,7 @@ EXAMPLES
|
|
|
541
544
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
542
545
|
```
|
|
543
546
|
|
|
544
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
547
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/create.ts)_
|
|
545
548
|
|
|
546
549
|
## `sf agent test list`
|
|
547
550
|
|
|
@@ -576,7 +579,7 @@ EXAMPLES
|
|
|
576
579
|
$ sf agent test list --target-org my-org
|
|
577
580
|
```
|
|
578
581
|
|
|
579
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
582
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/list.ts)_
|
|
580
583
|
|
|
581
584
|
## `sf agent test results`
|
|
582
585
|
|
|
@@ -632,7 +635,7 @@ FLAG DESCRIPTIONS
|
|
|
632
635
|
test results aren't written.
|
|
633
636
|
```
|
|
634
637
|
|
|
635
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
638
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/results.ts)_
|
|
636
639
|
|
|
637
640
|
## `sf agent test resume`
|
|
638
641
|
|
|
@@ -695,7 +698,7 @@ FLAG DESCRIPTIONS
|
|
|
695
698
|
test results aren't written.
|
|
696
699
|
```
|
|
697
700
|
|
|
698
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
701
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/resume.ts)_
|
|
699
702
|
|
|
700
703
|
## `sf agent test run`
|
|
701
704
|
|
|
@@ -759,6 +762,6 @@ FLAG DESCRIPTIONS
|
|
|
759
762
|
test results aren't written.
|
|
760
763
|
```
|
|
761
764
|
|
|
762
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.
|
|
765
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/run.ts)_
|
|
763
766
|
|
|
764
767
|
<!-- commandsstop -->
|
|
@@ -12,6 +12,8 @@ To generate a specific agent test case, this command prompts you for this inform
|
|
|
12
12
|
- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.
|
|
13
13
|
- Expected actions: One or more API names of the expection actions the agent takes.
|
|
14
14
|
- Expected outcome: Natural language description of the outcome you expect.
|
|
15
|
+
- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.
|
|
16
|
+
- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.
|
|
15
17
|
|
|
16
18
|
When your test spec is ready, you then run the "agent test create" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.
|
|
17
19
|
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-agent",
|
|
3
|
-
"version": "1.24.
|
|
3
|
+
"version": "1.24.1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/plugin-agent",
|
|
9
|
-
"version": "1.24.
|
|
9
|
+
"version": "1.24.1",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@inquirer/core": "^10.1.6",
|
package/oclif.manifest.json
CHANGED
|
@@ -611,7 +611,7 @@
|
|
|
611
611
|
"agent:generate:test-spec": {
|
|
612
612
|
"aliases": [],
|
|
613
613
|
"args": {},
|
|
614
|
-
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.\n\nIf you have an existing AiEvaluationDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag.",
|
|
614
|
+
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.\n\nIf you have an existing AiEvaluationDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag.",
|
|
615
615
|
"examples": [
|
|
616
616
|
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
617
617
|
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
@@ -1170,5 +1170,5 @@
|
|
|
1170
1170
|
]
|
|
1171
1171
|
}
|
|
1172
1172
|
},
|
|
1173
|
-
"version": "1.24.
|
|
1173
|
+
"version": "1.24.1"
|
|
1174
1174
|
}
|
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.24.
|
|
4
|
+
"version": "1.24.1",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -230,7 +230,7 @@
|
|
|
230
230
|
"exports": "./lib/index.js",
|
|
231
231
|
"type": "module",
|
|
232
232
|
"sfdx": {
|
|
233
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.
|
|
234
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.
|
|
233
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.1.crt",
|
|
234
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.1.sig"
|
|
235
235
|
}
|
|
236
236
|
}
|