@salesforce/plugin-agent 1.41.0 → 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 +415 -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 +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/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/oclif.manifest.json +2069 -1111
- 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 +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
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,389 @@ 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.0/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.0/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.0/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, --file=<value> (required) Path to the file to add to the library.
|
|
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 --library-id 1JDSG000007IbWX4A0 --file ./docs/new-guide.pdf --target-org myOrg
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
_See code: [src/commands/agent/adl/file/add.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/file/add.ts)_
|
|
268
|
+
|
|
269
|
+
## `sf agent adl file delete`
|
|
270
|
+
|
|
271
|
+
Delete a file from an Agentforce Data Library.
|
|
272
|
+
|
|
273
|
+
```
|
|
274
|
+
USAGE
|
|
275
|
+
$ sf agent adl file delete -o <value> -i <value> --file-id <value> [--json] [--flags-dir <value>] [--api-version
|
|
276
|
+
<value>]
|
|
277
|
+
|
|
278
|
+
FLAGS
|
|
279
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
280
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
281
|
+
configuration variable is already set.
|
|
282
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
283
|
+
--file-id=<value> (required) ID of the file to delete (AiGroundingFileRef record ID).
|
|
284
|
+
|
|
285
|
+
GLOBAL FLAGS
|
|
286
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
287
|
+
--json Format output as json.
|
|
288
|
+
|
|
289
|
+
DESCRIPTION
|
|
290
|
+
Delete a file from an Agentforce Data Library.
|
|
291
|
+
|
|
292
|
+
Permanently removes a file from an SFDRIVE data library and triggers re-indexing of the search index.
|
|
293
|
+
|
|
294
|
+
EXAMPLES
|
|
295
|
+
Delete a file from a data library:
|
|
296
|
+
|
|
297
|
+
$ sf agent adl file delete --library-id 1JDSG000007IbWX4A0 --file-id a1B2C3D4E5F6G7H8I9 --target-org myOrg
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
_See code: [src/commands/agent/adl/file/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/file/delete.ts)_
|
|
301
|
+
|
|
302
|
+
## `sf agent adl file list`
|
|
303
|
+
|
|
304
|
+
List files in an Agentforce Data Library.
|
|
305
|
+
|
|
306
|
+
```
|
|
307
|
+
USAGE
|
|
308
|
+
$ sf agent adl file list -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
309
|
+
|
|
310
|
+
FLAGS
|
|
311
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
312
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
313
|
+
configuration variable is already set.
|
|
314
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
315
|
+
|
|
316
|
+
GLOBAL FLAGS
|
|
317
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
318
|
+
--json Format output as json.
|
|
319
|
+
|
|
320
|
+
DESCRIPTION
|
|
321
|
+
List files in an Agentforce Data Library.
|
|
322
|
+
|
|
323
|
+
Returns the list of files in an SFDRIVE library including file name, size, and creation date.
|
|
324
|
+
|
|
325
|
+
EXAMPLES
|
|
326
|
+
List files in a data library:
|
|
327
|
+
|
|
328
|
+
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
329
|
+
|
|
330
|
+
List files and output as JSON:
|
|
331
|
+
|
|
332
|
+
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg --json
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
_See code: [src/commands/agent/adl/file/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/file/list.ts)_
|
|
336
|
+
|
|
337
|
+
## `sf agent adl get`
|
|
338
|
+
|
|
339
|
+
Get details of an Agentforce Data Library.
|
|
340
|
+
|
|
341
|
+
```
|
|
342
|
+
USAGE
|
|
343
|
+
$ sf agent adl get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
344
|
+
|
|
345
|
+
FLAGS
|
|
346
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
347
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
348
|
+
configuration variable is already set.
|
|
349
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
350
|
+
|
|
351
|
+
GLOBAL FLAGS
|
|
352
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
353
|
+
--json Format output as json.
|
|
354
|
+
|
|
355
|
+
DESCRIPTION
|
|
356
|
+
Get details of an Agentforce Data Library.
|
|
357
|
+
|
|
358
|
+
Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.
|
|
359
|
+
|
|
360
|
+
EXAMPLES
|
|
361
|
+
Get details of a data library:
|
|
362
|
+
|
|
363
|
+
$ sf agent adl get --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
_See code: [src/commands/agent/adl/get.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/get.ts)_
|
|
367
|
+
|
|
368
|
+
## `sf agent adl list`
|
|
369
|
+
|
|
370
|
+
List Agentforce Data Libraries in an org.
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
USAGE
|
|
374
|
+
$ sf agent adl list -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
375
|
+
|
|
376
|
+
FLAGS
|
|
377
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
378
|
+
configuration variable is already set.
|
|
379
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
380
|
+
|
|
381
|
+
GLOBAL FLAGS
|
|
382
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
383
|
+
--json Format output as json.
|
|
384
|
+
|
|
385
|
+
DESCRIPTION
|
|
386
|
+
List Agentforce Data Libraries in an org.
|
|
387
|
+
|
|
388
|
+
Returns all data libraries in the target org, including their source type, status, and library ID.
|
|
389
|
+
|
|
390
|
+
EXAMPLES
|
|
391
|
+
List all data libraries in the default target org:
|
|
392
|
+
|
|
393
|
+
$ sf agent adl list --target-org myOrg
|
|
394
|
+
|
|
395
|
+
List data libraries and output as JSON:
|
|
396
|
+
|
|
397
|
+
$ sf agent adl list --target-org myOrg --json
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
_See code: [src/commands/agent/adl/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/list.ts)_
|
|
401
|
+
|
|
402
|
+
## `sf agent adl status`
|
|
403
|
+
|
|
404
|
+
Get indexing status of an Agentforce Data Library.
|
|
405
|
+
|
|
406
|
+
```
|
|
407
|
+
USAGE
|
|
408
|
+
$ sf agent adl status -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
409
|
+
|
|
410
|
+
FLAGS
|
|
411
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
412
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
413
|
+
configuration variable is already set.
|
|
414
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
415
|
+
|
|
416
|
+
GLOBAL FLAGS
|
|
417
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
418
|
+
--json Format output as json.
|
|
419
|
+
|
|
420
|
+
DESCRIPTION
|
|
421
|
+
Get indexing status of an Agentforce Data Library.
|
|
422
|
+
|
|
423
|
+
Returns the current indexing status including stage details (DATA_LAKE_OBJECT, SEARCH_INDEX, RETRIEVER) and any
|
|
424
|
+
errors.
|
|
425
|
+
|
|
426
|
+
EXAMPLES
|
|
427
|
+
Get status of a data library:
|
|
428
|
+
|
|
429
|
+
$ sf agent adl status --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
_See code: [src/commands/agent/adl/status.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/status.ts)_
|
|
433
|
+
|
|
434
|
+
## `sf agent adl update`
|
|
435
|
+
|
|
436
|
+
Update an Agentforce Data Library.
|
|
437
|
+
|
|
438
|
+
```
|
|
439
|
+
USAGE
|
|
440
|
+
$ sf agent adl update -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
441
|
+
[--description <value>] [--content-fields <value>] [--restrict-to-public-articles]
|
|
442
|
+
|
|
443
|
+
FLAGS
|
|
444
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
445
|
+
-n, --name=<value> New display name for the data library (max 80 characters).
|
|
446
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the
|
|
447
|
+
`target-org` configuration variable is already set.
|
|
448
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
449
|
+
--content-fields=<value> Comma-separated list of content fields for KNOWLEDGE libraries (triggers
|
|
450
|
+
re-indexing).
|
|
451
|
+
--description=<value> New description for the data library (max 255 characters).
|
|
452
|
+
--[no-]restrict-to-public-articles Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers
|
|
453
|
+
re-indexing).
|
|
454
|
+
|
|
455
|
+
GLOBAL FLAGS
|
|
456
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
457
|
+
--json Format output as json.
|
|
458
|
+
|
|
459
|
+
DESCRIPTION
|
|
460
|
+
Update an Agentforce Data Library.
|
|
461
|
+
|
|
462
|
+
Updates the label, description, or other mutable properties of an existing data library.
|
|
463
|
+
|
|
464
|
+
EXAMPLES
|
|
465
|
+
Update the label of a data library:
|
|
466
|
+
|
|
467
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --name "New Name" --target-org myOrg
|
|
468
|
+
|
|
469
|
+
Update the description:
|
|
470
|
+
|
|
471
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --description "Updated description" --target-org myOrg
|
|
472
|
+
|
|
473
|
+
Update Knowledge library content fields (triggers re-indexing):
|
|
474
|
+
|
|
475
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --content-fields "Answer**c,Summary**c" --target-org myOrg
|
|
476
|
+
|
|
477
|
+
Restrict Knowledge library to public articles:
|
|
478
|
+
|
|
479
|
+
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
_See code: [src/commands/agent/adl/update.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/update.ts)_
|
|
483
|
+
|
|
484
|
+
## `sf agent adl upload`
|
|
485
|
+
|
|
486
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
487
|
+
|
|
488
|
+
```
|
|
489
|
+
USAGE
|
|
490
|
+
$ sf agent adl upload -o <value> -i <value> -f <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w
|
|
491
|
+
<value>]
|
|
492
|
+
|
|
493
|
+
FLAGS
|
|
494
|
+
-f, --file=<value> (required) Path to the file to upload.
|
|
495
|
+
-i, --library-id=<value> (required) Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
|
|
496
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
497
|
+
configuration variable is already set.
|
|
498
|
+
-w, --wait=<value> Number of minutes to wait for indexing to complete. If not specified, returns after
|
|
499
|
+
triggering indexing.
|
|
500
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
501
|
+
|
|
502
|
+
GLOBAL FLAGS
|
|
503
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
504
|
+
--json Format output as json.
|
|
505
|
+
|
|
506
|
+
DESCRIPTION
|
|
507
|
+
Upload a file to an SFDRIVE Agentforce Data Library.
|
|
508
|
+
|
|
509
|
+
Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file,
|
|
510
|
+
triggers indexing, and optionally polls until the library is ready (retrieverId is populated).
|
|
511
|
+
|
|
512
|
+
This command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER
|
|
513
|
+
libraries require no file upload.
|
|
514
|
+
|
|
515
|
+
EXAMPLES
|
|
516
|
+
Upload a file and wait for indexing to complete:
|
|
517
|
+
|
|
518
|
+
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10
|
|
519
|
+
|
|
520
|
+
Upload a file without waiting:
|
|
521
|
+
|
|
522
|
+
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
_See code: [src/commands/agent/adl/upload.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/adl/upload.ts)_
|
|
134
526
|
|
|
135
527
|
## `sf agent create`
|
|
136
528
|
|
|
@@ -197,7 +589,7 @@ EXAMPLES
|
|
|
197
589
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
198
590
|
```
|
|
199
591
|
|
|
200
|
-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
592
|
+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/create.ts)_
|
|
201
593
|
|
|
202
594
|
## `sf agent deactivate`
|
|
203
595
|
|
|
@@ -238,7 +630,7 @@ EXAMPLES
|
|
|
238
630
|
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
|
|
239
631
|
```
|
|
240
632
|
|
|
241
|
-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
633
|
+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/deactivate.ts)_
|
|
242
634
|
|
|
243
635
|
## `sf agent generate agent-spec`
|
|
244
636
|
|
|
@@ -345,7 +737,7 @@ EXAMPLES
|
|
|
345
737
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
346
738
|
```
|
|
347
739
|
|
|
348
|
-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
740
|
+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/agent-spec.ts)_
|
|
349
741
|
|
|
350
742
|
## `sf agent generate authoring-bundle`
|
|
351
743
|
|
|
@@ -422,7 +814,7 @@ EXAMPLES
|
|
|
422
814
|
other-package-dir/main/default --target-org my-dev-org
|
|
423
815
|
```
|
|
424
816
|
|
|
425
|
-
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
817
|
+
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/authoring-bundle.ts)_
|
|
426
818
|
|
|
427
819
|
## `sf agent generate template`
|
|
428
820
|
|
|
@@ -484,7 +876,7 @@ EXAMPLES
|
|
|
484
876
|
my-package --source-org my-scratch-org
|
|
485
877
|
```
|
|
486
878
|
|
|
487
|
-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
879
|
+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/template.ts)_
|
|
488
880
|
|
|
489
881
|
## `sf agent generate test-spec`
|
|
490
882
|
|
|
@@ -549,7 +941,7 @@ EXAMPLES
|
|
|
549
941
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
550
942
|
```
|
|
551
943
|
|
|
552
|
-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
944
|
+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/generate/test-spec.ts)_
|
|
553
945
|
|
|
554
946
|
## `sf agent preview`
|
|
555
947
|
|
|
@@ -622,7 +1014,7 @@ EXAMPLES
|
|
|
622
1014
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
623
1015
|
```
|
|
624
1016
|
|
|
625
|
-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1017
|
+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview.ts)_
|
|
626
1018
|
|
|
627
1019
|
## `sf agent preview end`
|
|
628
1020
|
|
|
@@ -694,7 +1086,7 @@ EXAMPLES
|
|
|
694
1086
|
$ sf agent preview end --all --target-org <target_org>
|
|
695
1087
|
```
|
|
696
1088
|
|
|
697
|
-
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1089
|
+
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/end.ts)_
|
|
698
1090
|
|
|
699
1091
|
## `sf agent preview send`
|
|
700
1092
|
|
|
@@ -752,7 +1144,7 @@ EXAMPLES
|
|
|
752
1144
|
$ sf agent preview send --utterance "what can you help me with?" --authoring-bundle My_Local_Agent
|
|
753
1145
|
```
|
|
754
1146
|
|
|
755
|
-
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1147
|
+
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/send.ts)_
|
|
756
1148
|
|
|
757
1149
|
## `sf agent preview sessions`
|
|
758
1150
|
|
|
@@ -785,7 +1177,7 @@ EXAMPLES
|
|
|
785
1177
|
$ sf agent preview sessions
|
|
786
1178
|
```
|
|
787
1179
|
|
|
788
|
-
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1180
|
+
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/sessions.ts)_
|
|
789
1181
|
|
|
790
1182
|
## `sf agent preview start`
|
|
791
1183
|
|
|
@@ -850,7 +1242,7 @@ EXAMPLES
|
|
|
850
1242
|
$ sf agent preview start --api-name My_Published_Agent
|
|
851
1243
|
```
|
|
852
1244
|
|
|
853
|
-
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1245
|
+
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/preview/start.ts)_
|
|
854
1246
|
|
|
855
1247
|
## `sf agent publish authoring-bundle`
|
|
856
1248
|
|
|
@@ -910,7 +1302,7 @@ EXAMPLES
|
|
|
910
1302
|
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --concise
|
|
911
1303
|
```
|
|
912
1304
|
|
|
913
|
-
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1305
|
+
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/publish/authoring-bundle.ts)_
|
|
914
1306
|
|
|
915
1307
|
## `sf agent test create`
|
|
916
1308
|
|
|
@@ -982,7 +1374,7 @@ FLAG DESCRIPTIONS
|
|
|
982
1374
|
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
983
1375
|
```
|
|
984
1376
|
|
|
985
|
-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1377
|
+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/create.ts)_
|
|
986
1378
|
|
|
987
1379
|
## `sf agent test list`
|
|
988
1380
|
|
|
@@ -1017,7 +1409,7 @@ EXAMPLES
|
|
|
1017
1409
|
$ sf agent test list --target-org my-org
|
|
1018
1410
|
```
|
|
1019
1411
|
|
|
1020
|
-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1412
|
+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/list.ts)_
|
|
1021
1413
|
|
|
1022
1414
|
## `sf agent test results`
|
|
1023
1415
|
|
|
@@ -1093,7 +1485,7 @@ FLAG DESCRIPTIONS
|
|
|
1093
1485
|
expression when using custom evaluations.
|
|
1094
1486
|
```
|
|
1095
1487
|
|
|
1096
|
-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1488
|
+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/results.ts)_
|
|
1097
1489
|
|
|
1098
1490
|
## `sf agent test resume`
|
|
1099
1491
|
|
|
@@ -1177,7 +1569,7 @@ FLAG DESCRIPTIONS
|
|
|
1177
1569
|
expression when using custom evaluations.
|
|
1178
1570
|
```
|
|
1179
1571
|
|
|
1180
|
-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1572
|
+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/resume.ts)_
|
|
1181
1573
|
|
|
1182
1574
|
## `sf agent test run`
|
|
1183
1575
|
|
|
@@ -1261,7 +1653,7 @@ FLAG DESCRIPTIONS
|
|
|
1261
1653
|
expression when using custom evaluations.
|
|
1262
1654
|
```
|
|
1263
1655
|
|
|
1264
|
-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1656
|
+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/run.ts)_
|
|
1265
1657
|
|
|
1266
1658
|
## `sf agent test run-eval`
|
|
1267
1659
|
|
|
@@ -1337,7 +1729,7 @@ EXAMPLES
|
|
|
1337
1729
|
$ echo '{"tests":[...]}' | sf agent test run-eval --spec --target-org my-org
|
|
1338
1730
|
```
|
|
1339
1731
|
|
|
1340
|
-
_See code: [src/commands/agent/test/run-eval.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1732
|
+
_See code: [src/commands/agent/test/run-eval.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/test/run-eval.ts)_
|
|
1341
1733
|
|
|
1342
1734
|
## `sf agent trace delete`
|
|
1343
1735
|
|
|
@@ -1401,7 +1793,7 @@ EXAMPLES
|
|
|
1401
1793
|
$ sf agent trace delete --no-prompt
|
|
1402
1794
|
```
|
|
1403
1795
|
|
|
1404
|
-
_See code: [src/commands/agent/trace/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1796
|
+
_See code: [src/commands/agent/trace/delete.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/trace/delete.ts)_
|
|
1405
1797
|
|
|
1406
1798
|
## `sf agent trace list`
|
|
1407
1799
|
|
|
@@ -1471,7 +1863,7 @@ FLAG DESCRIPTIONS
|
|
|
1471
1863
|
(2026-04-20T14:00:00.000Z). The "Recorded At" values shown in the table output are valid inputs.
|
|
1472
1864
|
```
|
|
1473
1865
|
|
|
1474
|
-
_See code: [src/commands/agent/trace/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1866
|
+
_See code: [src/commands/agent/trace/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/trace/list.ts)_
|
|
1475
1867
|
|
|
1476
1868
|
## `sf agent trace read`
|
|
1477
1869
|
|
|
@@ -1559,7 +1951,7 @@ EXAMPLES
|
|
|
1559
1951
|
$ sf agent trace read --session-id <SESSION_ID> --json
|
|
1560
1952
|
```
|
|
1561
1953
|
|
|
1562
|
-
_See code: [src/commands/agent/trace/read.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1954
|
+
_See code: [src/commands/agent/trace/read.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/trace/read.ts)_
|
|
1563
1955
|
|
|
1564
1956
|
## `sf agent validate authoring-bundle`
|
|
1565
1957
|
|
|
@@ -1606,6 +1998,6 @@ EXAMPLES
|
|
|
1606
1998
|
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
|
|
1607
1999
|
```
|
|
1608
2000
|
|
|
1609
|
-
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
2001
|
+
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.42.0/src/commands/agent/validate/authoring-bundle.ts)_
|
|
1610
2002
|
|
|
1611
2003
|
<!-- 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
|
+
}
|