@salesforce/plugin-agent 1.41.0 → 1.42.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 +424 -23
- 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 +63 -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 +64 -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 +66 -0
- package/lib/commands/agent/adl/get.js.map +1 -0
- package/lib/commands/agent/adl/list.d.ts +18 -0
- package/lib/commands/agent/adl/list.js +63 -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 +21 -0
- package/lib/commands/agent/adl/update.js +102 -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 +80 -0
- package/lib/commands/agent/adl/upload.js.map +1 -0
- package/lib/commands/agent/generate/test-spec.js +1 -1
- package/lib/commands/agent/generate/test-spec.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 +31 -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 +25 -0
- package/messages/agent.adl.status.md +21 -0
- package/messages/agent.adl.update.md +53 -0
- package/messages/agent.adl.upload.md +55 -0
- package/oclif.manifest.json +1799 -821
- package/package.json +14 -4
- package/schemas/agent-adl-create.json +83 -0
- package/schemas/agent-adl-delete.json +19 -0
- package/schemas/agent-adl-file-add.json +31 -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
package/README.md
CHANGED
|
@@ -60,6 +60,16 @@ sf plugins
|
|
|
60
60
|
<!-- commands -->
|
|
61
61
|
|
|
62
62
|
- [`sf agent activate`](#sf-agent-activate)
|
|
63
|
+
- [`sf agent adl create`](#sf-agent-adl-create)
|
|
64
|
+
- [`sf agent adl delete`](#sf-agent-adl-delete)
|
|
65
|
+
- [`sf agent adl file add`](#sf-agent-adl-file-add)
|
|
66
|
+
- [`sf agent adl file delete`](#sf-agent-adl-file-delete)
|
|
67
|
+
- [`sf agent adl file list`](#sf-agent-adl-file-list)
|
|
68
|
+
- [`sf agent adl get`](#sf-agent-adl-get)
|
|
69
|
+
- [`sf agent adl list`](#sf-agent-adl-list)
|
|
70
|
+
- [`sf agent adl status`](#sf-agent-adl-status)
|
|
71
|
+
- [`sf agent adl update`](#sf-agent-adl-update)
|
|
72
|
+
- [`sf agent adl upload`](#sf-agent-adl-upload)
|
|
63
73
|
- [`sf agent create`](#sf-agent-create)
|
|
64
74
|
- [`sf agent deactivate`](#sf-agent-deactivate)
|
|
65
75
|
- [`sf agent generate agent-spec`](#sf-agent-generate-agent-spec)
|
|
@@ -130,7 +140,398 @@ EXAMPLES
|
|
|
130
140
|
$ sf agent activate --api-name Resort_Manager --version 2 --target-org my-org
|
|
131
141
|
```
|
|
132
142
|
|
|
133
|
-
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
143
|
+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/activate.ts)_
|
|
144
|
+
|
|
145
|
+
## `sf agent adl create`
|
|
146
|
+
|
|
147
|
+
Create an Agentforce Data Library.
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
USAGE
|
|
151
|
+
$ sf agent adl create -o <value> -n <value> --developer-name <value> --source-type sfdrive|knowledge|retriever
|
|
152
|
+
[--json] [--flags-dir <value>] [--api-version <value>] [--description <value>] [--index-mode basic|enhanced]
|
|
153
|
+
[--retriever-id <value>] [--primary-index-field1 <value>] [--primary-index-field2 <value>]
|
|
154
|
+
|
|
155
|
+
FLAGS
|
|
156
|
+
-n, --name=<value> (required) Display name for the data library (max 80 characters).
|
|
157
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
158
|
+
configuration variable is already set.
|
|
159
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
160
|
+
--description=<value> Description of the data library (max 255 characters).
|
|
161
|
+
--developer-name=<value> (required) API name for the data library (max 80 characters, alphanumeric and
|
|
162
|
+
underscores only, must start with a letter).
|
|
163
|
+
--index-mode=<option> Index mode for SFDRIVE libraries: basic or enhanced.
|
|
164
|
+
<options: basic|enhanced>
|
|
165
|
+
--primary-index-field1=<value> Primary index field 1 for KNOWLEDGE libraries (required, immutable after
|
|
166
|
+
creation).
|
|
167
|
+
--primary-index-field2=<value> Primary index field 2 for KNOWLEDGE libraries (required, immutable after
|
|
168
|
+
creation).
|
|
169
|
+
--retriever-id=<value> ID of an active Custom Retriever (required for RETRIEVER source type; retriever
|
|
170
|
+
must be active).
|
|
171
|
+
--source-type=<option> (required) Type of grounding source: sfdrive (file upload), knowledge (Salesforce
|
|
172
|
+
Knowledge articles), or retriever (existing active Custom Retriever).
|
|
173
|
+
<options: sfdrive|knowledge|retriever>
|
|
174
|
+
|
|
175
|
+
GLOBAL FLAGS
|
|
176
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
177
|
+
--json Format output as json.
|
|
178
|
+
|
|
179
|
+
DESCRIPTION
|
|
180
|
+
Create an Agentforce Data Library.
|
|
181
|
+
|
|
182
|
+
Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file
|
|
183
|
+
upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).
|
|
184
|
+
|
|
185
|
+
EXAMPLES
|
|
186
|
+
Create an SFDRIVE library:
|
|
187
|
+
|
|
188
|
+
$ sf agent adl create --target-org myOrg --name "My Docs" --developer-name My_Docs --source-type sfdrive
|
|
189
|
+
|
|
190
|
+
Create a KNOWLEDGE library with index fields:
|
|
191
|
+
|
|
192
|
+
$ sf agent adl create --target-org myOrg --name "KB Library" --developer-name KB_Library --source-type knowledge \
|
|
193
|
+
--primary-index-field1 Title --primary-index-field2 Summary
|
|
194
|
+
|
|
195
|
+
Create a RETRIEVER library:
|
|
196
|
+
|
|
197
|
+
$ sf agent adl create --target-org myOrg --name "Existing Retriever" --developer-name Existing_Retriever \
|
|
198
|
+
--source-type retriever --retriever-id 0ppXX0000000001
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
_See code: [src/commands/agent/adl/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/create.ts)_
|
|
202
|
+
|
|
203
|
+
## `sf agent adl delete`
|
|
204
|
+
|
|
205
|
+
Delete an Agentforce Data Library.
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
USAGE
|
|
209
|
+
$ sf agent adl delete -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
210
|
+
|
|
211
|
+
FLAGS
|
|
212
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
213
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
214
|
+
configuration variable is already set.
|
|
215
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
216
|
+
|
|
217
|
+
GLOBAL FLAGS
|
|
218
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
219
|
+
--json Format output as json.
|
|
220
|
+
|
|
221
|
+
DESCRIPTION
|
|
222
|
+
Delete an Agentforce Data Library.
|
|
223
|
+
|
|
224
|
+
Permanently deletes a data library and all associated files and indexing data.
|
|
225
|
+
|
|
226
|
+
EXAMPLES
|
|
227
|
+
Delete a data library:
|
|
228
|
+
|
|
229
|
+
$ sf agent adl delete --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
_See code: [src/commands/agent/adl/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/delete.ts)_
|
|
233
|
+
|
|
234
|
+
## `sf agent adl file add`
|
|
235
|
+
|
|
236
|
+
Add files to an existing Agentforce Data Library.
|
|
237
|
+
|
|
238
|
+
```
|
|
239
|
+
USAGE
|
|
240
|
+
$ sf agent adl file add -o <value> -i <value> -f <value>... [--json] [--flags-dir <value>] [--api-version <value>]
|
|
241
|
+
|
|
242
|
+
FLAGS
|
|
243
|
+
-f, --path=<value>... (required) Path to file(s) to add. Specify multiple times for batch upload.
|
|
244
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
245
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
246
|
+
configuration variable is already set.
|
|
247
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
248
|
+
|
|
249
|
+
GLOBAL FLAGS
|
|
250
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
251
|
+
--json Format output as json.
|
|
252
|
+
|
|
253
|
+
DESCRIPTION
|
|
254
|
+
Add files to an existing Agentforce Data Library.
|
|
255
|
+
|
|
256
|
+
Adds one or more files to an existing SFDRIVE data library and triggers SearchIndex re-hydration. This is the day-2
|
|
257
|
+
operation for adding files to an already-provisioned library.
|
|
258
|
+
|
|
259
|
+
Constraints: at least 1 file required, no duplicate file names in a batch, maximum 1000 files per library.
|
|
260
|
+
|
|
261
|
+
EXAMPLES
|
|
262
|
+
Add a file to an existing library:
|
|
263
|
+
|
|
264
|
+
$ sf agent adl file add -i 1JDSG000007IbWX4A0 --path ./docs/new-guide.pdf --target-org myOrg
|
|
265
|
+
|
|
266
|
+
Add multiple files:
|
|
267
|
+
|
|
268
|
+
$ sf agent adl file add -i 1JDSG000007IbWX4A0 --path ./docs/guide.pdf --path ./docs/faq.txt --target-org myOrg
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
_See code: [src/commands/agent/adl/file/add.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/file/add.ts)_
|
|
272
|
+
|
|
273
|
+
## `sf agent adl file delete`
|
|
274
|
+
|
|
275
|
+
Delete a file from an Agentforce Data Library.
|
|
276
|
+
|
|
277
|
+
```
|
|
278
|
+
USAGE
|
|
279
|
+
$ sf agent adl file delete -o <value> -i <value> --file-id <value> [--json] [--flags-dir <value>] [--api-version
|
|
280
|
+
<value>]
|
|
281
|
+
|
|
282
|
+
FLAGS
|
|
283
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
284
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
285
|
+
configuration variable is already set.
|
|
286
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
287
|
+
--file-id=<value> (required) ID of the file to delete (AiGroundingFileRef record ID).
|
|
288
|
+
|
|
289
|
+
GLOBAL FLAGS
|
|
290
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
291
|
+
--json Format output as json.
|
|
292
|
+
|
|
293
|
+
DESCRIPTION
|
|
294
|
+
Delete a file from an Agentforce Data Library.
|
|
295
|
+
|
|
296
|
+
Permanently removes a file from an SFDRIVE data library and triggers re-indexing of the search index.
|
|
297
|
+
|
|
298
|
+
EXAMPLES
|
|
299
|
+
Delete a file from a data library:
|
|
300
|
+
|
|
301
|
+
$ sf agent adl file delete --library-id 1JDSG000007IbWX4A0 --file-id a1B2C3D4E5F6G7H8I9 --target-org myOrg
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
_See code: [src/commands/agent/adl/file/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/file/delete.ts)_
|
|
305
|
+
|
|
306
|
+
## `sf agent adl file list`
|
|
307
|
+
|
|
308
|
+
List files in an Agentforce Data Library.
|
|
309
|
+
|
|
310
|
+
```
|
|
311
|
+
USAGE
|
|
312
|
+
$ sf agent adl file list -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
313
|
+
|
|
314
|
+
FLAGS
|
|
315
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
316
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
317
|
+
configuration variable is already set.
|
|
318
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
319
|
+
|
|
320
|
+
GLOBAL FLAGS
|
|
321
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
322
|
+
--json Format output as json.
|
|
323
|
+
|
|
324
|
+
DESCRIPTION
|
|
325
|
+
List files in an Agentforce Data Library.
|
|
326
|
+
|
|
327
|
+
Returns the list of files in an SFDRIVE library including file name, size, and creation date.
|
|
328
|
+
|
|
329
|
+
EXAMPLES
|
|
330
|
+
List files in a data library:
|
|
331
|
+
|
|
332
|
+
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
333
|
+
|
|
334
|
+
List files and output as JSON:
|
|
335
|
+
|
|
336
|
+
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg --json
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
_See code: [src/commands/agent/adl/file/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/file/list.ts)_
|
|
340
|
+
|
|
341
|
+
## `sf agent adl get`
|
|
342
|
+
|
|
343
|
+
Get details of an Agentforce Data Library.
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
USAGE
|
|
347
|
+
$ sf agent adl get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
348
|
+
|
|
349
|
+
FLAGS
|
|
350
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
351
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
352
|
+
configuration variable is already set.
|
|
353
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
354
|
+
|
|
355
|
+
GLOBAL FLAGS
|
|
356
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
357
|
+
--json Format output as json.
|
|
358
|
+
|
|
359
|
+
DESCRIPTION
|
|
360
|
+
Get details of an Agentforce Data Library.
|
|
361
|
+
|
|
362
|
+
Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.
|
|
363
|
+
|
|
364
|
+
EXAMPLES
|
|
365
|
+
Get details of a data library:
|
|
366
|
+
|
|
367
|
+
$ sf agent adl get --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
368
|
+
```
|
|
369
|
+
|
|
370
|
+
_See code: [src/commands/agent/adl/get.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/get.ts)_
|
|
371
|
+
|
|
372
|
+
## `sf agent adl list`
|
|
373
|
+
|
|
374
|
+
List Agentforce Data Libraries in an org.
|
|
375
|
+
|
|
376
|
+
```
|
|
377
|
+
USAGE
|
|
378
|
+
$ sf agent adl list -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--source-type
|
|
379
|
+
sfdrive|knowledge|retriever]
|
|
380
|
+
|
|
381
|
+
FLAGS
|
|
382
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
383
|
+
configuration variable is already set.
|
|
384
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
385
|
+
--source-type=<option> Filter by source type: sfdrive, knowledge, or retriever.
|
|
386
|
+
<options: sfdrive|knowledge|retriever>
|
|
387
|
+
|
|
388
|
+
GLOBAL FLAGS
|
|
389
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
390
|
+
--json Format output as json.
|
|
391
|
+
|
|
392
|
+
DESCRIPTION
|
|
393
|
+
List Agentforce Data Libraries in an org.
|
|
394
|
+
|
|
395
|
+
Returns all data libraries in the target org, including their source type, status, and library ID.
|
|
396
|
+
|
|
397
|
+
EXAMPLES
|
|
398
|
+
List all data libraries in the default target org:
|
|
399
|
+
|
|
400
|
+
$ sf agent adl list --target-org myOrg
|
|
401
|
+
|
|
402
|
+
List data libraries and output as JSON:
|
|
403
|
+
|
|
404
|
+
$ sf agent adl list --target-org myOrg --json
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
_See code: [src/commands/agent/adl/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/list.ts)_
|
|
408
|
+
|
|
409
|
+
## `sf agent adl status`
|
|
410
|
+
|
|
411
|
+
Get indexing status of an Agentforce Data Library.
|
|
412
|
+
|
|
413
|
+
```
|
|
414
|
+
USAGE
|
|
415
|
+
$ sf agent adl status -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
416
|
+
|
|
417
|
+
FLAGS
|
|
418
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
419
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
420
|
+
configuration variable is already set.
|
|
421
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
422
|
+
|
|
423
|
+
GLOBAL FLAGS
|
|
424
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
425
|
+
--json Format output as json.
|
|
426
|
+
|
|
427
|
+
DESCRIPTION
|
|
428
|
+
Get indexing status of an Agentforce Data Library.
|
|
429
|
+
|
|
430
|
+
Returns the current indexing status including stage details (DATA_LAKE_OBJECT, SEARCH_INDEX, RETRIEVER) and any
|
|
431
|
+
errors.
|
|
432
|
+
|
|
433
|
+
EXAMPLES
|
|
434
|
+
Get status of a data library:
|
|
435
|
+
|
|
436
|
+
$ sf agent adl status --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
_See code: [src/commands/agent/adl/status.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/status.ts)_
|
|
440
|
+
|
|
441
|
+
## `sf agent adl update`
|
|
442
|
+
|
|
443
|
+
Update an Agentforce Data Library.
|
|
444
|
+
|
|
445
|
+
```
|
|
446
|
+
USAGE
|
|
447
|
+
$ sf agent adl update -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
448
|
+
[--description <value>] [--content-fields <value>] [--restrict-to-public-articles] [--retriever-id <value>]
|
|
449
|
+
|
|
450
|
+
FLAGS
|
|
451
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
452
|
+
-n, --name=<value> New display name for the data library (max 80 characters).
|
|
453
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the
|
|
454
|
+
`target-org` configuration variable is already set.
|
|
455
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
456
|
+
--content-fields=<value> Comma-separated list of content fields for KNOWLEDGE libraries (triggers
|
|
457
|
+
re-indexing).
|
|
458
|
+
--description=<value> New description for the data library (max 255 characters).
|
|
459
|
+
--[no-]restrict-to-public-articles Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers
|
|
460
|
+
re-indexing).
|
|
461
|
+
--retriever-id=<value> Swap the retriever for a RETRIEVER library (must be an active Custom Retriever
|
|
462
|
+
ID).
|
|
463
|
+
|
|
464
|
+
GLOBAL FLAGS
|
|
465
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
466
|
+
--json Format output as json.
|
|
467
|
+
|
|
468
|
+
DESCRIPTION
|
|
469
|
+
Update an Agentforce Data Library.
|
|
470
|
+
|
|
471
|
+
Updates the label, description, or other mutable properties of an existing data library.
|
|
472
|
+
|
|
473
|
+
EXAMPLES
|
|
474
|
+
Update the label of a data library:
|
|
475
|
+
|
|
476
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --name "New Name" --target-org myOrg
|
|
477
|
+
|
|
478
|
+
Update the description:
|
|
479
|
+
|
|
480
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --description "Updated description" --target-org myOrg
|
|
481
|
+
|
|
482
|
+
Update Knowledge library content fields (triggers re-indexing):
|
|
483
|
+
|
|
484
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --content-fields "Answer**c,Summary**c" --target-org myOrg
|
|
485
|
+
|
|
486
|
+
Restrict Knowledge library to public articles:
|
|
487
|
+
|
|
488
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
_See code: [src/commands/agent/adl/update.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/update.ts)_
|
|
492
|
+
|
|
493
|
+
## `sf agent adl upload`
|
|
494
|
+
|
|
495
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
496
|
+
|
|
497
|
+
```
|
|
498
|
+
USAGE
|
|
499
|
+
$ sf agent adl upload -o <value> -i <value> -f <value>... [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
500
|
+
<value>]
|
|
501
|
+
|
|
502
|
+
FLAGS
|
|
503
|
+
-f, --file=<value>... (required) Path to the file to upload.
|
|
504
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
505
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
506
|
+
configuration variable is already set.
|
|
507
|
+
-w, --wait=<value> Number of minutes to wait for indexing to complete. If not specified, returns after
|
|
508
|
+
triggering indexing.
|
|
509
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
510
|
+
|
|
511
|
+
GLOBAL FLAGS
|
|
512
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
513
|
+
--json Format output as json.
|
|
514
|
+
|
|
515
|
+
DESCRIPTION
|
|
516
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
517
|
+
|
|
518
|
+
Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file,
|
|
519
|
+
triggers indexing, and optionally polls until the library is ready (retrieverId is populated).
|
|
520
|
+
|
|
521
|
+
This command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER
|
|
522
|
+
libraries require no file upload.
|
|
523
|
+
|
|
524
|
+
EXAMPLES
|
|
525
|
+
Upload a file and wait for indexing to complete:
|
|
526
|
+
|
|
527
|
+
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10
|
|
528
|
+
|
|
529
|
+
Upload a file without waiting:
|
|
530
|
+
|
|
531
|
+
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
_See code: [src/commands/agent/adl/upload.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/adl/upload.ts)_
|
|
134
535
|
|
|
135
536
|
## `sf agent create`
|
|
136
537
|
|
|
@@ -197,7 +598,7 @@ EXAMPLES
|
|
|
197
598
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
198
599
|
```
|
|
199
600
|
|
|
200
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
601
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/create.ts)_
|
|
201
602
|
|
|
202
603
|
## `sf agent deactivate`
|
|
203
604
|
|
|
@@ -238,7 +639,7 @@ EXAMPLES
|
|
|
238
639
|
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
|
|
239
640
|
```
|
|
240
641
|
|
|
241
|
-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
642
|
+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/deactivate.ts)_
|
|
242
643
|
|
|
243
644
|
## `sf agent generate agent-spec`
|
|
244
645
|
|
|
@@ -345,7 +746,7 @@ EXAMPLES
|
|
|
345
746
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
346
747
|
```
|
|
347
748
|
|
|
348
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
749
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/generate/agent-spec.ts)_
|
|
349
750
|
|
|
350
751
|
## `sf agent generate authoring-bundle`
|
|
351
752
|
|
|
@@ -422,7 +823,7 @@ EXAMPLES
|
|
|
422
823
|
other-package-dir/main/default --target-org my-dev-org
|
|
423
824
|
```
|
|
424
825
|
|
|
425
|
-
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
826
|
+
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/generate/authoring-bundle.ts)_
|
|
426
827
|
|
|
427
828
|
## `sf agent generate template`
|
|
428
829
|
|
|
@@ -484,7 +885,7 @@ EXAMPLES
|
|
|
484
885
|
my-package --source-org my-scratch-org
|
|
485
886
|
```
|
|
486
887
|
|
|
487
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
888
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/generate/template.ts)_
|
|
488
889
|
|
|
489
890
|
## `sf agent generate test-spec`
|
|
490
891
|
|
|
@@ -549,7 +950,7 @@ EXAMPLES
|
|
|
549
950
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
550
951
|
```
|
|
551
952
|
|
|
552
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
953
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/generate/test-spec.ts)_
|
|
553
954
|
|
|
554
955
|
## `sf agent preview`
|
|
555
956
|
|
|
@@ -622,7 +1023,7 @@ EXAMPLES
|
|
|
622
1023
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
623
1024
|
```
|
|
624
1025
|
|
|
625
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1026
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/preview.ts)_
|
|
626
1027
|
|
|
627
1028
|
## `sf agent preview end`
|
|
628
1029
|
|
|
@@ -694,7 +1095,7 @@ EXAMPLES
|
|
|
694
1095
|
$ sf agent preview end --all --target-org <target_org>
|
|
695
1096
|
```
|
|
696
1097
|
|
|
697
|
-
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1098
|
+
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/preview/end.ts)_
|
|
698
1099
|
|
|
699
1100
|
## `sf agent preview send`
|
|
700
1101
|
|
|
@@ -752,7 +1153,7 @@ EXAMPLES
|
|
|
752
1153
|
$ sf agent preview send --utterance "what can you help me with?" --authoring-bundle My_Local_Agent
|
|
753
1154
|
```
|
|
754
1155
|
|
|
755
|
-
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1156
|
+
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/preview/send.ts)_
|
|
756
1157
|
|
|
757
1158
|
## `sf agent preview sessions`
|
|
758
1159
|
|
|
@@ -785,7 +1186,7 @@ EXAMPLES
|
|
|
785
1186
|
$ sf agent preview sessions
|
|
786
1187
|
```
|
|
787
1188
|
|
|
788
|
-
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1189
|
+
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/preview/sessions.ts)_
|
|
789
1190
|
|
|
790
1191
|
## `sf agent preview start`
|
|
791
1192
|
|
|
@@ -850,7 +1251,7 @@ EXAMPLES
|
|
|
850
1251
|
$ sf agent preview start --api-name My_Published_Agent
|
|
851
1252
|
```
|
|
852
1253
|
|
|
853
|
-
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1254
|
+
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/preview/start.ts)_
|
|
854
1255
|
|
|
855
1256
|
## `sf agent publish authoring-bundle`
|
|
856
1257
|
|
|
@@ -910,7 +1311,7 @@ EXAMPLES
|
|
|
910
1311
|
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --concise
|
|
911
1312
|
```
|
|
912
1313
|
|
|
913
|
-
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1314
|
+
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/publish/authoring-bundle.ts)_
|
|
914
1315
|
|
|
915
1316
|
## `sf agent test create`
|
|
916
1317
|
|
|
@@ -982,7 +1383,7 @@ FLAG DESCRIPTIONS
|
|
|
982
1383
|
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
983
1384
|
```
|
|
984
1385
|
|
|
985
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1386
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/test/create.ts)_
|
|
986
1387
|
|
|
987
1388
|
## `sf agent test list`
|
|
988
1389
|
|
|
@@ -1017,7 +1418,7 @@ EXAMPLES
|
|
|
1017
1418
|
$ sf agent test list --target-org my-org
|
|
1018
1419
|
```
|
|
1019
1420
|
|
|
1020
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1421
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/test/list.ts)_
|
|
1021
1422
|
|
|
1022
1423
|
## `sf agent test results`
|
|
1023
1424
|
|
|
@@ -1093,7 +1494,7 @@ FLAG DESCRIPTIONS
|
|
|
1093
1494
|
expression when using custom evaluations.
|
|
1094
1495
|
```
|
|
1095
1496
|
|
|
1096
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1497
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/test/results.ts)_
|
|
1097
1498
|
|
|
1098
1499
|
## `sf agent test resume`
|
|
1099
1500
|
|
|
@@ -1177,7 +1578,7 @@ FLAG DESCRIPTIONS
|
|
|
1177
1578
|
expression when using custom evaluations.
|
|
1178
1579
|
```
|
|
1179
1580
|
|
|
1180
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1581
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/test/resume.ts)_
|
|
1181
1582
|
|
|
1182
1583
|
## `sf agent test run`
|
|
1183
1584
|
|
|
@@ -1261,7 +1662,7 @@ FLAG DESCRIPTIONS
|
|
|
1261
1662
|
expression when using custom evaluations.
|
|
1262
1663
|
```
|
|
1263
1664
|
|
|
1264
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1665
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/test/run.ts)_
|
|
1265
1666
|
|
|
1266
1667
|
## `sf agent test run-eval`
|
|
1267
1668
|
|
|
@@ -1337,7 +1738,7 @@ EXAMPLES
|
|
|
1337
1738
|
$ echo '{"tests":[...]}' | sf agent test run-eval --spec --target-org my-org
|
|
1338
1739
|
```
|
|
1339
1740
|
|
|
1340
|
-
_See code: [src/commands/agent/test/run-eval.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1741
|
+
_See code: [src/commands/agent/test/run-eval.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/test/run-eval.ts)_
|
|
1341
1742
|
|
|
1342
1743
|
## `sf agent trace delete`
|
|
1343
1744
|
|
|
@@ -1401,7 +1802,7 @@ EXAMPLES
|
|
|
1401
1802
|
$ sf agent trace delete --no-prompt
|
|
1402
1803
|
```
|
|
1403
1804
|
|
|
1404
|
-
_See code: [src/commands/agent/trace/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1805
|
+
_See code: [src/commands/agent/trace/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/trace/delete.ts)_
|
|
1405
1806
|
|
|
1406
1807
|
## `sf agent trace list`
|
|
1407
1808
|
|
|
@@ -1471,7 +1872,7 @@ FLAG DESCRIPTIONS
|
|
|
1471
1872
|
(2026-04-20T14:00:00.000Z). The "Recorded At" values shown in the table output are valid inputs.
|
|
1472
1873
|
```
|
|
1473
1874
|
|
|
1474
|
-
_See code: [src/commands/agent/trace/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1875
|
+
_See code: [src/commands/agent/trace/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/trace/list.ts)_
|
|
1475
1876
|
|
|
1476
1877
|
## `sf agent trace read`
|
|
1477
1878
|
|
|
@@ -1559,7 +1960,7 @@ EXAMPLES
|
|
|
1559
1960
|
$ sf agent trace read --session-id <SESSION_ID> --json
|
|
1560
1961
|
```
|
|
1561
1962
|
|
|
1562
|
-
_See code: [src/commands/agent/trace/read.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1963
|
+
_See code: [src/commands/agent/trace/read.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/trace/read.ts)_
|
|
1563
1964
|
|
|
1564
1965
|
## `sf agent validate authoring-bundle`
|
|
1565
1966
|
|
|
@@ -1606,6 +2007,6 @@ EXAMPLES
|
|
|
1606
2007
|
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
|
|
1607
2008
|
```
|
|
1608
2009
|
|
|
1609
|
-
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
2010
|
+
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.1/src/commands/agent/validate/authoring-bundle.ts)_
|
|
1610
2011
|
|
|
1611
2012
|
<!-- commandsstop -->
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { SfCommand } from '@salesforce/sf-plugins-core';
|
|
2
|
+
import { type DataLibraryDetail } from '@salesforce/agents';
|
|
3
|
+
export type AgentAdlCreateResult = DataLibraryDetail;
|
|
4
|
+
export default class AgentAdlCreate extends SfCommand<AgentAdlCreateResult> {
|
|
5
|
+
static readonly summary: string;
|
|
6
|
+
static readonly description: string;
|
|
7
|
+
static readonly examples: string[];
|
|
8
|
+
static readonly enableJsonFlag = true;
|
|
9
|
+
static readonly state = "preview";
|
|
10
|
+
static readonly flags: {
|
|
11
|
+
'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
|
+
'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
13
|
+
name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
14
|
+
'developer-name': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
15
|
+
'source-type': import("@oclif/core/interfaces").OptionFlag<"sfdrive" | "knowledge" | "retriever", import("@oclif/core/interfaces").CustomOptions>;
|
|
16
|
+
description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
17
|
+
'index-mode': import("@oclif/core/interfaces").OptionFlag<"basic" | "enhanced" | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
18
|
+
'retriever-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
19
|
+
'primary-index-field1': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
20
|
+
'primary-index-field2': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
21
|
+
};
|
|
22
|
+
run(): Promise<AgentAdlCreateResult>;
|
|
23
|
+
}
|