@salesforce/plugin-agent 1.40.5 → 1.42.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 +443 -34
- package/lib/commands/agent/adl/create.d.ts +23 -0
- package/lib/commands/agent/adl/create.js +104 -0
- package/lib/commands/agent/adl/create.js.map +1 -0
- package/lib/commands/agent/adl/delete.d.ts +18 -0
- package/lib/commands/agent/adl/delete.js +51 -0
- package/lib/commands/agent/adl/delete.js.map +1 -0
- package/lib/commands/agent/adl/file/add.d.ts +17 -0
- package/lib/commands/agent/adl/file/add.js +59 -0
- package/lib/commands/agent/adl/file/add.js.map +1 -0
- package/lib/commands/agent/adl/file/delete.d.ts +19 -0
- package/lib/commands/agent/adl/file/delete.js +55 -0
- package/lib/commands/agent/adl/file/delete.js.map +1 -0
- package/lib/commands/agent/adl/file/list.d.ts +18 -0
- package/lib/commands/agent/adl/file/list.js +51 -0
- package/lib/commands/agent/adl/file/list.js.map +1 -0
- package/lib/commands/agent/adl/get.d.ts +16 -0
- package/lib/commands/agent/adl/get.js +51 -0
- package/lib/commands/agent/adl/get.js.map +1 -0
- package/lib/commands/agent/adl/list.d.ts +17 -0
- package/lib/commands/agent/adl/list.js +57 -0
- package/lib/commands/agent/adl/list.js.map +1 -0
- package/lib/commands/agent/adl/status.d.ts +16 -0
- package/lib/commands/agent/adl/status.js +57 -0
- package/lib/commands/agent/adl/status.js.map +1 -0
- package/lib/commands/agent/adl/update.d.ts +20 -0
- package/lib/commands/agent/adl/update.js +90 -0
- package/lib/commands/agent/adl/update.js.map +1 -0
- package/lib/commands/agent/adl/upload.d.ts +18 -0
- package/lib/commands/agent/adl/upload.js +73 -0
- package/lib/commands/agent/adl/upload.js.map +1 -0
- package/lib/commands/agent/test/create.d.ts +1 -0
- package/lib/commands/agent/test/create.js +13 -8
- package/lib/commands/agent/test/create.js.map +1 -1
- package/messages/agent.adl.create.md +65 -0
- package/messages/agent.adl.delete.md +21 -0
- package/messages/agent.adl.file.add.md +27 -0
- package/messages/agent.adl.file.delete.md +25 -0
- package/messages/agent.adl.file.list.md +25 -0
- package/messages/agent.adl.get.md +21 -0
- package/messages/agent.adl.list.md +21 -0
- package/messages/agent.adl.status.md +21 -0
- package/messages/agent.adl.update.md +49 -0
- package/messages/agent.adl.upload.md +55 -0
- package/messages/agent.test.create.md +7 -3
- package/oclif.manifest.json +2071 -1100
- package/package.json +15 -5
- package/schemas/agent-adl-create.json +83 -0
- package/schemas/agent-adl-delete.json +19 -0
- package/schemas/agent-adl-file-add.json +25 -0
- package/schemas/agent-adl-file-delete.json +19 -0
- package/schemas/agent-adl-file-list.json +44 -0
- package/schemas/agent-adl-get.json +83 -0
- package/schemas/agent-adl-list.json +44 -0
- package/schemas/agent-adl-status.json +63 -0
- package/schemas/agent-adl-update.json +83 -0
- package/schemas/agent-adl-upload.json +28 -0
- package/schemas/agent-preview-end.json +2 -5
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Update an Agentforce Data Library.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
Updates the label, description, or other mutable properties of an existing data library.
|
|
8
|
+
|
|
9
|
+
# examples
|
|
10
|
+
|
|
11
|
+
- Update the label of a data library:
|
|
12
|
+
|
|
13
|
+
<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --name "New Name" --target-org myOrg
|
|
14
|
+
|
|
15
|
+
- Update the description:
|
|
16
|
+
|
|
17
|
+
<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --description "Updated description" --target-org myOrg
|
|
18
|
+
|
|
19
|
+
- Update Knowledge library content fields (triggers re-indexing):
|
|
20
|
+
|
|
21
|
+
<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --content-fields "Answer**c,Summary**c" --target-org myOrg
|
|
22
|
+
|
|
23
|
+
- Restrict Knowledge library to public articles:
|
|
24
|
+
|
|
25
|
+
<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg
|
|
26
|
+
|
|
27
|
+
# flags.library-id.summary
|
|
28
|
+
|
|
29
|
+
Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
30
|
+
|
|
31
|
+
# flags.name.summary
|
|
32
|
+
|
|
33
|
+
New display name for the data library (max 80 characters).
|
|
34
|
+
|
|
35
|
+
# flags.description.summary
|
|
36
|
+
|
|
37
|
+
New description for the data library (max 255 characters).
|
|
38
|
+
|
|
39
|
+
# flags.content-fields.summary
|
|
40
|
+
|
|
41
|
+
Comma-separated list of content fields for KNOWLEDGE libraries (triggers re-indexing).
|
|
42
|
+
|
|
43
|
+
# flags.restrict-to-public-articles.summary
|
|
44
|
+
|
|
45
|
+
Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers re-indexing).
|
|
46
|
+
|
|
47
|
+
# error.updateFailed
|
|
48
|
+
|
|
49
|
+
Failed to update data library: %s
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file, triggers indexing, and optionally polls until the library is ready (retrieverId is populated).
|
|
8
|
+
|
|
9
|
+
This command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER libraries require no file upload.
|
|
10
|
+
|
|
11
|
+
# examples
|
|
12
|
+
|
|
13
|
+
- Upload a file and wait for indexing to complete:
|
|
14
|
+
|
|
15
|
+
<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10
|
|
16
|
+
|
|
17
|
+
- Upload a file without waiting:
|
|
18
|
+
|
|
19
|
+
<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg
|
|
20
|
+
|
|
21
|
+
# flags.library-id.summary
|
|
22
|
+
|
|
23
|
+
Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
24
|
+
|
|
25
|
+
# flags.file.summary
|
|
26
|
+
|
|
27
|
+
Path to the file to upload.
|
|
28
|
+
|
|
29
|
+
# flags.wait.summary
|
|
30
|
+
|
|
31
|
+
Number of minutes to wait for indexing to complete. If not specified, returns after triggering indexing.
|
|
32
|
+
|
|
33
|
+
# error.uploadReadiness
|
|
34
|
+
|
|
35
|
+
Library is not ready for upload: %s
|
|
36
|
+
|
|
37
|
+
# error.getUploadUrl
|
|
38
|
+
|
|
39
|
+
Failed to get upload URL: %s
|
|
40
|
+
|
|
41
|
+
# error.s3Upload
|
|
42
|
+
|
|
43
|
+
Failed to upload file to storage: %s
|
|
44
|
+
|
|
45
|
+
# error.indexing
|
|
46
|
+
|
|
47
|
+
Failed to trigger indexing: %s
|
|
48
|
+
|
|
49
|
+
# error.polling
|
|
50
|
+
|
|
51
|
+
Failed to poll library status: %s
|
|
52
|
+
|
|
53
|
+
# error.timeout
|
|
54
|
+
|
|
55
|
+
Indexing did not complete within the specified wait time. Use "sf agent adl get --library-id %s" to check status.
|
|
@@ -6,7 +6,7 @@ Create an agent test in your org using a local test spec YAML file.
|
|
|
6
6
|
|
|
7
7
|
To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the "agent generate test-spec" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.
|
|
8
8
|
|
|
9
|
-
When this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI. This command also retrieves the metadata component
|
|
9
|
+
When this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI (legacy) or Agentforce Studio (NGT). This command also retrieves the metadata component associated with the new test to your local Salesforce DX project and displays its filename. By default, the legacy AiEvaluationDefinition is created; use --test-runner agentforce-studio to author an AiTestingDefinition (NGT) instead.
|
|
10
10
|
|
|
11
11
|
After you've created the test in the org, use the "agent test run" command to run it.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Path to the test spec YAML file.
|
|
|
16
16
|
|
|
17
17
|
# flags.preview.summary
|
|
18
18
|
|
|
19
|
-
Preview the test metadata file
|
|
19
|
+
Preview the test metadata file without deploying to your org.
|
|
20
20
|
|
|
21
21
|
# flags.force-overwrite.summary
|
|
22
22
|
|
|
@@ -40,13 +40,17 @@ API name of the new test; the API name must not exist in the org.
|
|
|
40
40
|
|
|
41
41
|
<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
42
42
|
|
|
43
|
+
- Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:
|
|
44
|
+
|
|
45
|
+
<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org
|
|
46
|
+
|
|
43
47
|
# prompt.confirm
|
|
44
48
|
|
|
45
49
|
A test with the API name %s already exists in the org. Do you want to overwrite it?
|
|
46
50
|
|
|
47
51
|
# info.success
|
|
48
52
|
|
|
49
|
-
Local
|
|
53
|
+
Local test metadata XML file created at %s and agent test deployed to %s.
|
|
50
54
|
|
|
51
55
|
# info.preview-success
|
|
52
56
|
|