@salesforce/plugin-agent 1.27.1 → 1.27.3
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 -15
- package/lib/commands/agent/generate/authoring-bundle.d.ts +0 -1
- package/lib/commands/agent/generate/authoring-bundle.js +0 -1
- package/lib/commands/agent/generate/authoring-bundle.js.map +1 -1
- package/lib/commands/agent/generate/template.js.map +1 -1
- package/lib/commands/agent/preview.d.ts +0 -1
- package/lib/commands/agent/preview.js +0 -1
- package/lib/commands/agent/preview.js.map +1 -1
- package/lib/commands/agent/publish/authoring-bundle.d.ts +0 -1
- package/lib/commands/agent/publish/authoring-bundle.js +0 -1
- package/lib/commands/agent/publish/authoring-bundle.js.map +1 -1
- package/lib/commands/agent/validate/authoring-bundle.d.ts +0 -1
- package/lib/commands/agent/validate/authoring-bundle.js +0 -1
- package/lib/commands/agent/validate/authoring-bundle.js.map +1 -1
- package/oclif.manifest.json +544 -548
- package/package.json +7 -7
package/oclif.manifest.json
CHANGED
|
@@ -322,7 +322,6 @@
|
|
|
322
322
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
323
323
|
"pluginName": "@salesforce/plugin-agent",
|
|
324
324
|
"pluginType": "core",
|
|
325
|
-
"state": "beta",
|
|
326
325
|
"strict": true,
|
|
327
326
|
"summary": "Interact with an agent to preview how it responds to your statements, questions, and commands (utterances).",
|
|
328
327
|
"enableJsonFlag": false,
|
|
@@ -340,16 +339,14 @@
|
|
|
340
339
|
"preview:agent"
|
|
341
340
|
]
|
|
342
341
|
},
|
|
343
|
-
"agent:
|
|
342
|
+
"agent:test:create": {
|
|
344
343
|
"aliases": [],
|
|
345
344
|
"args": {},
|
|
346
|
-
"description": "
|
|
345
|
+
"description": "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.\n\nWhen 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 (AiEvaluationDefinition) associated with the new test to your local Salesforce DX project and displays its filename.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
|
|
347
346
|
"examples": [
|
|
348
|
-
"
|
|
349
|
-
"
|
|
350
|
-
"
|
|
351
|
-
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
352
|
-
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
347
|
+
"Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
|
|
348
|
+
"Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
|
|
349
|
+
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview"
|
|
353
350
|
],
|
|
354
351
|
"flags": {
|
|
355
352
|
"json": {
|
|
@@ -367,6 +364,20 @@
|
|
|
367
364
|
"multiple": false,
|
|
368
365
|
"type": "option"
|
|
369
366
|
},
|
|
367
|
+
"api-name": {
|
|
368
|
+
"name": "api-name",
|
|
369
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
370
|
+
"hasDynamicHelp": false,
|
|
371
|
+
"multiple": false,
|
|
372
|
+
"type": "option"
|
|
373
|
+
},
|
|
374
|
+
"spec": {
|
|
375
|
+
"name": "spec",
|
|
376
|
+
"summary": "Path to the test spec YAML file.",
|
|
377
|
+
"hasDynamicHelp": false,
|
|
378
|
+
"multiple": false,
|
|
379
|
+
"type": "option"
|
|
380
|
+
},
|
|
370
381
|
"target-org": {
|
|
371
382
|
"char": "o",
|
|
372
383
|
"name": "target-org",
|
|
@@ -384,163 +395,53 @@
|
|
|
384
395
|
"multiple": false,
|
|
385
396
|
"type": "option"
|
|
386
397
|
},
|
|
387
|
-
"
|
|
388
|
-
"name": "
|
|
389
|
-
"summary": "
|
|
390
|
-
"hasDynamicHelp": false,
|
|
391
|
-
"multiple": false,
|
|
392
|
-
"options": [
|
|
393
|
-
"customer",
|
|
394
|
-
"internal"
|
|
395
|
-
],
|
|
396
|
-
"type": "option"
|
|
397
|
-
},
|
|
398
|
-
"role": {
|
|
399
|
-
"name": "role",
|
|
400
|
-
"summary": "Role of the agent.",
|
|
401
|
-
"hasDynamicHelp": false,
|
|
402
|
-
"multiple": false,
|
|
403
|
-
"type": "option"
|
|
404
|
-
},
|
|
405
|
-
"company-name": {
|
|
406
|
-
"name": "company-name",
|
|
407
|
-
"summary": "Name of your company.",
|
|
408
|
-
"hasDynamicHelp": false,
|
|
409
|
-
"multiple": false,
|
|
410
|
-
"type": "option"
|
|
411
|
-
},
|
|
412
|
-
"company-description": {
|
|
413
|
-
"name": "company-description",
|
|
414
|
-
"summary": "Description of your company.",
|
|
415
|
-
"hasDynamicHelp": false,
|
|
416
|
-
"multiple": false,
|
|
417
|
-
"type": "option"
|
|
418
|
-
},
|
|
419
|
-
"company-website": {
|
|
420
|
-
"name": "company-website",
|
|
421
|
-
"summary": "Website URL of your company.",
|
|
422
|
-
"hasDynamicHelp": false,
|
|
423
|
-
"multiple": false,
|
|
424
|
-
"type": "option"
|
|
425
|
-
},
|
|
426
|
-
"max-topics": {
|
|
427
|
-
"name": "max-topics",
|
|
428
|
-
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
429
|
-
"hasDynamicHelp": false,
|
|
430
|
-
"multiple": false,
|
|
431
|
-
"type": "option"
|
|
432
|
-
},
|
|
433
|
-
"agent-user": {
|
|
434
|
-
"name": "agent-user",
|
|
435
|
-
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
436
|
-
"hasDynamicHelp": false,
|
|
437
|
-
"multiple": false,
|
|
438
|
-
"type": "option"
|
|
439
|
-
},
|
|
440
|
-
"enrich-logs": {
|
|
441
|
-
"name": "enrich-logs",
|
|
442
|
-
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
443
|
-
"hasDynamicHelp": false,
|
|
444
|
-
"multiple": false,
|
|
445
|
-
"options": [
|
|
446
|
-
"true",
|
|
447
|
-
"false"
|
|
448
|
-
],
|
|
449
|
-
"type": "option"
|
|
450
|
-
},
|
|
451
|
-
"tone": {
|
|
452
|
-
"name": "tone",
|
|
453
|
-
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
454
|
-
"hasDynamicHelp": false,
|
|
455
|
-
"multiple": false,
|
|
456
|
-
"options": [
|
|
457
|
-
"formal",
|
|
458
|
-
"casual",
|
|
459
|
-
"neutral"
|
|
460
|
-
],
|
|
461
|
-
"type": "option"
|
|
462
|
-
},
|
|
463
|
-
"spec": {
|
|
464
|
-
"name": "spec",
|
|
465
|
-
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
466
|
-
"hasDynamicHelp": false,
|
|
467
|
-
"multiple": false,
|
|
468
|
-
"type": "option"
|
|
469
|
-
},
|
|
470
|
-
"output-file": {
|
|
471
|
-
"name": "output-file",
|
|
472
|
-
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
473
|
-
"default": "specs/agentSpec.yaml",
|
|
474
|
-
"hasDynamicHelp": false,
|
|
475
|
-
"multiple": false,
|
|
476
|
-
"type": "option"
|
|
477
|
-
},
|
|
478
|
-
"full-interview": {
|
|
479
|
-
"name": "full-interview",
|
|
480
|
-
"summary": "Prompt for both required and optional flags.",
|
|
398
|
+
"preview": {
|
|
399
|
+
"name": "preview",
|
|
400
|
+
"summary": "Preview the test metadata file (AiEvaluationDefinition) without deploying to your org.",
|
|
481
401
|
"allowNo": false,
|
|
482
402
|
"type": "boolean"
|
|
483
403
|
},
|
|
484
|
-
"prompt-template": {
|
|
485
|
-
"name": "prompt-template",
|
|
486
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
487
|
-
"hasDynamicHelp": false,
|
|
488
|
-
"multiple": false,
|
|
489
|
-
"type": "option"
|
|
490
|
-
},
|
|
491
|
-
"grounding-context": {
|
|
492
|
-
"dependsOn": [
|
|
493
|
-
"prompt-template"
|
|
494
|
-
],
|
|
495
|
-
"name": "grounding-context",
|
|
496
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
497
|
-
"hasDynamicHelp": false,
|
|
498
|
-
"multiple": false,
|
|
499
|
-
"type": "option"
|
|
500
|
-
},
|
|
501
404
|
"force-overwrite": {
|
|
502
405
|
"name": "force-overwrite",
|
|
503
|
-
"summary": "Don't prompt
|
|
406
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
504
407
|
"allowNo": false,
|
|
505
408
|
"type": "boolean"
|
|
506
409
|
}
|
|
507
410
|
},
|
|
508
411
|
"hasDynamicHelp": true,
|
|
509
412
|
"hiddenAliases": [],
|
|
510
|
-
"id": "agent:
|
|
413
|
+
"id": "agent:test:create",
|
|
511
414
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
512
415
|
"pluginName": "@salesforce/plugin-agent",
|
|
513
416
|
"pluginType": "core",
|
|
514
417
|
"strict": true,
|
|
515
|
-
"summary": "
|
|
418
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
516
419
|
"enableJsonFlag": true,
|
|
517
|
-
"requiresProject": true,
|
|
518
420
|
"isESM": true,
|
|
519
421
|
"relativePath": [
|
|
520
422
|
"lib",
|
|
521
423
|
"commands",
|
|
522
424
|
"agent",
|
|
523
|
-
"
|
|
524
|
-
"
|
|
425
|
+
"test",
|
|
426
|
+
"create.js"
|
|
525
427
|
],
|
|
526
428
|
"aliasPermutations": [],
|
|
527
429
|
"permutations": [
|
|
528
|
-
"agent:
|
|
529
|
-
"
|
|
530
|
-
"
|
|
531
|
-
"agent:
|
|
532
|
-
"
|
|
533
|
-
"
|
|
430
|
+
"agent:test:create",
|
|
431
|
+
"test:agent:create",
|
|
432
|
+
"test:create:agent",
|
|
433
|
+
"agent:create:test",
|
|
434
|
+
"create:agent:test",
|
|
435
|
+
"create:test:agent"
|
|
534
436
|
]
|
|
535
437
|
},
|
|
536
|
-
"agent:
|
|
438
|
+
"agent:test:list": {
|
|
537
439
|
"aliases": [],
|
|
538
440
|
"args": {},
|
|
539
|
-
"description": "
|
|
441
|
+
"description": "The command outputs a table with the name (API name) of each test along with its unique ID and the date it was created in the org.",
|
|
540
442
|
"examples": [
|
|
541
|
-
"
|
|
542
|
-
"
|
|
543
|
-
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
443
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
444
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
544
445
|
],
|
|
545
446
|
"flags": {
|
|
546
447
|
"json": {
|
|
@@ -568,176 +469,58 @@
|
|
|
568
469
|
"multiple": false,
|
|
569
470
|
"type": "option"
|
|
570
471
|
},
|
|
571
|
-
"api-name": {
|
|
572
|
-
"name": "api-name",
|
|
573
|
-
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
574
|
-
"hasDynamicHelp": false,
|
|
575
|
-
"multiple": false,
|
|
576
|
-
"type": "option"
|
|
577
|
-
},
|
|
578
472
|
"api-version": {
|
|
579
473
|
"description": "Override the api version used for api requests made by this command",
|
|
580
474
|
"name": "api-version",
|
|
581
475
|
"hasDynamicHelp": false,
|
|
582
476
|
"multiple": false,
|
|
583
477
|
"type": "option"
|
|
584
|
-
},
|
|
585
|
-
"spec": {
|
|
586
|
-
"char": "f",
|
|
587
|
-
"name": "spec",
|
|
588
|
-
"summary": "Path to the agent spec YAML file; if not specified, the command provides a list that you can choose from.",
|
|
589
|
-
"hasDynamicHelp": false,
|
|
590
|
-
"multiple": false,
|
|
591
|
-
"type": "option"
|
|
592
|
-
},
|
|
593
|
-
"output-dir": {
|
|
594
|
-
"char": "d",
|
|
595
|
-
"name": "output-dir",
|
|
596
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
597
|
-
"hasDynamicHelp": false,
|
|
598
|
-
"multiple": false,
|
|
599
|
-
"type": "option"
|
|
600
|
-
},
|
|
601
|
-
"name": {
|
|
602
|
-
"char": "n",
|
|
603
|
-
"name": "name",
|
|
604
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
605
|
-
"hasDynamicHelp": false,
|
|
606
|
-
"multiple": false,
|
|
607
|
-
"type": "option"
|
|
608
478
|
}
|
|
609
479
|
},
|
|
610
480
|
"hasDynamicHelp": true,
|
|
611
481
|
"hiddenAliases": [],
|
|
612
|
-
"id": "agent:
|
|
613
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
614
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
615
|
-
"pluginType": "core",
|
|
616
|
-
"state": "beta",
|
|
617
|
-
"strict": true,
|
|
618
|
-
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
619
|
-
"enableJsonFlag": true,
|
|
620
|
-
"requiresProject": true,
|
|
621
|
-
"FLAGGABLE_PROMPTS": {
|
|
622
|
-
"name": {
|
|
623
|
-
"message": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
624
|
-
"promptMessage": "Name (label) of the authoring bundle",
|
|
625
|
-
"required": true
|
|
626
|
-
},
|
|
627
|
-
"api-name": {
|
|
628
|
-
"message": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
629
|
-
"promptMessage": "API name of the new authoring bundle"
|
|
630
|
-
},
|
|
631
|
-
"spec": {
|
|
632
|
-
"message": "Path to the agent spec YAML file; if not specified, the command provides a list that you can choose from.",
|
|
633
|
-
"promptMessage": "Path to the agent spec YAML file",
|
|
634
|
-
"required": true
|
|
635
|
-
}
|
|
636
|
-
},
|
|
637
|
-
"isESM": true,
|
|
638
|
-
"relativePath": [
|
|
639
|
-
"lib",
|
|
640
|
-
"commands",
|
|
641
|
-
"agent",
|
|
642
|
-
"generate",
|
|
643
|
-
"authoring-bundle.js"
|
|
644
|
-
],
|
|
645
|
-
"aliasPermutations": [],
|
|
646
|
-
"permutations": [
|
|
647
|
-
"agent:generate:authoring-bundle",
|
|
648
|
-
"generate:agent:authoring-bundle",
|
|
649
|
-
"generate:authoring-bundle:agent",
|
|
650
|
-
"agent:authoring-bundle:generate",
|
|
651
|
-
"authoring-bundle:agent:generate",
|
|
652
|
-
"authoring-bundle:generate:agent"
|
|
653
|
-
]
|
|
654
|
-
},
|
|
655
|
-
"agent:generate:template": {
|
|
656
|
-
"aliases": [],
|
|
657
|
-
"args": {},
|
|
658
|
-
"description": "At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use the BotTemplate file, along with the GenAiPlannerBundle file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate file is generated in the \"botTemplates\" directory in your local package directory, and has the name <Agent_API_name>_v<Version>_Template.botTemplate-meta.xml, such as force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.",
|
|
659
|
-
"examples": [
|
|
660
|
-
"Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent agent; use version 1 of the agent.\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1"
|
|
661
|
-
],
|
|
662
|
-
"flags": {
|
|
663
|
-
"json": {
|
|
664
|
-
"description": "Format output as json.",
|
|
665
|
-
"helpGroup": "GLOBAL",
|
|
666
|
-
"name": "json",
|
|
667
|
-
"allowNo": false,
|
|
668
|
-
"type": "boolean"
|
|
669
|
-
},
|
|
670
|
-
"flags-dir": {
|
|
671
|
-
"helpGroup": "GLOBAL",
|
|
672
|
-
"name": "flags-dir",
|
|
673
|
-
"summary": "Import flag values from a directory.",
|
|
674
|
-
"hasDynamicHelp": false,
|
|
675
|
-
"multiple": false,
|
|
676
|
-
"type": "option"
|
|
677
|
-
},
|
|
678
|
-
"api-version": {
|
|
679
|
-
"description": "Override the api version used for api requests made by this command",
|
|
680
|
-
"name": "api-version",
|
|
681
|
-
"hasDynamicHelp": false,
|
|
682
|
-
"multiple": false,
|
|
683
|
-
"type": "option"
|
|
684
|
-
},
|
|
685
|
-
"agent-version": {
|
|
686
|
-
"name": "agent-version",
|
|
687
|
-
"required": true,
|
|
688
|
-
"summary": "Version of the agent (BotVersion).",
|
|
689
|
-
"hasDynamicHelp": false,
|
|
690
|
-
"multiple": false,
|
|
691
|
-
"type": "option"
|
|
692
|
-
},
|
|
693
|
-
"agent-file": {
|
|
694
|
-
"char": "f",
|
|
695
|
-
"name": "agent-file",
|
|
696
|
-
"required": true,
|
|
697
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
698
|
-
"hasDynamicHelp": false,
|
|
699
|
-
"multiple": false,
|
|
700
|
-
"type": "option"
|
|
701
|
-
}
|
|
702
|
-
},
|
|
703
|
-
"hasDynamicHelp": false,
|
|
704
|
-
"hiddenAliases": [],
|
|
705
|
-
"id": "agent:generate:template",
|
|
482
|
+
"id": "agent:test:list",
|
|
706
483
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
707
484
|
"pluginName": "@salesforce/plugin-agent",
|
|
708
485
|
"pluginType": "core",
|
|
709
486
|
"strict": true,
|
|
710
|
-
"summary": "
|
|
487
|
+
"summary": "List the available agent tests in your org.",
|
|
711
488
|
"enableJsonFlag": true,
|
|
712
|
-
"requiresProject": true,
|
|
713
489
|
"isESM": true,
|
|
714
490
|
"relativePath": [
|
|
715
491
|
"lib",
|
|
716
492
|
"commands",
|
|
717
493
|
"agent",
|
|
718
|
-
"
|
|
719
|
-
"
|
|
494
|
+
"test",
|
|
495
|
+
"list.js"
|
|
720
496
|
],
|
|
721
497
|
"aliasPermutations": [],
|
|
722
498
|
"permutations": [
|
|
723
|
-
"agent:
|
|
724
|
-
"
|
|
725
|
-
"
|
|
726
|
-
"agent:
|
|
727
|
-
"
|
|
728
|
-
"
|
|
499
|
+
"agent:test:list",
|
|
500
|
+
"test:agent:list",
|
|
501
|
+
"test:list:agent",
|
|
502
|
+
"agent:list:test",
|
|
503
|
+
"list:agent:test",
|
|
504
|
+
"list:test:agent"
|
|
729
505
|
]
|
|
730
506
|
},
|
|
731
|
-
"agent:
|
|
507
|
+
"agent:test:results": {
|
|
732
508
|
"aliases": [],
|
|
733
509
|
"args": {},
|
|
734
|
-
"description": "
|
|
510
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
735
511
|
"examples": [
|
|
736
|
-
"
|
|
737
|
-
"
|
|
738
|
-
"
|
|
512
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
513
|
+
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
514
|
+
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
739
515
|
],
|
|
740
516
|
"flags": {
|
|
517
|
+
"json": {
|
|
518
|
+
"description": "Format output as json.",
|
|
519
|
+
"helpGroup": "GLOBAL",
|
|
520
|
+
"name": "json",
|
|
521
|
+
"allowNo": false,
|
|
522
|
+
"type": "boolean"
|
|
523
|
+
},
|
|
741
524
|
"flags-dir": {
|
|
742
525
|
"helpGroup": "GLOBAL",
|
|
743
526
|
"name": "flags-dir",
|
|
@@ -746,64 +529,98 @@
|
|
|
746
529
|
"multiple": false,
|
|
747
530
|
"type": "option"
|
|
748
531
|
},
|
|
749
|
-
"
|
|
750
|
-
"char": "
|
|
751
|
-
"name": "
|
|
752
|
-
"
|
|
532
|
+
"target-org": {
|
|
533
|
+
"char": "o",
|
|
534
|
+
"name": "target-org",
|
|
535
|
+
"noCacheDefault": true,
|
|
536
|
+
"required": true,
|
|
537
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
538
|
+
"hasDynamicHelp": true,
|
|
539
|
+
"multiple": false,
|
|
540
|
+
"type": "option"
|
|
541
|
+
},
|
|
542
|
+
"api-version": {
|
|
543
|
+
"description": "Override the api version used for api requests made by this command",
|
|
544
|
+
"name": "api-version",
|
|
753
545
|
"hasDynamicHelp": false,
|
|
754
546
|
"multiple": false,
|
|
755
547
|
"type": "option"
|
|
756
548
|
},
|
|
757
|
-
"
|
|
758
|
-
"
|
|
759
|
-
"
|
|
760
|
-
"
|
|
761
|
-
"
|
|
549
|
+
"job-id": {
|
|
550
|
+
"char": "i",
|
|
551
|
+
"name": "job-id",
|
|
552
|
+
"required": true,
|
|
553
|
+
"summary": "Job ID of the completed agent test run.",
|
|
554
|
+
"hasDynamicHelp": false,
|
|
555
|
+
"multiple": false,
|
|
556
|
+
"type": "option"
|
|
762
557
|
},
|
|
763
|
-
"
|
|
764
|
-
"
|
|
765
|
-
"
|
|
766
|
-
"
|
|
558
|
+
"result-format": {
|
|
559
|
+
"name": "result-format",
|
|
560
|
+
"summary": "Format of the agent test run results.",
|
|
561
|
+
"default": "human",
|
|
562
|
+
"hasDynamicHelp": false,
|
|
563
|
+
"multiple": false,
|
|
564
|
+
"options": [
|
|
565
|
+
"json",
|
|
566
|
+
"human",
|
|
567
|
+
"junit",
|
|
568
|
+
"tap"
|
|
569
|
+
],
|
|
570
|
+
"type": "option"
|
|
571
|
+
},
|
|
572
|
+
"output-dir": {
|
|
573
|
+
"char": "d",
|
|
574
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
575
|
+
"name": "output-dir",
|
|
576
|
+
"summary": "Directory to write the agent test results into.",
|
|
767
577
|
"hasDynamicHelp": false,
|
|
768
578
|
"multiple": false,
|
|
769
579
|
"type": "option"
|
|
580
|
+
},
|
|
581
|
+
"verbose": {
|
|
582
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
583
|
+
"name": "verbose",
|
|
584
|
+
"summary": "Show generated data in the test results output.",
|
|
585
|
+
"allowNo": false,
|
|
586
|
+
"type": "boolean"
|
|
770
587
|
}
|
|
771
588
|
},
|
|
772
|
-
"hasDynamicHelp":
|
|
589
|
+
"hasDynamicHelp": true,
|
|
773
590
|
"hiddenAliases": [],
|
|
774
|
-
"id": "agent:
|
|
591
|
+
"id": "agent:test:results",
|
|
775
592
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
776
593
|
"pluginName": "@salesforce/plugin-agent",
|
|
777
594
|
"pluginType": "core",
|
|
778
595
|
"strict": true,
|
|
779
|
-
"summary": "
|
|
780
|
-
"enableJsonFlag":
|
|
596
|
+
"summary": "Get the results of a completed agent test run.",
|
|
597
|
+
"enableJsonFlag": true,
|
|
781
598
|
"isESM": true,
|
|
782
599
|
"relativePath": [
|
|
783
600
|
"lib",
|
|
784
601
|
"commands",
|
|
785
602
|
"agent",
|
|
786
|
-
"
|
|
787
|
-
"
|
|
603
|
+
"test",
|
|
604
|
+
"results.js"
|
|
788
605
|
],
|
|
789
606
|
"aliasPermutations": [],
|
|
790
607
|
"permutations": [
|
|
791
|
-
"agent:
|
|
792
|
-
"
|
|
793
|
-
"
|
|
794
|
-
"agent:test
|
|
795
|
-
"
|
|
796
|
-
"test
|
|
608
|
+
"agent:test:results",
|
|
609
|
+
"test:agent:results",
|
|
610
|
+
"test:results:agent",
|
|
611
|
+
"agent:results:test",
|
|
612
|
+
"results:agent:test",
|
|
613
|
+
"results:test:agent"
|
|
797
614
|
]
|
|
798
615
|
},
|
|
799
|
-
"agent:test:
|
|
616
|
+
"agent:test:resume": {
|
|
800
617
|
"aliases": [],
|
|
801
618
|
"args": {},
|
|
802
|
-
"description": "
|
|
619
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nUse the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of the terminal to you, and you must run \"agent test resume\" again.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
803
620
|
"examples": [
|
|
804
|
-
"
|
|
805
|
-
"
|
|
806
|
-
"
|
|
621
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
622
|
+
"Resume the most recently-run agent test in an org with alias \"my-org\" org; wait 10 minutes for the tests to finish:\n<%= config.bin %> <%= command.id %> --use-most-recent --wait 10 --target-org my-org",
|
|
623
|
+
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
807
624
|
],
|
|
808
625
|
"flags": {
|
|
809
626
|
"json": {
|
|
@@ -821,20 +638,6 @@
|
|
|
821
638
|
"multiple": false,
|
|
822
639
|
"type": "option"
|
|
823
640
|
},
|
|
824
|
-
"api-name": {
|
|
825
|
-
"name": "api-name",
|
|
826
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
827
|
-
"hasDynamicHelp": false,
|
|
828
|
-
"multiple": false,
|
|
829
|
-
"type": "option"
|
|
830
|
-
},
|
|
831
|
-
"spec": {
|
|
832
|
-
"name": "spec",
|
|
833
|
-
"summary": "Path to the test spec YAML file.",
|
|
834
|
-
"hasDynamicHelp": false,
|
|
835
|
-
"multiple": false,
|
|
836
|
-
"type": "option"
|
|
837
|
-
},
|
|
838
641
|
"target-org": {
|
|
839
642
|
"char": "o",
|
|
840
643
|
"name": "target-org",
|
|
@@ -852,27 +655,69 @@
|
|
|
852
655
|
"multiple": false,
|
|
853
656
|
"type": "option"
|
|
854
657
|
},
|
|
855
|
-
"
|
|
856
|
-
"
|
|
857
|
-
"
|
|
658
|
+
"job-id": {
|
|
659
|
+
"char": "i",
|
|
660
|
+
"name": "job-id",
|
|
661
|
+
"summary": "Job ID of the original agent test run.",
|
|
662
|
+
"hasDynamicHelp": false,
|
|
663
|
+
"multiple": false,
|
|
664
|
+
"type": "option"
|
|
665
|
+
},
|
|
666
|
+
"use-most-recent": {
|
|
667
|
+
"char": "r",
|
|
668
|
+
"name": "use-most-recent",
|
|
669
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
858
670
|
"allowNo": false,
|
|
859
671
|
"type": "boolean"
|
|
860
672
|
},
|
|
861
|
-
"
|
|
862
|
-
"
|
|
863
|
-
"
|
|
673
|
+
"wait": {
|
|
674
|
+
"char": "w",
|
|
675
|
+
"name": "wait",
|
|
676
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
677
|
+
"default": "5 minutes",
|
|
678
|
+
"hasDynamicHelp": true,
|
|
679
|
+
"multiple": false,
|
|
680
|
+
"type": "option"
|
|
681
|
+
},
|
|
682
|
+
"result-format": {
|
|
683
|
+
"name": "result-format",
|
|
684
|
+
"summary": "Format of the agent test run results.",
|
|
685
|
+
"default": "human",
|
|
686
|
+
"hasDynamicHelp": false,
|
|
687
|
+
"multiple": false,
|
|
688
|
+
"options": [
|
|
689
|
+
"json",
|
|
690
|
+
"human",
|
|
691
|
+
"junit",
|
|
692
|
+
"tap"
|
|
693
|
+
],
|
|
694
|
+
"type": "option"
|
|
695
|
+
},
|
|
696
|
+
"output-dir": {
|
|
697
|
+
"char": "d",
|
|
698
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
699
|
+
"name": "output-dir",
|
|
700
|
+
"summary": "Directory to write the agent test results into.",
|
|
701
|
+
"hasDynamicHelp": false,
|
|
702
|
+
"multiple": false,
|
|
703
|
+
"type": "option"
|
|
704
|
+
},
|
|
705
|
+
"verbose": {
|
|
706
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
707
|
+
"name": "verbose",
|
|
708
|
+
"summary": "Show generated data in the test results output.",
|
|
864
709
|
"allowNo": false,
|
|
865
710
|
"type": "boolean"
|
|
866
711
|
}
|
|
867
712
|
},
|
|
868
713
|
"hasDynamicHelp": true,
|
|
869
714
|
"hiddenAliases": [],
|
|
870
|
-
"id": "agent:test:
|
|
715
|
+
"id": "agent:test:resume",
|
|
871
716
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
872
717
|
"pluginName": "@salesforce/plugin-agent",
|
|
873
718
|
"pluginType": "core",
|
|
874
719
|
"strict": true,
|
|
875
|
-
"summary": "
|
|
720
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
876
721
|
"enableJsonFlag": true,
|
|
877
722
|
"isESM": true,
|
|
878
723
|
"relativePath": [
|
|
@@ -880,25 +725,26 @@
|
|
|
880
725
|
"commands",
|
|
881
726
|
"agent",
|
|
882
727
|
"test",
|
|
883
|
-
"
|
|
728
|
+
"resume.js"
|
|
884
729
|
],
|
|
885
730
|
"aliasPermutations": [],
|
|
886
731
|
"permutations": [
|
|
887
|
-
"agent:test:
|
|
888
|
-
"test:agent:
|
|
889
|
-
"test:
|
|
890
|
-
"agent:
|
|
891
|
-
"
|
|
892
|
-
"
|
|
732
|
+
"agent:test:resume",
|
|
733
|
+
"test:agent:resume",
|
|
734
|
+
"test:resume:agent",
|
|
735
|
+
"agent:resume:test",
|
|
736
|
+
"resume:agent:test",
|
|
737
|
+
"resume:test:agent"
|
|
893
738
|
]
|
|
894
739
|
},
|
|
895
|
-
"agent:test:
|
|
740
|
+
"agent:test:run": {
|
|
896
741
|
"aliases": [],
|
|
897
742
|
"args": {},
|
|
898
|
-
"description": "
|
|
743
|
+
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
899
744
|
"examples": [
|
|
900
|
-
"
|
|
901
|
-
"
|
|
745
|
+
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
746
|
+
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
747
|
+
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
902
748
|
],
|
|
903
749
|
"flags": {
|
|
904
750
|
"json": {
|
|
@@ -932,16 +778,62 @@
|
|
|
932
778
|
"hasDynamicHelp": false,
|
|
933
779
|
"multiple": false,
|
|
934
780
|
"type": "option"
|
|
781
|
+
},
|
|
782
|
+
"api-name": {
|
|
783
|
+
"char": "n",
|
|
784
|
+
"name": "api-name",
|
|
785
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
786
|
+
"hasDynamicHelp": false,
|
|
787
|
+
"multiple": false,
|
|
788
|
+
"type": "option"
|
|
789
|
+
},
|
|
790
|
+
"wait": {
|
|
791
|
+
"char": "w",
|
|
792
|
+
"name": "wait",
|
|
793
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
794
|
+
"hasDynamicHelp": true,
|
|
795
|
+
"multiple": false,
|
|
796
|
+
"type": "option"
|
|
797
|
+
},
|
|
798
|
+
"result-format": {
|
|
799
|
+
"name": "result-format",
|
|
800
|
+
"summary": "Format of the agent test run results.",
|
|
801
|
+
"default": "human",
|
|
802
|
+
"hasDynamicHelp": false,
|
|
803
|
+
"multiple": false,
|
|
804
|
+
"options": [
|
|
805
|
+
"json",
|
|
806
|
+
"human",
|
|
807
|
+
"junit",
|
|
808
|
+
"tap"
|
|
809
|
+
],
|
|
810
|
+
"type": "option"
|
|
811
|
+
},
|
|
812
|
+
"output-dir": {
|
|
813
|
+
"char": "d",
|
|
814
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
815
|
+
"name": "output-dir",
|
|
816
|
+
"summary": "Directory to write the agent test results into.",
|
|
817
|
+
"hasDynamicHelp": false,
|
|
818
|
+
"multiple": false,
|
|
819
|
+
"type": "option"
|
|
820
|
+
},
|
|
821
|
+
"verbose": {
|
|
822
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
823
|
+
"name": "verbose",
|
|
824
|
+
"summary": "Show generated data in the test results output.",
|
|
825
|
+
"allowNo": false,
|
|
826
|
+
"type": "boolean"
|
|
935
827
|
}
|
|
936
828
|
},
|
|
937
829
|
"hasDynamicHelp": true,
|
|
938
830
|
"hiddenAliases": [],
|
|
939
|
-
"id": "agent:test:
|
|
831
|
+
"id": "agent:test:run",
|
|
940
832
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
941
833
|
"pluginName": "@salesforce/plugin-agent",
|
|
942
834
|
"pluginType": "core",
|
|
943
835
|
"strict": true,
|
|
944
|
-
"summary": "
|
|
836
|
+
"summary": "Start an agent test in your org.",
|
|
945
837
|
"enableJsonFlag": true,
|
|
946
838
|
"isESM": true,
|
|
947
839
|
"relativePath": [
|
|
@@ -949,26 +841,25 @@
|
|
|
949
841
|
"commands",
|
|
950
842
|
"agent",
|
|
951
843
|
"test",
|
|
952
|
-
"
|
|
844
|
+
"run.js"
|
|
953
845
|
],
|
|
954
846
|
"aliasPermutations": [],
|
|
955
847
|
"permutations": [
|
|
956
|
-
"agent:test:
|
|
957
|
-
"test:agent:
|
|
958
|
-
"test:
|
|
959
|
-
"agent:
|
|
960
|
-
"
|
|
961
|
-
"
|
|
848
|
+
"agent:test:run",
|
|
849
|
+
"test:agent:run",
|
|
850
|
+
"test:run:agent",
|
|
851
|
+
"agent:run:test",
|
|
852
|
+
"run:agent:test",
|
|
853
|
+
"run:test:agent"
|
|
962
854
|
]
|
|
963
855
|
},
|
|
964
|
-
"agent:
|
|
856
|
+
"agent:publish:authoring-bundle": {
|
|
965
857
|
"aliases": [],
|
|
966
858
|
"args": {},
|
|
967
|
-
"description": "
|
|
859
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
968
860
|
"examples": [
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
861
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
862
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org"
|
|
972
863
|
],
|
|
973
864
|
"flags": {
|
|
974
865
|
"json": {
|
|
@@ -1003,81 +894,65 @@
|
|
|
1003
894
|
"multiple": false,
|
|
1004
895
|
"type": "option"
|
|
1005
896
|
},
|
|
1006
|
-
"
|
|
1007
|
-
"char": "
|
|
1008
|
-
"name": "
|
|
1009
|
-
"
|
|
1010
|
-
"summary": "Job ID of the completed agent test run.",
|
|
1011
|
-
"hasDynamicHelp": false,
|
|
1012
|
-
"multiple": false,
|
|
1013
|
-
"type": "option"
|
|
1014
|
-
},
|
|
1015
|
-
"result-format": {
|
|
1016
|
-
"name": "result-format",
|
|
1017
|
-
"summary": "Format of the agent test run results.",
|
|
1018
|
-
"default": "human",
|
|
1019
|
-
"hasDynamicHelp": false,
|
|
1020
|
-
"multiple": false,
|
|
1021
|
-
"options": [
|
|
1022
|
-
"json",
|
|
1023
|
-
"human",
|
|
1024
|
-
"junit",
|
|
1025
|
-
"tap"
|
|
1026
|
-
],
|
|
1027
|
-
"type": "option"
|
|
1028
|
-
},
|
|
1029
|
-
"output-dir": {
|
|
1030
|
-
"char": "d",
|
|
1031
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
1032
|
-
"name": "output-dir",
|
|
1033
|
-
"summary": "Directory to write the agent test results into.",
|
|
897
|
+
"api-name": {
|
|
898
|
+
"char": "n",
|
|
899
|
+
"name": "api-name",
|
|
900
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
1034
901
|
"hasDynamicHelp": false,
|
|
1035
902
|
"multiple": false,
|
|
1036
903
|
"type": "option"
|
|
1037
904
|
},
|
|
1038
|
-
"
|
|
1039
|
-
"
|
|
1040
|
-
"
|
|
1041
|
-
"summary": "Show generated data in the test results output.",
|
|
905
|
+
"skip-retrieve": {
|
|
906
|
+
"name": "skip-retrieve",
|
|
907
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
1042
908
|
"allowNo": false,
|
|
1043
909
|
"type": "boolean"
|
|
1044
910
|
}
|
|
1045
911
|
},
|
|
1046
912
|
"hasDynamicHelp": true,
|
|
1047
913
|
"hiddenAliases": [],
|
|
1048
|
-
"id": "agent:
|
|
914
|
+
"id": "agent:publish:authoring-bundle",
|
|
1049
915
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1050
916
|
"pluginName": "@salesforce/plugin-agent",
|
|
1051
917
|
"pluginType": "core",
|
|
1052
918
|
"strict": true,
|
|
1053
|
-
"summary": "
|
|
919
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
1054
920
|
"enableJsonFlag": true,
|
|
921
|
+
"requiresProject": true,
|
|
922
|
+
"FLAGGABLE_PROMPTS": {
|
|
923
|
+
"api-name": {
|
|
924
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
925
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
926
|
+
}
|
|
927
|
+
},
|
|
1055
928
|
"isESM": true,
|
|
1056
929
|
"relativePath": [
|
|
1057
930
|
"lib",
|
|
1058
931
|
"commands",
|
|
1059
932
|
"agent",
|
|
1060
|
-
"
|
|
1061
|
-
"
|
|
933
|
+
"publish",
|
|
934
|
+
"authoring-bundle.js"
|
|
1062
935
|
],
|
|
1063
936
|
"aliasPermutations": [],
|
|
1064
937
|
"permutations": [
|
|
1065
|
-
"agent:
|
|
1066
|
-
"
|
|
1067
|
-
"
|
|
1068
|
-
"agent:
|
|
1069
|
-
"
|
|
1070
|
-
"
|
|
938
|
+
"agent:publish:authoring-bundle",
|
|
939
|
+
"publish:agent:authoring-bundle",
|
|
940
|
+
"publish:authoring-bundle:agent",
|
|
941
|
+
"agent:authoring-bundle:publish",
|
|
942
|
+
"authoring-bundle:agent:publish",
|
|
943
|
+
"authoring-bundle:publish:agent"
|
|
1071
944
|
]
|
|
1072
945
|
},
|
|
1073
|
-
"agent:
|
|
946
|
+
"agent:generate:agent-spec": {
|
|
1074
947
|
"aliases": [],
|
|
1075
948
|
"args": {},
|
|
1076
|
-
"description": "
|
|
949
|
+
"description": "An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.\n\nUse flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description.\n\nYou can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.\n\nYou can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent.\n\nWhen your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the \"agent generate authoring-bundle\" CLI command. An authoring bundle is a metadata type that contains an Agent Script file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately create an agent with the \"agent create\" command. We don't recommend this workflow because these types of agents don't use Agent Script, and are thus less flexible and more difficult to maintain.)",
|
|
1077
950
|
"examples": [
|
|
1078
|
-
"
|
|
1079
|
-
"
|
|
1080
|
-
"
|
|
951
|
+
"Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:\n<%= config.bin %> <%= command.id %> --type customer --role \"Field customer complaints and manage employee schedules.\" --company-name \"Coral Cloud Resorts\" --company-description \"Provide customers with exceptional destination activities, unforgettable experiences, and reservation services.\"",
|
|
952
|
+
"Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the \"specs/resortManagerSpec.yaml\" file and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org",
|
|
953
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
954
|
+
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
955
|
+
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1081
956
|
],
|
|
1082
957
|
"flags": {
|
|
1083
958
|
"json": {
|
|
@@ -1112,96 +987,163 @@
|
|
|
1112
987
|
"multiple": false,
|
|
1113
988
|
"type": "option"
|
|
1114
989
|
},
|
|
1115
|
-
"
|
|
1116
|
-
"
|
|
1117
|
-
"
|
|
1118
|
-
"summary": "Job ID of the original agent test run.",
|
|
990
|
+
"type": {
|
|
991
|
+
"name": "type",
|
|
992
|
+
"summary": "Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers.",
|
|
1119
993
|
"hasDynamicHelp": false,
|
|
1120
994
|
"multiple": false,
|
|
995
|
+
"options": [
|
|
996
|
+
"customer",
|
|
997
|
+
"internal"
|
|
998
|
+
],
|
|
1121
999
|
"type": "option"
|
|
1122
1000
|
},
|
|
1123
|
-
"
|
|
1124
|
-
"
|
|
1125
|
-
"
|
|
1126
|
-
"
|
|
1127
|
-
"
|
|
1128
|
-
"type": "
|
|
1001
|
+
"role": {
|
|
1002
|
+
"name": "role",
|
|
1003
|
+
"summary": "Role of the agent.",
|
|
1004
|
+
"hasDynamicHelp": false,
|
|
1005
|
+
"multiple": false,
|
|
1006
|
+
"type": "option"
|
|
1129
1007
|
},
|
|
1130
|
-
"
|
|
1131
|
-
"
|
|
1132
|
-
"
|
|
1133
|
-
"
|
|
1134
|
-
"default": "5 minutes",
|
|
1135
|
-
"hasDynamicHelp": true,
|
|
1008
|
+
"company-name": {
|
|
1009
|
+
"name": "company-name",
|
|
1010
|
+
"summary": "Name of your company.",
|
|
1011
|
+
"hasDynamicHelp": false,
|
|
1136
1012
|
"multiple": false,
|
|
1137
1013
|
"type": "option"
|
|
1138
1014
|
},
|
|
1139
|
-
"
|
|
1140
|
-
"name": "
|
|
1141
|
-
"summary": "
|
|
1142
|
-
"
|
|
1015
|
+
"company-description": {
|
|
1016
|
+
"name": "company-description",
|
|
1017
|
+
"summary": "Description of your company.",
|
|
1018
|
+
"hasDynamicHelp": false,
|
|
1019
|
+
"multiple": false,
|
|
1020
|
+
"type": "option"
|
|
1021
|
+
},
|
|
1022
|
+
"company-website": {
|
|
1023
|
+
"name": "company-website",
|
|
1024
|
+
"summary": "Website URL of your company.",
|
|
1025
|
+
"hasDynamicHelp": false,
|
|
1026
|
+
"multiple": false,
|
|
1027
|
+
"type": "option"
|
|
1028
|
+
},
|
|
1029
|
+
"max-topics": {
|
|
1030
|
+
"name": "max-topics",
|
|
1031
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1032
|
+
"hasDynamicHelp": false,
|
|
1033
|
+
"multiple": false,
|
|
1034
|
+
"type": "option"
|
|
1035
|
+
},
|
|
1036
|
+
"agent-user": {
|
|
1037
|
+
"name": "agent-user",
|
|
1038
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1039
|
+
"hasDynamicHelp": false,
|
|
1040
|
+
"multiple": false,
|
|
1041
|
+
"type": "option"
|
|
1042
|
+
},
|
|
1043
|
+
"enrich-logs": {
|
|
1044
|
+
"name": "enrich-logs",
|
|
1045
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1143
1046
|
"hasDynamicHelp": false,
|
|
1144
1047
|
"multiple": false,
|
|
1145
1048
|
"options": [
|
|
1146
|
-
"
|
|
1147
|
-
"
|
|
1148
|
-
"junit",
|
|
1149
|
-
"tap"
|
|
1049
|
+
"true",
|
|
1050
|
+
"false"
|
|
1150
1051
|
],
|
|
1151
1052
|
"type": "option"
|
|
1152
1053
|
},
|
|
1153
|
-
"
|
|
1154
|
-
"
|
|
1155
|
-
"
|
|
1156
|
-
"name": "output-dir",
|
|
1157
|
-
"summary": "Directory to write the agent test results into.",
|
|
1054
|
+
"tone": {
|
|
1055
|
+
"name": "tone",
|
|
1056
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1158
1057
|
"hasDynamicHelp": false,
|
|
1159
1058
|
"multiple": false,
|
|
1059
|
+
"options": [
|
|
1060
|
+
"formal",
|
|
1061
|
+
"casual",
|
|
1062
|
+
"neutral"
|
|
1063
|
+
],
|
|
1160
1064
|
"type": "option"
|
|
1161
1065
|
},
|
|
1162
|
-
"
|
|
1163
|
-
"
|
|
1164
|
-
"
|
|
1165
|
-
"
|
|
1066
|
+
"spec": {
|
|
1067
|
+
"name": "spec",
|
|
1068
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1069
|
+
"hasDynamicHelp": false,
|
|
1070
|
+
"multiple": false,
|
|
1071
|
+
"type": "option"
|
|
1072
|
+
},
|
|
1073
|
+
"output-file": {
|
|
1074
|
+
"name": "output-file",
|
|
1075
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1076
|
+
"default": "specs/agentSpec.yaml",
|
|
1077
|
+
"hasDynamicHelp": false,
|
|
1078
|
+
"multiple": false,
|
|
1079
|
+
"type": "option"
|
|
1080
|
+
},
|
|
1081
|
+
"full-interview": {
|
|
1082
|
+
"name": "full-interview",
|
|
1083
|
+
"summary": "Prompt for both required and optional flags.",
|
|
1084
|
+
"allowNo": false,
|
|
1085
|
+
"type": "boolean"
|
|
1086
|
+
},
|
|
1087
|
+
"prompt-template": {
|
|
1088
|
+
"name": "prompt-template",
|
|
1089
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1090
|
+
"hasDynamicHelp": false,
|
|
1091
|
+
"multiple": false,
|
|
1092
|
+
"type": "option"
|
|
1093
|
+
},
|
|
1094
|
+
"grounding-context": {
|
|
1095
|
+
"dependsOn": [
|
|
1096
|
+
"prompt-template"
|
|
1097
|
+
],
|
|
1098
|
+
"name": "grounding-context",
|
|
1099
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1100
|
+
"hasDynamicHelp": false,
|
|
1101
|
+
"multiple": false,
|
|
1102
|
+
"type": "option"
|
|
1103
|
+
},
|
|
1104
|
+
"force-overwrite": {
|
|
1105
|
+
"name": "force-overwrite",
|
|
1106
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1166
1107
|
"allowNo": false,
|
|
1167
1108
|
"type": "boolean"
|
|
1168
1109
|
}
|
|
1169
1110
|
},
|
|
1170
1111
|
"hasDynamicHelp": true,
|
|
1171
1112
|
"hiddenAliases": [],
|
|
1172
|
-
"id": "agent:
|
|
1113
|
+
"id": "agent:generate:agent-spec",
|
|
1173
1114
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1174
1115
|
"pluginName": "@salesforce/plugin-agent",
|
|
1175
1116
|
"pluginType": "core",
|
|
1176
1117
|
"strict": true,
|
|
1177
|
-
"summary": "
|
|
1118
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
1178
1119
|
"enableJsonFlag": true,
|
|
1120
|
+
"requiresProject": true,
|
|
1179
1121
|
"isESM": true,
|
|
1180
1122
|
"relativePath": [
|
|
1181
1123
|
"lib",
|
|
1182
1124
|
"commands",
|
|
1183
1125
|
"agent",
|
|
1184
|
-
"
|
|
1185
|
-
"
|
|
1126
|
+
"generate",
|
|
1127
|
+
"agent-spec.js"
|
|
1186
1128
|
],
|
|
1187
1129
|
"aliasPermutations": [],
|
|
1188
1130
|
"permutations": [
|
|
1189
|
-
"agent:
|
|
1190
|
-
"
|
|
1191
|
-
"
|
|
1192
|
-
"agent:
|
|
1193
|
-
"
|
|
1194
|
-
"
|
|
1131
|
+
"agent:generate:agent-spec",
|
|
1132
|
+
"generate:agent:agent-spec",
|
|
1133
|
+
"generate:agent-spec:agent",
|
|
1134
|
+
"agent:agent-spec:generate",
|
|
1135
|
+
"agent-spec:agent:generate",
|
|
1136
|
+
"agent-spec:generate:agent"
|
|
1195
1137
|
]
|
|
1196
1138
|
},
|
|
1197
|
-
"agent:
|
|
1139
|
+
"agent:generate:authoring-bundle": {
|
|
1198
1140
|
"aliases": [],
|
|
1199
1141
|
"args": {},
|
|
1200
|
-
"description": "
|
|
1142
|
+
"description": "Authoring bundles are metadata components that contain an agent's Agent Script file. The Agent Script file is the agent's blueprint; it fully describes what the agent can do using the Agent Script language.\n\nUse this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the \"agent generate agent-spec\" command. The agent spec YAML file is a high-level description of the agent; it describes its essence rather than exactly what it can do.\n\nThe metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard \"<bundle-api-name>.bundle-meta.xml\" metadata file and the Agent Script file (with extension \".agent\"). When you run this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-api-name> directory. Use the --output-dir flag to generate them elsewhere.\n\nAfter you generate the initial authoring bundle, code the Agent Script file so your agent behaves exactly as you want. The Agent Script file generated by this command is just a first draft of your agent! Interactively test the agent by conversing with it using the \"agent preview\" command. Then publish the agent to your org with the \"agent publish authoring-bundle\" command.\n\nThis command requires an org because it uses it to access an LLM for generating the Agent Script file.",
|
|
1201
1143
|
"examples": [
|
|
1202
|
-
"
|
|
1203
|
-
"
|
|
1204
|
-
"
|
|
1144
|
+
"Generate an authoring bundle by being prompted for all required values, such as the agent spec YAML file, the bundle name, and the API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1145
|
+
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1146
|
+
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1205
1147
|
],
|
|
1206
1148
|
"flags": {
|
|
1207
1149
|
"json": {
|
|
@@ -1229,94 +1171,95 @@
|
|
|
1229
1171
|
"multiple": false,
|
|
1230
1172
|
"type": "option"
|
|
1231
1173
|
},
|
|
1232
|
-
"api-version": {
|
|
1233
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1234
|
-
"name": "api-version",
|
|
1235
|
-
"hasDynamicHelp": false,
|
|
1236
|
-
"multiple": false,
|
|
1237
|
-
"type": "option"
|
|
1238
|
-
},
|
|
1239
1174
|
"api-name": {
|
|
1240
|
-
"char": "n",
|
|
1241
1175
|
"name": "api-name",
|
|
1242
|
-
"summary": "API name of the
|
|
1176
|
+
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1243
1177
|
"hasDynamicHelp": false,
|
|
1244
1178
|
"multiple": false,
|
|
1245
1179
|
"type": "option"
|
|
1246
1180
|
},
|
|
1247
|
-
"
|
|
1248
|
-
"
|
|
1249
|
-
"name": "
|
|
1250
|
-
"
|
|
1251
|
-
"hasDynamicHelp": true,
|
|
1181
|
+
"api-version": {
|
|
1182
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1183
|
+
"name": "api-version",
|
|
1184
|
+
"hasDynamicHelp": false,
|
|
1252
1185
|
"multiple": false,
|
|
1253
1186
|
"type": "option"
|
|
1254
1187
|
},
|
|
1255
|
-
"
|
|
1256
|
-
"
|
|
1257
|
-
"
|
|
1258
|
-
"
|
|
1188
|
+
"spec": {
|
|
1189
|
+
"char": "f",
|
|
1190
|
+
"name": "spec",
|
|
1191
|
+
"summary": "Path to the agent spec YAML file; if not specified, the command provides a list that you can choose from.",
|
|
1259
1192
|
"hasDynamicHelp": false,
|
|
1260
1193
|
"multiple": false,
|
|
1261
|
-
"options": [
|
|
1262
|
-
"json",
|
|
1263
|
-
"human",
|
|
1264
|
-
"junit",
|
|
1265
|
-
"tap"
|
|
1266
|
-
],
|
|
1267
1194
|
"type": "option"
|
|
1268
1195
|
},
|
|
1269
1196
|
"output-dir": {
|
|
1270
1197
|
"char": "d",
|
|
1271
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
1272
1198
|
"name": "output-dir",
|
|
1273
|
-
"summary": "Directory
|
|
1199
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
1274
1200
|
"hasDynamicHelp": false,
|
|
1275
1201
|
"multiple": false,
|
|
1276
1202
|
"type": "option"
|
|
1277
1203
|
},
|
|
1278
|
-
"
|
|
1279
|
-
"
|
|
1280
|
-
"name": "
|
|
1281
|
-
"summary": "
|
|
1282
|
-
"
|
|
1283
|
-
"
|
|
1204
|
+
"name": {
|
|
1205
|
+
"char": "n",
|
|
1206
|
+
"name": "name",
|
|
1207
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1208
|
+
"hasDynamicHelp": false,
|
|
1209
|
+
"multiple": false,
|
|
1210
|
+
"type": "option"
|
|
1284
1211
|
}
|
|
1285
1212
|
},
|
|
1286
1213
|
"hasDynamicHelp": true,
|
|
1287
1214
|
"hiddenAliases": [],
|
|
1288
|
-
"id": "agent:
|
|
1215
|
+
"id": "agent:generate:authoring-bundle",
|
|
1289
1216
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1290
1217
|
"pluginName": "@salesforce/plugin-agent",
|
|
1291
1218
|
"pluginType": "core",
|
|
1292
1219
|
"strict": true,
|
|
1293
|
-
"summary": "
|
|
1220
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
1294
1221
|
"enableJsonFlag": true,
|
|
1222
|
+
"requiresProject": true,
|
|
1223
|
+
"FLAGGABLE_PROMPTS": {
|
|
1224
|
+
"name": {
|
|
1225
|
+
"message": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1226
|
+
"promptMessage": "Name (label) of the authoring bundle",
|
|
1227
|
+
"required": true
|
|
1228
|
+
},
|
|
1229
|
+
"api-name": {
|
|
1230
|
+
"message": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1231
|
+
"promptMessage": "API name of the new authoring bundle"
|
|
1232
|
+
},
|
|
1233
|
+
"spec": {
|
|
1234
|
+
"message": "Path to the agent spec YAML file; if not specified, the command provides a list that you can choose from.",
|
|
1235
|
+
"promptMessage": "Path to the agent spec YAML file",
|
|
1236
|
+
"required": true
|
|
1237
|
+
}
|
|
1238
|
+
},
|
|
1295
1239
|
"isESM": true,
|
|
1296
1240
|
"relativePath": [
|
|
1297
1241
|
"lib",
|
|
1298
1242
|
"commands",
|
|
1299
1243
|
"agent",
|
|
1300
|
-
"
|
|
1301
|
-
"
|
|
1244
|
+
"generate",
|
|
1245
|
+
"authoring-bundle.js"
|
|
1302
1246
|
],
|
|
1303
1247
|
"aliasPermutations": [],
|
|
1304
1248
|
"permutations": [
|
|
1305
|
-
"agent:
|
|
1306
|
-
"
|
|
1307
|
-
"
|
|
1308
|
-
"agent:
|
|
1309
|
-
"
|
|
1310
|
-
"
|
|
1249
|
+
"agent:generate:authoring-bundle",
|
|
1250
|
+
"generate:agent:authoring-bundle",
|
|
1251
|
+
"generate:authoring-bundle:agent",
|
|
1252
|
+
"agent:authoring-bundle:generate",
|
|
1253
|
+
"authoring-bundle:agent:generate",
|
|
1254
|
+
"authoring-bundle:generate:agent"
|
|
1311
1255
|
]
|
|
1312
1256
|
},
|
|
1313
|
-
"agent:
|
|
1257
|
+
"agent:generate:template": {
|
|
1314
1258
|
"aliases": [],
|
|
1315
1259
|
"args": {},
|
|
1316
|
-
"description": "
|
|
1260
|
+
"description": "At a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate file for a specific agent (Bot). You then use the BotTemplate file, along with the GenAiPlannerBundle file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate file is generated in the \"botTemplates\" directory in your local package directory, and has the name <Agent_API_name>_v<Version>_Template.botTemplate-meta.xml, such as force-app/main/default/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.",
|
|
1317
1261
|
"examples": [
|
|
1318
|
-
"
|
|
1319
|
-
"Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org"
|
|
1262
|
+
"Generate an agent template from a Bot metadata file in your DX project that corresponds to the My_Awesome_Agent agent; use version 1 of the agent.\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1"
|
|
1320
1263
|
],
|
|
1321
1264
|
"flags": {
|
|
1322
1265
|
"json": {
|
|
@@ -1334,16 +1277,6 @@
|
|
|
1334
1277
|
"multiple": false,
|
|
1335
1278
|
"type": "option"
|
|
1336
1279
|
},
|
|
1337
|
-
"target-org": {
|
|
1338
|
-
"char": "o",
|
|
1339
|
-
"name": "target-org",
|
|
1340
|
-
"noCacheDefault": true,
|
|
1341
|
-
"required": true,
|
|
1342
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1343
|
-
"hasDynamicHelp": true,
|
|
1344
|
-
"multiple": false,
|
|
1345
|
-
"type": "option"
|
|
1346
|
-
},
|
|
1347
1280
|
"api-version": {
|
|
1348
1281
|
"description": "Override the api version used for api requests made by this command",
|
|
1349
1282
|
"name": "api-version",
|
|
@@ -1351,57 +1284,127 @@
|
|
|
1351
1284
|
"multiple": false,
|
|
1352
1285
|
"type": "option"
|
|
1353
1286
|
},
|
|
1354
|
-
"
|
|
1355
|
-
"
|
|
1356
|
-
"
|
|
1357
|
-
"summary": "
|
|
1287
|
+
"agent-version": {
|
|
1288
|
+
"name": "agent-version",
|
|
1289
|
+
"required": true,
|
|
1290
|
+
"summary": "Version of the agent (BotVersion).",
|
|
1291
|
+
"hasDynamicHelp": false,
|
|
1292
|
+
"multiple": false,
|
|
1293
|
+
"type": "option"
|
|
1294
|
+
},
|
|
1295
|
+
"agent-file": {
|
|
1296
|
+
"char": "f",
|
|
1297
|
+
"name": "agent-file",
|
|
1298
|
+
"required": true,
|
|
1299
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
1358
1300
|
"hasDynamicHelp": false,
|
|
1359
1301
|
"multiple": false,
|
|
1360
1302
|
"type": "option"
|
|
1361
1303
|
}
|
|
1362
1304
|
},
|
|
1363
|
-
"hasDynamicHelp":
|
|
1305
|
+
"hasDynamicHelp": false,
|
|
1364
1306
|
"hiddenAliases": [],
|
|
1365
|
-
"id": "agent:
|
|
1307
|
+
"id": "agent:generate:template",
|
|
1366
1308
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1367
1309
|
"pluginName": "@salesforce/plugin-agent",
|
|
1368
1310
|
"pluginType": "core",
|
|
1369
|
-
"state": "beta",
|
|
1370
1311
|
"strict": true,
|
|
1371
|
-
"summary": "
|
|
1312
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a managed package.",
|
|
1372
1313
|
"enableJsonFlag": true,
|
|
1373
1314
|
"requiresProject": true,
|
|
1374
|
-
"
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1315
|
+
"isESM": true,
|
|
1316
|
+
"relativePath": [
|
|
1317
|
+
"lib",
|
|
1318
|
+
"commands",
|
|
1319
|
+
"agent",
|
|
1320
|
+
"generate",
|
|
1321
|
+
"template.js"
|
|
1322
|
+
],
|
|
1323
|
+
"aliasPermutations": [],
|
|
1324
|
+
"permutations": [
|
|
1325
|
+
"agent:generate:template",
|
|
1326
|
+
"generate:agent:template",
|
|
1327
|
+
"generate:template:agent",
|
|
1328
|
+
"agent:template:generate",
|
|
1329
|
+
"template:agent:generate",
|
|
1330
|
+
"template:generate:agent"
|
|
1331
|
+
]
|
|
1332
|
+
},
|
|
1333
|
+
"agent:generate:test-spec": {
|
|
1334
|
+
"aliases": [],
|
|
1335
|
+
"args": {},
|
|
1336
|
+
"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.",
|
|
1337
|
+
"examples": [
|
|
1338
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
1339
|
+
"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",
|
|
1340
|
+
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml"
|
|
1341
|
+
],
|
|
1342
|
+
"flags": {
|
|
1343
|
+
"flags-dir": {
|
|
1344
|
+
"helpGroup": "GLOBAL",
|
|
1345
|
+
"name": "flags-dir",
|
|
1346
|
+
"summary": "Import flag values from a directory.",
|
|
1347
|
+
"hasDynamicHelp": false,
|
|
1348
|
+
"multiple": false,
|
|
1349
|
+
"type": "option"
|
|
1350
|
+
},
|
|
1351
|
+
"from-definition": {
|
|
1352
|
+
"char": "d",
|
|
1353
|
+
"name": "from-definition",
|
|
1354
|
+
"summary": "Filepath to the AIEvaluationDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
1355
|
+
"hasDynamicHelp": false,
|
|
1356
|
+
"multiple": false,
|
|
1357
|
+
"type": "option"
|
|
1358
|
+
},
|
|
1359
|
+
"force-overwrite": {
|
|
1360
|
+
"name": "force-overwrite",
|
|
1361
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
1362
|
+
"allowNo": false,
|
|
1363
|
+
"type": "boolean"
|
|
1364
|
+
},
|
|
1365
|
+
"output-file": {
|
|
1366
|
+
"char": "f",
|
|
1367
|
+
"name": "output-file",
|
|
1368
|
+
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\".",
|
|
1369
|
+
"hasDynamicHelp": false,
|
|
1370
|
+
"multiple": false,
|
|
1371
|
+
"type": "option"
|
|
1378
1372
|
}
|
|
1379
1373
|
},
|
|
1374
|
+
"hasDynamicHelp": false,
|
|
1375
|
+
"hiddenAliases": [],
|
|
1376
|
+
"id": "agent:generate:test-spec",
|
|
1377
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1378
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1379
|
+
"pluginType": "core",
|
|
1380
|
+
"strict": true,
|
|
1381
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
1382
|
+
"enableJsonFlag": false,
|
|
1380
1383
|
"isESM": true,
|
|
1381
1384
|
"relativePath": [
|
|
1382
1385
|
"lib",
|
|
1383
1386
|
"commands",
|
|
1384
1387
|
"agent",
|
|
1385
|
-
"
|
|
1386
|
-
"
|
|
1388
|
+
"generate",
|
|
1389
|
+
"test-spec.js"
|
|
1387
1390
|
],
|
|
1388
1391
|
"aliasPermutations": [],
|
|
1389
1392
|
"permutations": [
|
|
1390
|
-
"agent:
|
|
1391
|
-
"
|
|
1392
|
-
"
|
|
1393
|
-
"agent:
|
|
1394
|
-
"
|
|
1395
|
-
"
|
|
1393
|
+
"agent:generate:test-spec",
|
|
1394
|
+
"generate:agent:test-spec",
|
|
1395
|
+
"generate:test-spec:agent",
|
|
1396
|
+
"agent:test-spec:generate",
|
|
1397
|
+
"test-spec:agent:generate",
|
|
1398
|
+
"test-spec:generate:agent"
|
|
1396
1399
|
]
|
|
1397
1400
|
},
|
|
1398
|
-
"agent:
|
|
1401
|
+
"agent:validate:authoring-bundle": {
|
|
1399
1402
|
"aliases": [],
|
|
1400
1403
|
"args": {},
|
|
1401
|
-
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\
|
|
1404
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nThis command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
|
|
1402
1405
|
"examples": [
|
|
1403
|
-
"
|
|
1404
|
-
"
|
|
1406
|
+
"Validate an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1407
|
+
"Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org"
|
|
1405
1408
|
],
|
|
1406
1409
|
"flags": {
|
|
1407
1410
|
"json": {
|
|
@@ -1439,33 +1442,26 @@
|
|
|
1439
1442
|
"api-name": {
|
|
1440
1443
|
"char": "n",
|
|
1441
1444
|
"name": "api-name",
|
|
1442
|
-
"summary": "API name of the authoring bundle you want to
|
|
1445
|
+
"summary": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
1443
1446
|
"hasDynamicHelp": false,
|
|
1444
1447
|
"multiple": false,
|
|
1445
1448
|
"type": "option"
|
|
1446
|
-
},
|
|
1447
|
-
"skip-retrieve": {
|
|
1448
|
-
"name": "skip-retrieve",
|
|
1449
|
-
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
1450
|
-
"allowNo": false,
|
|
1451
|
-
"type": "boolean"
|
|
1452
1449
|
}
|
|
1453
1450
|
},
|
|
1454
1451
|
"hasDynamicHelp": true,
|
|
1455
1452
|
"hiddenAliases": [],
|
|
1456
|
-
"id": "agent:
|
|
1453
|
+
"id": "agent:validate:authoring-bundle",
|
|
1457
1454
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1458
1455
|
"pluginName": "@salesforce/plugin-agent",
|
|
1459
1456
|
"pluginType": "core",
|
|
1460
|
-
"state": "beta",
|
|
1461
1457
|
"strict": true,
|
|
1462
|
-
"summary": "
|
|
1458
|
+
"summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
|
|
1463
1459
|
"enableJsonFlag": true,
|
|
1464
1460
|
"requiresProject": true,
|
|
1465
1461
|
"FLAGGABLE_PROMPTS": {
|
|
1466
1462
|
"api-name": {
|
|
1467
|
-
"message": "API name of the authoring bundle you want to
|
|
1468
|
-
"promptMessage": "API name of the authoring bundle to
|
|
1463
|
+
"message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
1464
|
+
"promptMessage": "API name of the authoring bundle to validate"
|
|
1469
1465
|
}
|
|
1470
1466
|
},
|
|
1471
1467
|
"isESM": true,
|
|
@@ -1473,19 +1469,19 @@
|
|
|
1473
1469
|
"lib",
|
|
1474
1470
|
"commands",
|
|
1475
1471
|
"agent",
|
|
1476
|
-
"
|
|
1472
|
+
"validate",
|
|
1477
1473
|
"authoring-bundle.js"
|
|
1478
1474
|
],
|
|
1479
1475
|
"aliasPermutations": [],
|
|
1480
1476
|
"permutations": [
|
|
1481
|
-
"agent:
|
|
1482
|
-
"
|
|
1483
|
-
"
|
|
1484
|
-
"agent:authoring-bundle:
|
|
1485
|
-
"authoring-bundle:agent:
|
|
1486
|
-
"authoring-bundle:
|
|
1477
|
+
"agent:validate:authoring-bundle",
|
|
1478
|
+
"validate:agent:authoring-bundle",
|
|
1479
|
+
"validate:authoring-bundle:agent",
|
|
1480
|
+
"agent:authoring-bundle:validate",
|
|
1481
|
+
"authoring-bundle:agent:validate",
|
|
1482
|
+
"authoring-bundle:validate:agent"
|
|
1487
1483
|
]
|
|
1488
1484
|
}
|
|
1489
1485
|
},
|
|
1490
|
-
"version": "1.27.
|
|
1486
|
+
"version": "1.27.3"
|
|
1491
1487
|
}
|