@salesforce/plugin-agent 2.1.1 → 2.2.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 +109 -66
- package/lib/agentActivation.js +1 -1
- package/lib/agentActivation.js.map +1 -1
- package/lib/agentTestCache.d.ts +1 -1
- package/lib/agentTestCache.js +1 -1
- package/lib/agentTestCache.js.map +1 -1
- package/lib/commands/agent/generate/agent-spec.js +1 -1
- package/lib/commands/agent/generate/agent-spec.js.map +1 -1
- package/lib/commands/agent/generate/test-spec.js +2 -2
- package/lib/commands/agent/generate/test-spec.js.map +1 -1
- package/lib/commands/agent/mcp/create.js.map +1 -1
- package/lib/commands/agent/mcp/update.js +1 -4
- package/lib/commands/agent/mcp/update.js.map +1 -1
- package/lib/commands/agent/preview/start.d.ts +1 -0
- package/lib/commands/agent/preview/start.js +3 -2
- package/lib/commands/agent/preview/start.js.map +1 -1
- package/lib/commands/agent/preview.d.ts +1 -0
- package/lib/commands/agent/preview.js +3 -2
- package/lib/commands/agent/preview.js.map +1 -1
- package/lib/commands/agent/publish/authoring-bundle.js.map +1 -1
- package/lib/commands/agent/test/create.js +17 -14
- package/lib/commands/agent/test/create.js.map +1 -1
- package/lib/commands/agent/test/resume.js +1 -1
- package/lib/commands/agent/test/resume.js.map +1 -1
- package/lib/commands/agent/test/run-eval.js +1 -1
- package/lib/commands/agent/test/run-eval.js.map +1 -1
- package/lib/commands/agent/test/run.js.map +1 -1
- package/lib/commands/agent/trace/read.js.map +1 -1
- package/lib/components/agent-preview-react.js +4 -2
- package/lib/components/agent-preview-react.js.map +1 -1
- package/lib/flags.d.ts +20 -2
- package/lib/flags.js +105 -3
- package/lib/flags.js.map +1 -1
- package/lib/handleTestResults.js +12 -9
- package/lib/handleTestResults.js.map +1 -1
- package/messages/shared.md +17 -1
- package/oclif.manifest.json +554 -538
- package/package.json +21 -17
package/oclif.manifest.json
CHANGED
|
@@ -375,7 +375,7 @@
|
|
|
375
375
|
"type": "boolean"
|
|
376
376
|
},
|
|
377
377
|
"context-variables": {
|
|
378
|
-
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type
|
|
378
|
+
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.",
|
|
379
379
|
"name": "context-variables",
|
|
380
380
|
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
381
381
|
"delimiter": ",",
|
|
@@ -383,6 +383,14 @@
|
|
|
383
383
|
"multiple": true,
|
|
384
384
|
"type": "option"
|
|
385
385
|
},
|
|
386
|
+
"context-variables-json": {
|
|
387
|
+
"description": "Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a Number, Object, List, or Json value.\n\nThe value is a JSON array of objects, each with a \"name\", a \"type\", and an optional \"value\". The \"type\" is one of Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of \"value\" must match \"type\": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an array, and Json takes an object.\n\nExample: --context-variables-json '[{\"name\":\"probeGate\",\"type\":\"Boolean\",\"value\":true},{\"name\":\"retryCount\",\"type\":\"Number\",\"value\":3}]'.\n\nYou can pass both --context-variables and --context-variables-json in the same command. When the same variable name appears in both, the --context-variables-json value wins.\n\nTip: names follow the same rules as --context-variables. Use the \"$Context.\" prefix for linked context variables, and a bare name for state variables.",
|
|
388
|
+
"name": "context-variables-json",
|
|
389
|
+
"summary": "Typed session variables for the agent preview session, as a JSON array.",
|
|
390
|
+
"hasDynamicHelp": false,
|
|
391
|
+
"multiple": false,
|
|
392
|
+
"type": "option"
|
|
393
|
+
},
|
|
386
394
|
"agent-json": {
|
|
387
395
|
"dependsOn": [
|
|
388
396
|
"authoring-bundle"
|
|
@@ -418,14 +426,16 @@
|
|
|
418
426
|
"preview:agent"
|
|
419
427
|
]
|
|
420
428
|
},
|
|
421
|
-
"agent:
|
|
429
|
+
"agent:generate:agent-spec": {
|
|
422
430
|
"aliases": [],
|
|
423
431
|
"args": {},
|
|
424
|
-
"description": "
|
|
432
|
+
"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.)",
|
|
425
433
|
"examples": [
|
|
426
|
-
"
|
|
427
|
-
"
|
|
428
|
-
"
|
|
434
|
+
"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.\"",
|
|
435
|
+
"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",
|
|
436
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
437
|
+
"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\"",
|
|
438
|
+
"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"
|
|
429
439
|
],
|
|
430
440
|
"flags": {
|
|
431
441
|
"json": {
|
|
@@ -460,138 +470,164 @@
|
|
|
460
470
|
"multiple": false,
|
|
461
471
|
"type": "option"
|
|
462
472
|
},
|
|
463
|
-
"
|
|
464
|
-
"
|
|
465
|
-
"
|
|
466
|
-
"required": true,
|
|
467
|
-
"summary": "Display name for the data library (max 80 characters).",
|
|
473
|
+
"type": {
|
|
474
|
+
"name": "type",
|
|
475
|
+
"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.",
|
|
468
476
|
"hasDynamicHelp": false,
|
|
469
477
|
"multiple": false,
|
|
478
|
+
"options": [
|
|
479
|
+
"customer",
|
|
480
|
+
"internal"
|
|
481
|
+
],
|
|
470
482
|
"type": "option"
|
|
471
483
|
},
|
|
472
|
-
"
|
|
473
|
-
"name": "
|
|
474
|
-
"
|
|
475
|
-
"summary": "API name for the data library (max 80 characters, alphanumeric and underscores only, must start with a letter).",
|
|
484
|
+
"role": {
|
|
485
|
+
"name": "role",
|
|
486
|
+
"summary": "Role of the agent.",
|
|
476
487
|
"hasDynamicHelp": false,
|
|
477
488
|
"multiple": false,
|
|
478
489
|
"type": "option"
|
|
479
490
|
},
|
|
480
|
-
"
|
|
481
|
-
"name": "
|
|
482
|
-
"
|
|
483
|
-
"summary": "Type of grounding source: sfdrive (file upload), knowledge (Salesforce Knowledge articles), or retriever (existing active Custom Retriever).",
|
|
491
|
+
"company-name": {
|
|
492
|
+
"name": "company-name",
|
|
493
|
+
"summary": "Name of your company.",
|
|
484
494
|
"hasDynamicHelp": false,
|
|
485
495
|
"multiple": false,
|
|
486
|
-
"options": [
|
|
487
|
-
"sfdrive",
|
|
488
|
-
"knowledge",
|
|
489
|
-
"retriever"
|
|
490
|
-
],
|
|
491
496
|
"type": "option"
|
|
492
497
|
},
|
|
493
|
-
"description": {
|
|
494
|
-
"name": "description",
|
|
495
|
-
"summary": "Description of
|
|
498
|
+
"company-description": {
|
|
499
|
+
"name": "company-description",
|
|
500
|
+
"summary": "Description of your company.",
|
|
496
501
|
"hasDynamicHelp": false,
|
|
497
502
|
"multiple": false,
|
|
498
503
|
"type": "option"
|
|
499
504
|
},
|
|
500
|
-
"
|
|
501
|
-
"name": "
|
|
502
|
-
"summary": "
|
|
505
|
+
"company-website": {
|
|
506
|
+
"name": "company-website",
|
|
507
|
+
"summary": "Website URL of your company.",
|
|
503
508
|
"hasDynamicHelp": false,
|
|
504
509
|
"multiple": false,
|
|
505
|
-
"options": [
|
|
506
|
-
"basic",
|
|
507
|
-
"enhanced"
|
|
508
|
-
],
|
|
509
510
|
"type": "option"
|
|
510
511
|
},
|
|
511
|
-
"
|
|
512
|
-
"name": "
|
|
513
|
-
"summary": "
|
|
512
|
+
"max-topics": {
|
|
513
|
+
"name": "max-topics",
|
|
514
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
514
515
|
"hasDynamicHelp": false,
|
|
515
516
|
"multiple": false,
|
|
516
517
|
"type": "option"
|
|
517
518
|
},
|
|
518
|
-
"
|
|
519
|
-
"name": "
|
|
520
|
-
"summary": "
|
|
519
|
+
"agent-user": {
|
|
520
|
+
"name": "agent-user",
|
|
521
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
521
522
|
"hasDynamicHelp": false,
|
|
522
523
|
"multiple": false,
|
|
523
524
|
"type": "option"
|
|
524
525
|
},
|
|
525
|
-
"
|
|
526
|
-
"name": "
|
|
527
|
-
"summary": "
|
|
526
|
+
"enrich-logs": {
|
|
527
|
+
"name": "enrich-logs",
|
|
528
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
528
529
|
"hasDynamicHelp": false,
|
|
529
530
|
"multiple": false,
|
|
531
|
+
"options": [
|
|
532
|
+
"true",
|
|
533
|
+
"false"
|
|
534
|
+
],
|
|
530
535
|
"type": "option"
|
|
531
536
|
},
|
|
532
|
-
"
|
|
533
|
-
"name": "
|
|
534
|
-
"summary": "
|
|
537
|
+
"tone": {
|
|
538
|
+
"name": "tone",
|
|
539
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
540
|
+
"hasDynamicHelp": false,
|
|
541
|
+
"multiple": false,
|
|
542
|
+
"options": [
|
|
543
|
+
"formal",
|
|
544
|
+
"casual",
|
|
545
|
+
"neutral"
|
|
546
|
+
],
|
|
547
|
+
"type": "option"
|
|
548
|
+
},
|
|
549
|
+
"spec": {
|
|
550
|
+
"name": "spec",
|
|
551
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
535
552
|
"hasDynamicHelp": false,
|
|
536
553
|
"multiple": false,
|
|
537
554
|
"type": "option"
|
|
538
555
|
},
|
|
539
|
-
"
|
|
540
|
-
"name": "
|
|
541
|
-
"summary": "
|
|
556
|
+
"output-file": {
|
|
557
|
+
"name": "output-file",
|
|
558
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
559
|
+
"default": "specs/agentSpec.yaml",
|
|
542
560
|
"hasDynamicHelp": false,
|
|
543
561
|
"multiple": false,
|
|
544
562
|
"type": "option"
|
|
545
563
|
},
|
|
546
|
-
"
|
|
547
|
-
"name": "
|
|
548
|
-
"summary": "
|
|
564
|
+
"full-interview": {
|
|
565
|
+
"name": "full-interview",
|
|
566
|
+
"summary": "Prompt for both required and optional flags.",
|
|
567
|
+
"allowNo": false,
|
|
568
|
+
"type": "boolean"
|
|
569
|
+
},
|
|
570
|
+
"prompt-template": {
|
|
571
|
+
"name": "prompt-template",
|
|
572
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
549
573
|
"hasDynamicHelp": false,
|
|
550
574
|
"multiple": false,
|
|
551
575
|
"type": "option"
|
|
552
576
|
},
|
|
553
|
-
"
|
|
554
|
-
"
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
"
|
|
577
|
+
"grounding-context": {
|
|
578
|
+
"dependsOn": [
|
|
579
|
+
"prompt-template"
|
|
580
|
+
],
|
|
581
|
+
"name": "grounding-context",
|
|
582
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
583
|
+
"hasDynamicHelp": false,
|
|
558
584
|
"multiple": false,
|
|
559
585
|
"type": "option"
|
|
586
|
+
},
|
|
587
|
+
"force-overwrite": {
|
|
588
|
+
"name": "force-overwrite",
|
|
589
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
590
|
+
"allowNo": false,
|
|
591
|
+
"type": "boolean"
|
|
560
592
|
}
|
|
561
593
|
},
|
|
562
594
|
"hasDynamicHelp": true,
|
|
563
595
|
"hiddenAliases": [],
|
|
564
|
-
"id": "agent:
|
|
596
|
+
"id": "agent:generate:agent-spec",
|
|
565
597
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
566
598
|
"pluginName": "@salesforce/plugin-agent",
|
|
567
599
|
"pluginType": "core",
|
|
568
600
|
"strict": true,
|
|
569
|
-
"summary": "
|
|
601
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
570
602
|
"enableJsonFlag": true,
|
|
603
|
+
"requiresProject": true,
|
|
571
604
|
"isESM": true,
|
|
572
605
|
"relativePath": [
|
|
573
606
|
"lib",
|
|
574
607
|
"commands",
|
|
575
608
|
"agent",
|
|
576
|
-
"
|
|
577
|
-
"
|
|
609
|
+
"generate",
|
|
610
|
+
"agent-spec.js"
|
|
578
611
|
],
|
|
579
612
|
"aliasPermutations": [],
|
|
580
613
|
"permutations": [
|
|
581
|
-
"agent:
|
|
582
|
-
"
|
|
583
|
-
"
|
|
584
|
-
"agent:
|
|
585
|
-
"
|
|
586
|
-
"
|
|
614
|
+
"agent:generate:agent-spec",
|
|
615
|
+
"generate:agent:agent-spec",
|
|
616
|
+
"generate:agent-spec:agent",
|
|
617
|
+
"agent:agent-spec:generate",
|
|
618
|
+
"agent-spec:agent:generate",
|
|
619
|
+
"agent-spec:generate:agent"
|
|
587
620
|
]
|
|
588
621
|
},
|
|
589
|
-
"agent:
|
|
622
|
+
"agent:generate:authoring-bundle": {
|
|
590
623
|
"aliases": [],
|
|
591
624
|
"args": {},
|
|
592
|
-
"description": "
|
|
625
|
+
"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. The resulting Agent Script file is customized to reflect what's in the agent spec file. You can also create an authoring bundle without an agent spec file by specifying the \"--no-spec\" flag; in this case, the resulting Agent Script file is just the default boilerplate.\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.",
|
|
593
626
|
"examples": [
|
|
594
|
-
"
|
|
627
|
+
"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 %>",
|
|
628
|
+
"Generate an authoring bundle without using an agent spec file; give the bundle the label \"My Authoring Bundle\" and use your default org:\n<%= config.bin %> <%= command.id %> --no-spec --name \"My Authoring Bundle\"",
|
|
629
|
+
"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\"",
|
|
630
|
+
"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"
|
|
595
631
|
],
|
|
596
632
|
"flags": {
|
|
597
633
|
"json": {
|
|
@@ -619,6 +655,13 @@
|
|
|
619
655
|
"multiple": false,
|
|
620
656
|
"type": "option"
|
|
621
657
|
},
|
|
658
|
+
"api-name": {
|
|
659
|
+
"name": "api-name",
|
|
660
|
+
"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.",
|
|
661
|
+
"hasDynamicHelp": false,
|
|
662
|
+
"multiple": false,
|
|
663
|
+
"type": "option"
|
|
664
|
+
},
|
|
622
665
|
"api-version": {
|
|
623
666
|
"description": "Override the api version used for api requests made by this command",
|
|
624
667
|
"name": "api-version",
|
|
@@ -626,49 +669,77 @@
|
|
|
626
669
|
"multiple": false,
|
|
627
670
|
"type": "option"
|
|
628
671
|
},
|
|
629
|
-
"
|
|
630
|
-
"char": "
|
|
631
|
-
"name": "
|
|
632
|
-
"
|
|
633
|
-
"
|
|
672
|
+
"spec": {
|
|
673
|
+
"char": "f",
|
|
674
|
+
"name": "spec",
|
|
675
|
+
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
676
|
+
"hasDynamicHelp": false,
|
|
677
|
+
"multiple": false,
|
|
678
|
+
"type": "option"
|
|
679
|
+
},
|
|
680
|
+
"no-spec": {
|
|
681
|
+
"name": "no-spec",
|
|
682
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
683
|
+
"allowNo": false,
|
|
684
|
+
"type": "boolean"
|
|
685
|
+
},
|
|
686
|
+
"output-dir": {
|
|
687
|
+
"char": "d",
|
|
688
|
+
"name": "output-dir",
|
|
689
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
690
|
+
"hasDynamicHelp": false,
|
|
691
|
+
"multiple": false,
|
|
692
|
+
"type": "option"
|
|
693
|
+
},
|
|
694
|
+
"name": {
|
|
695
|
+
"char": "n",
|
|
696
|
+
"name": "name",
|
|
697
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
634
698
|
"hasDynamicHelp": false,
|
|
635
699
|
"multiple": false,
|
|
636
700
|
"type": "option"
|
|
701
|
+
},
|
|
702
|
+
"force-overwrite": {
|
|
703
|
+
"name": "force-overwrite",
|
|
704
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
705
|
+
"allowNo": false,
|
|
706
|
+
"type": "boolean"
|
|
637
707
|
}
|
|
638
708
|
},
|
|
639
709
|
"hasDynamicHelp": true,
|
|
640
710
|
"hiddenAliases": [],
|
|
641
|
-
"id": "agent:
|
|
711
|
+
"id": "agent:generate:authoring-bundle",
|
|
642
712
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
643
713
|
"pluginName": "@salesforce/plugin-agent",
|
|
644
714
|
"pluginType": "core",
|
|
645
715
|
"strict": true,
|
|
646
|
-
"summary": "
|
|
716
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
647
717
|
"enableJsonFlag": true,
|
|
718
|
+
"requiresProject": true,
|
|
648
719
|
"isESM": true,
|
|
649
720
|
"relativePath": [
|
|
650
721
|
"lib",
|
|
651
722
|
"commands",
|
|
652
723
|
"agent",
|
|
653
|
-
"
|
|
654
|
-
"
|
|
724
|
+
"generate",
|
|
725
|
+
"authoring-bundle.js"
|
|
655
726
|
],
|
|
656
727
|
"aliasPermutations": [],
|
|
657
728
|
"permutations": [
|
|
658
|
-
"agent:
|
|
659
|
-
"
|
|
660
|
-
"
|
|
661
|
-
"agent:
|
|
662
|
-
"
|
|
663
|
-
"
|
|
729
|
+
"agent:generate:authoring-bundle",
|
|
730
|
+
"generate:agent:authoring-bundle",
|
|
731
|
+
"generate:authoring-bundle:agent",
|
|
732
|
+
"agent:authoring-bundle:generate",
|
|
733
|
+
"authoring-bundle:agent:generate",
|
|
734
|
+
"authoring-bundle:generate:agent"
|
|
664
735
|
]
|
|
665
736
|
},
|
|
666
|
-
"agent:
|
|
737
|
+
"agent:generate:template": {
|
|
667
738
|
"aliases": [],
|
|
668
739
|
"args": {},
|
|
669
|
-
"description": "
|
|
740
|
+
"description": "WARNING: This command doesn't work for agents that were created from an Agent Script file. In other words, you can't currently package an agent template for agents that use Agent Script.\n\nAt 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 metadata file for a specific agent (Bot). You then use the BotTemplate metadata file, along with the GenAiPlannerBundle metadata 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 metadata 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 metadata file is generated in the \"botTemplates\" directory in the output directory specified with the --output-dir flag, and has the name <Agent_API_name>\\_v<Version>\\_Template.botTemplate-meta.xml, such as my-package/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.\n\nSee \"Develop and Package Agent Templates Using Scratch Orgs\" (https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/dev2gp_package_agent_templates.htm) for details about the complete process, which includes using a scratch org to create and test the agent, retrieving the agent metadata to your DX project, running this command to create the agent template, and then packaging the template.",
|
|
670
741
|
"examples": [
|
|
671
|
-
"
|
|
742
|
+
"Generate an agent template from the My_Awesome_Agent Bot metadata file in your DX project and save the BotTemplate and GenAiPlannerBundle to the specified directory; use version 1 of the agent. The agent that the template is based on is in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1 --output-dir my-package --source-org my-scratch-org"
|
|
672
743
|
],
|
|
673
744
|
"flags": {
|
|
674
745
|
"json": {
|
|
@@ -686,16 +757,6 @@
|
|
|
686
757
|
"multiple": false,
|
|
687
758
|
"type": "option"
|
|
688
759
|
},
|
|
689
|
-
"target-org": {
|
|
690
|
-
"char": "o",
|
|
691
|
-
"name": "target-org",
|
|
692
|
-
"noCacheDefault": true,
|
|
693
|
-
"required": true,
|
|
694
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
695
|
-
"hasDynamicHelp": true,
|
|
696
|
-
"multiple": false,
|
|
697
|
-
"type": "option"
|
|
698
|
-
},
|
|
699
760
|
"api-version": {
|
|
700
761
|
"description": "Override the api version used for api requests made by this command",
|
|
701
762
|
"name": "api-version",
|
|
@@ -703,11 +764,37 @@
|
|
|
703
764
|
"multiple": false,
|
|
704
765
|
"type": "option"
|
|
705
766
|
},
|
|
706
|
-
"
|
|
707
|
-
"char": "
|
|
708
|
-
"name": "
|
|
709
|
-
"
|
|
710
|
-
"
|
|
767
|
+
"source-org": {
|
|
768
|
+
"char": "s",
|
|
769
|
+
"name": "source-org",
|
|
770
|
+
"noCacheDefault": true,
|
|
771
|
+
"required": true,
|
|
772
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
773
|
+
"hasDynamicHelp": true,
|
|
774
|
+
"multiple": false,
|
|
775
|
+
"type": "option"
|
|
776
|
+
},
|
|
777
|
+
"agent-version": {
|
|
778
|
+
"name": "agent-version",
|
|
779
|
+
"required": true,
|
|
780
|
+
"summary": "Version of the agent (BotVersion).",
|
|
781
|
+
"hasDynamicHelp": false,
|
|
782
|
+
"multiple": false,
|
|
783
|
+
"type": "option"
|
|
784
|
+
},
|
|
785
|
+
"agent-file": {
|
|
786
|
+
"char": "f",
|
|
787
|
+
"name": "agent-file",
|
|
788
|
+
"required": true,
|
|
789
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
790
|
+
"hasDynamicHelp": false,
|
|
791
|
+
"multiple": false,
|
|
792
|
+
"type": "option"
|
|
793
|
+
},
|
|
794
|
+
"output-dir": {
|
|
795
|
+
"char": "r",
|
|
796
|
+
"name": "output-dir",
|
|
797
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
711
798
|
"hasDynamicHelp": false,
|
|
712
799
|
"multiple": false,
|
|
713
800
|
"type": "option"
|
|
@@ -715,47 +802,44 @@
|
|
|
715
802
|
},
|
|
716
803
|
"hasDynamicHelp": true,
|
|
717
804
|
"hiddenAliases": [],
|
|
718
|
-
"id": "agent:
|
|
805
|
+
"id": "agent:generate:template",
|
|
719
806
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
720
807
|
"pluginName": "@salesforce/plugin-agent",
|
|
721
808
|
"pluginType": "core",
|
|
722
809
|
"strict": true,
|
|
723
|
-
"summary": "
|
|
810
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
724
811
|
"enableJsonFlag": true,
|
|
812
|
+
"requiresProject": true,
|
|
725
813
|
"isESM": true,
|
|
726
814
|
"relativePath": [
|
|
727
815
|
"lib",
|
|
728
816
|
"commands",
|
|
729
817
|
"agent",
|
|
730
|
-
"
|
|
731
|
-
"
|
|
818
|
+
"generate",
|
|
819
|
+
"template.js"
|
|
732
820
|
],
|
|
733
821
|
"aliasPermutations": [],
|
|
734
822
|
"permutations": [
|
|
735
|
-
"agent:
|
|
736
|
-
"
|
|
737
|
-
"
|
|
738
|
-
"agent:
|
|
739
|
-
"
|
|
740
|
-
"
|
|
823
|
+
"agent:generate:template",
|
|
824
|
+
"generate:agent:template",
|
|
825
|
+
"generate:template:agent",
|
|
826
|
+
"agent:template:generate",
|
|
827
|
+
"template:agent:generate",
|
|
828
|
+
"template:generate:agent"
|
|
741
829
|
]
|
|
742
830
|
},
|
|
743
|
-
"agent:
|
|
831
|
+
"agent:generate:test-spec": {
|
|
744
832
|
"aliases": [],
|
|
745
833
|
"args": {},
|
|
746
|
-
"description": "
|
|
834
|
+
"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\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\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` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
747
835
|
"examples": [
|
|
748
|
-
"
|
|
749
|
-
"
|
|
836
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
837
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
838
|
+
"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",
|
|
839
|
+
"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",
|
|
840
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
750
841
|
],
|
|
751
842
|
"flags": {
|
|
752
|
-
"json": {
|
|
753
|
-
"description": "Format output as json.",
|
|
754
|
-
"helpGroup": "GLOBAL",
|
|
755
|
-
"name": "json",
|
|
756
|
-
"allowNo": false,
|
|
757
|
-
"type": "boolean"
|
|
758
|
-
},
|
|
759
843
|
"flags-dir": {
|
|
760
844
|
"helpGroup": "GLOBAL",
|
|
761
845
|
"name": "flags-dir",
|
|
@@ -764,69 +848,76 @@
|
|
|
764
848
|
"multiple": false,
|
|
765
849
|
"type": "option"
|
|
766
850
|
},
|
|
767
|
-
"
|
|
768
|
-
"char": "
|
|
769
|
-
"name": "
|
|
770
|
-
"
|
|
771
|
-
"
|
|
772
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
773
|
-
"hasDynamicHelp": true,
|
|
851
|
+
"from-definition": {
|
|
852
|
+
"char": "d",
|
|
853
|
+
"name": "from-definition",
|
|
854
|
+
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
855
|
+
"hasDynamicHelp": false,
|
|
774
856
|
"multiple": false,
|
|
775
857
|
"type": "option"
|
|
776
858
|
},
|
|
777
|
-
"
|
|
778
|
-
"
|
|
779
|
-
"
|
|
859
|
+
"force-overwrite": {
|
|
860
|
+
"name": "force-overwrite",
|
|
861
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
862
|
+
"allowNo": false,
|
|
863
|
+
"type": "boolean"
|
|
864
|
+
},
|
|
865
|
+
"output-file": {
|
|
866
|
+
"char": "f",
|
|
867
|
+
"name": "output-file",
|
|
868
|
+
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
780
869
|
"hasDynamicHelp": false,
|
|
781
870
|
"multiple": false,
|
|
782
871
|
"type": "option"
|
|
783
872
|
},
|
|
784
|
-
"
|
|
785
|
-
"
|
|
786
|
-
"
|
|
873
|
+
"test-runner": {
|
|
874
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
875
|
+
"name": "test-runner",
|
|
876
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
787
877
|
"hasDynamicHelp": false,
|
|
788
878
|
"multiple": false,
|
|
789
879
|
"options": [
|
|
790
|
-
"
|
|
791
|
-
"
|
|
792
|
-
"retriever"
|
|
880
|
+
"agentforce-studio",
|
|
881
|
+
"testing-center"
|
|
793
882
|
],
|
|
794
883
|
"type": "option"
|
|
795
884
|
}
|
|
796
885
|
},
|
|
797
|
-
"hasDynamicHelp":
|
|
886
|
+
"hasDynamicHelp": false,
|
|
798
887
|
"hiddenAliases": [],
|
|
799
|
-
"id": "agent:
|
|
888
|
+
"id": "agent:generate:test-spec",
|
|
800
889
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
801
890
|
"pluginName": "@salesforce/plugin-agent",
|
|
802
891
|
"pluginType": "core",
|
|
803
892
|
"strict": true,
|
|
804
|
-
"summary": "
|
|
805
|
-
"enableJsonFlag":
|
|
893
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
894
|
+
"enableJsonFlag": false,
|
|
806
895
|
"isESM": true,
|
|
807
896
|
"relativePath": [
|
|
808
897
|
"lib",
|
|
809
898
|
"commands",
|
|
810
899
|
"agent",
|
|
811
|
-
"
|
|
812
|
-
"
|
|
900
|
+
"generate",
|
|
901
|
+
"test-spec.js"
|
|
813
902
|
],
|
|
814
903
|
"aliasPermutations": [],
|
|
815
904
|
"permutations": [
|
|
816
|
-
"agent:
|
|
817
|
-
"
|
|
818
|
-
"
|
|
819
|
-
"agent:
|
|
820
|
-
"
|
|
821
|
-
"
|
|
905
|
+
"agent:generate:test-spec",
|
|
906
|
+
"generate:agent:test-spec",
|
|
907
|
+
"generate:test-spec:agent",
|
|
908
|
+
"agent:test-spec:generate",
|
|
909
|
+
"test-spec:agent:generate",
|
|
910
|
+
"test-spec:generate:agent"
|
|
822
911
|
]
|
|
823
912
|
},
|
|
824
|
-
"agent:adl:
|
|
913
|
+
"agent:adl:create": {
|
|
825
914
|
"aliases": [],
|
|
826
915
|
"args": {},
|
|
827
|
-
"description": "
|
|
916
|
+
"description": "Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).\n\nFor SFDRIVE libraries, creation provisions the full Data Cloud pipeline (DLO → DMO → SearchIndex → Retriever). Upload files with `sf agent adl upload` after creation.",
|
|
828
917
|
"examples": [
|
|
829
|
-
"
|
|
918
|
+
"Create an SFDRIVE library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"My Docs\" --developer-name My_Docs --source-type sfdrive",
|
|
919
|
+
"Create a KNOWLEDGE library with index fields:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"KB Library\" --developer-name KB_Library --source-type knowledge --primary-index-field1 Title --primary-index-field2 Summary",
|
|
920
|
+
"Create a RETRIEVER library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"Existing Retriever\" --developer-name Existing_Retriever --source-type retriever --retriever-id 0ppXX0000000001"
|
|
830
921
|
],
|
|
831
922
|
"flags": {
|
|
832
923
|
"json": {
|
|
@@ -861,30 +952,113 @@
|
|
|
861
952
|
"multiple": false,
|
|
862
953
|
"type": "option"
|
|
863
954
|
},
|
|
864
|
-
"
|
|
865
|
-
"char": "
|
|
866
|
-
"name": "
|
|
955
|
+
"name": {
|
|
956
|
+
"char": "n",
|
|
957
|
+
"name": "name",
|
|
867
958
|
"required": true,
|
|
868
|
-
"summary": "
|
|
959
|
+
"summary": "Display name for the data library (max 80 characters).",
|
|
869
960
|
"hasDynamicHelp": false,
|
|
870
961
|
"multiple": false,
|
|
871
962
|
"type": "option"
|
|
872
963
|
},
|
|
873
|
-
"
|
|
874
|
-
"name": "
|
|
875
|
-
"
|
|
876
|
-
"
|
|
877
|
-
"
|
|
964
|
+
"developer-name": {
|
|
965
|
+
"name": "developer-name",
|
|
966
|
+
"required": true,
|
|
967
|
+
"summary": "API name for the data library (max 80 characters, alphanumeric and underscores only, must start with a letter).",
|
|
968
|
+
"hasDynamicHelp": false,
|
|
969
|
+
"multiple": false,
|
|
970
|
+
"type": "option"
|
|
971
|
+
},
|
|
972
|
+
"source-type": {
|
|
973
|
+
"name": "source-type",
|
|
974
|
+
"required": true,
|
|
975
|
+
"summary": "Type of grounding source: sfdrive (file upload), knowledge (Salesforce Knowledge articles), or retriever (existing active Custom Retriever).",
|
|
976
|
+
"hasDynamicHelp": false,
|
|
977
|
+
"multiple": false,
|
|
978
|
+
"options": [
|
|
979
|
+
"sfdrive",
|
|
980
|
+
"knowledge",
|
|
981
|
+
"retriever"
|
|
982
|
+
],
|
|
983
|
+
"type": "option"
|
|
984
|
+
},
|
|
985
|
+
"description": {
|
|
986
|
+
"name": "description",
|
|
987
|
+
"summary": "Description of the data library (max 255 characters).",
|
|
988
|
+
"hasDynamicHelp": false,
|
|
989
|
+
"multiple": false,
|
|
990
|
+
"type": "option"
|
|
991
|
+
},
|
|
992
|
+
"index-mode": {
|
|
993
|
+
"name": "index-mode",
|
|
994
|
+
"summary": "Index mode for SFDRIVE libraries: basic or enhanced.",
|
|
995
|
+
"hasDynamicHelp": false,
|
|
996
|
+
"multiple": false,
|
|
997
|
+
"options": [
|
|
998
|
+
"basic",
|
|
999
|
+
"enhanced"
|
|
1000
|
+
],
|
|
1001
|
+
"type": "option"
|
|
1002
|
+
},
|
|
1003
|
+
"retriever-id": {
|
|
1004
|
+
"name": "retriever-id",
|
|
1005
|
+
"summary": "ID of an active Custom Retriever (required for RETRIEVER source type; retriever must be active).",
|
|
1006
|
+
"hasDynamicHelp": false,
|
|
1007
|
+
"multiple": false,
|
|
1008
|
+
"type": "option"
|
|
1009
|
+
},
|
|
1010
|
+
"primary-index-field1": {
|
|
1011
|
+
"name": "primary-index-field1",
|
|
1012
|
+
"summary": "Primary index field 1 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
1013
|
+
"hasDynamicHelp": false,
|
|
1014
|
+
"multiple": false,
|
|
1015
|
+
"type": "option"
|
|
1016
|
+
},
|
|
1017
|
+
"primary-index-field2": {
|
|
1018
|
+
"name": "primary-index-field2",
|
|
1019
|
+
"summary": "Primary index field 2 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
1020
|
+
"hasDynamicHelp": false,
|
|
1021
|
+
"multiple": false,
|
|
1022
|
+
"type": "option"
|
|
1023
|
+
},
|
|
1024
|
+
"content-fields": {
|
|
1025
|
+
"name": "content-fields",
|
|
1026
|
+
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (optional, mutable after creation).",
|
|
1027
|
+
"hasDynamicHelp": false,
|
|
1028
|
+
"multiple": false,
|
|
1029
|
+
"type": "option"
|
|
1030
|
+
},
|
|
1031
|
+
"data-category-ids": {
|
|
1032
|
+
"name": "data-category-ids",
|
|
1033
|
+
"summary": "Comma-separated list of data category selection IDs for KNOWLEDGE libraries. Mutually exclusive with --data-category-names (provide one or the other, not both).",
|
|
1034
|
+
"hasDynamicHelp": false,
|
|
1035
|
+
"multiple": false,
|
|
1036
|
+
"type": "option"
|
|
1037
|
+
},
|
|
1038
|
+
"data-category-names": {
|
|
1039
|
+
"name": "data-category-names",
|
|
1040
|
+
"summary": "Comma-separated list of data category names in qualified format (e.g., \"Group_API_Name.Category\"). Mutually exclusive with --data-category-ids (provide one or the other, not both).",
|
|
1041
|
+
"hasDynamicHelp": false,
|
|
1042
|
+
"multiple": false,
|
|
1043
|
+
"type": "option"
|
|
1044
|
+
},
|
|
1045
|
+
"wait": {
|
|
1046
|
+
"char": "w",
|
|
1047
|
+
"name": "wait",
|
|
1048
|
+
"summary": "Wait N minutes for indexing to complete (KNOWLEDGE libraries). SFDRIVE libraries require upload before indexing; RETRIEVER libraries are ready immediately.",
|
|
1049
|
+
"hasDynamicHelp": true,
|
|
1050
|
+
"multiple": false,
|
|
1051
|
+
"type": "option"
|
|
878
1052
|
}
|
|
879
1053
|
},
|
|
880
1054
|
"hasDynamicHelp": true,
|
|
881
1055
|
"hiddenAliases": [],
|
|
882
|
-
"id": "agent:adl:
|
|
1056
|
+
"id": "agent:adl:create",
|
|
883
1057
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
884
1058
|
"pluginName": "@salesforce/plugin-agent",
|
|
885
1059
|
"pluginType": "core",
|
|
886
1060
|
"strict": true,
|
|
887
|
-
"summary": "
|
|
1061
|
+
"summary": "Create an Agentforce Data Library.",
|
|
888
1062
|
"enableJsonFlag": true,
|
|
889
1063
|
"isESM": true,
|
|
890
1064
|
"relativePath": [
|
|
@@ -892,27 +1066,24 @@
|
|
|
892
1066
|
"commands",
|
|
893
1067
|
"agent",
|
|
894
1068
|
"adl",
|
|
895
|
-
"
|
|
1069
|
+
"create.js"
|
|
896
1070
|
],
|
|
897
1071
|
"aliasPermutations": [],
|
|
898
1072
|
"permutations": [
|
|
899
|
-
"agent:adl:
|
|
900
|
-
"adl:agent:
|
|
901
|
-
"adl:
|
|
902
|
-
"agent:
|
|
903
|
-
"
|
|
904
|
-
"
|
|
1073
|
+
"agent:adl:create",
|
|
1074
|
+
"adl:agent:create",
|
|
1075
|
+
"adl:create:agent",
|
|
1076
|
+
"agent:create:adl",
|
|
1077
|
+
"create:agent:adl",
|
|
1078
|
+
"create:adl:agent"
|
|
905
1079
|
]
|
|
906
1080
|
},
|
|
907
|
-
"agent:adl:
|
|
1081
|
+
"agent:adl:delete": {
|
|
908
1082
|
"aliases": [],
|
|
909
1083
|
"args": {},
|
|
910
|
-
"description": "
|
|
1084
|
+
"description": "Permanently deletes a data library and all associated files and indexing data.",
|
|
911
1085
|
"examples": [
|
|
912
|
-
"
|
|
913
|
-
"Update the description:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --description \"Updated description\" --target-org myOrg",
|
|
914
|
-
"Update Knowledge library content fields (triggers re-indexing):\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --content-fields \"Answer**c,Summary**c\" --target-org myOrg",
|
|
915
|
-
"Restrict Knowledge library to public articles:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg"
|
|
1086
|
+
"Delete a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
916
1087
|
],
|
|
917
1088
|
"flags": {
|
|
918
1089
|
"json": {
|
|
@@ -947,52 +1118,11 @@
|
|
|
947
1118
|
"multiple": false,
|
|
948
1119
|
"type": "option"
|
|
949
1120
|
},
|
|
950
|
-
"library-id": {
|
|
951
|
-
"char": "i",
|
|
952
|
-
"name": "library-id",
|
|
953
|
-
"required": true,
|
|
954
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
955
|
-
"hasDynamicHelp": false,
|
|
956
|
-
"multiple": false,
|
|
957
|
-
"type": "option"
|
|
958
|
-
},
|
|
959
|
-
"name": {
|
|
960
|
-
"char": "n",
|
|
961
|
-
"name": "name",
|
|
962
|
-
"summary": "New display name for the data library (max 80 characters).",
|
|
963
|
-
"hasDynamicHelp": false,
|
|
964
|
-
"multiple": false,
|
|
965
|
-
"type": "option"
|
|
966
|
-
},
|
|
967
|
-
"description": {
|
|
968
|
-
"name": "description",
|
|
969
|
-
"summary": "New description for the data library (max 255 characters).",
|
|
970
|
-
"hasDynamicHelp": false,
|
|
971
|
-
"multiple": false,
|
|
972
|
-
"type": "option"
|
|
973
|
-
},
|
|
974
|
-
"content-fields": {
|
|
975
|
-
"name": "content-fields",
|
|
976
|
-
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (triggers re-indexing).",
|
|
977
|
-
"hasDynamicHelp": false,
|
|
978
|
-
"multiple": false,
|
|
979
|
-
"type": "option"
|
|
980
|
-
},
|
|
981
|
-
"restrict-to-public-articles": {
|
|
982
|
-
"name": "restrict-to-public-articles",
|
|
983
|
-
"summary": "Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers re-indexing).",
|
|
984
|
-
"allowNo": true,
|
|
985
|
-
"type": "boolean"
|
|
986
|
-
},
|
|
987
|
-
"data-category-rule": {
|
|
988
|
-
"name": "data-category-rule",
|
|
989
|
-
"summary": "Enable or disable data category filtering for KNOWLEDGE libraries. Use --no-data-category-rule to disable.",
|
|
990
|
-
"allowNo": true,
|
|
991
|
-
"type": "boolean"
|
|
992
|
-
},
|
|
993
|
-
"retriever-id": {
|
|
994
|
-
"name": "retriever-id",
|
|
995
|
-
"summary": "Swap the retriever for a RETRIEVER library (must be an active Custom Retriever ID).",
|
|
1121
|
+
"library-id": {
|
|
1122
|
+
"char": "i",
|
|
1123
|
+
"name": "library-id",
|
|
1124
|
+
"required": true,
|
|
1125
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
996
1126
|
"hasDynamicHelp": false,
|
|
997
1127
|
"multiple": false,
|
|
998
1128
|
"type": "option"
|
|
@@ -1000,12 +1130,12 @@
|
|
|
1000
1130
|
},
|
|
1001
1131
|
"hasDynamicHelp": true,
|
|
1002
1132
|
"hiddenAliases": [],
|
|
1003
|
-
"id": "agent:adl:
|
|
1133
|
+
"id": "agent:adl:delete",
|
|
1004
1134
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1005
1135
|
"pluginName": "@salesforce/plugin-agent",
|
|
1006
1136
|
"pluginType": "core",
|
|
1007
1137
|
"strict": true,
|
|
1008
|
-
"summary": "
|
|
1138
|
+
"summary": "Delete an Agentforce Data Library.",
|
|
1009
1139
|
"enableJsonFlag": true,
|
|
1010
1140
|
"isESM": true,
|
|
1011
1141
|
"relativePath": [
|
|
@@ -1013,25 +1143,24 @@
|
|
|
1013
1143
|
"commands",
|
|
1014
1144
|
"agent",
|
|
1015
1145
|
"adl",
|
|
1016
|
-
"
|
|
1146
|
+
"delete.js"
|
|
1017
1147
|
],
|
|
1018
1148
|
"aliasPermutations": [],
|
|
1019
1149
|
"permutations": [
|
|
1020
|
-
"agent:adl:
|
|
1021
|
-
"adl:agent:
|
|
1022
|
-
"adl:
|
|
1023
|
-
"agent:
|
|
1024
|
-
"
|
|
1025
|
-
"
|
|
1150
|
+
"agent:adl:delete",
|
|
1151
|
+
"adl:agent:delete",
|
|
1152
|
+
"adl:delete:agent",
|
|
1153
|
+
"agent:delete:adl",
|
|
1154
|
+
"delete:agent:adl",
|
|
1155
|
+
"delete:adl:agent"
|
|
1026
1156
|
]
|
|
1027
1157
|
},
|
|
1028
|
-
"agent:adl:
|
|
1158
|
+
"agent:adl:get": {
|
|
1029
1159
|
"aliases": [],
|
|
1030
1160
|
"args": {},
|
|
1031
|
-
"description": "
|
|
1161
|
+
"description": "Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.",
|
|
1032
1162
|
"examples": [
|
|
1033
|
-
"
|
|
1034
|
-
"Upload a file without waiting:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg"
|
|
1163
|
+
"Get details of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
1035
1164
|
],
|
|
1036
1165
|
"flags": {
|
|
1037
1166
|
"json": {
|
|
@@ -1074,33 +1203,16 @@
|
|
|
1074
1203
|
"hasDynamicHelp": false,
|
|
1075
1204
|
"multiple": false,
|
|
1076
1205
|
"type": "option"
|
|
1077
|
-
},
|
|
1078
|
-
"file": {
|
|
1079
|
-
"char": "f",
|
|
1080
|
-
"name": "file",
|
|
1081
|
-
"required": true,
|
|
1082
|
-
"summary": "Path to the file to upload.",
|
|
1083
|
-
"hasDynamicHelp": false,
|
|
1084
|
-
"multiple": true,
|
|
1085
|
-
"type": "option"
|
|
1086
|
-
},
|
|
1087
|
-
"wait": {
|
|
1088
|
-
"char": "w",
|
|
1089
|
-
"name": "wait",
|
|
1090
|
-
"summary": "Number of minutes to wait for indexing to complete. If not specified, returns after triggering indexing.",
|
|
1091
|
-
"hasDynamicHelp": true,
|
|
1092
|
-
"multiple": false,
|
|
1093
|
-
"type": "option"
|
|
1094
1206
|
}
|
|
1095
1207
|
},
|
|
1096
1208
|
"hasDynamicHelp": true,
|
|
1097
1209
|
"hiddenAliases": [],
|
|
1098
|
-
"id": "agent:adl:
|
|
1210
|
+
"id": "agent:adl:get",
|
|
1099
1211
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1100
1212
|
"pluginName": "@salesforce/plugin-agent",
|
|
1101
1213
|
"pluginType": "core",
|
|
1102
1214
|
"strict": true,
|
|
1103
|
-
"summary": "
|
|
1215
|
+
"summary": "Get details of an Agentforce Data Library.",
|
|
1104
1216
|
"enableJsonFlag": true,
|
|
1105
1217
|
"isESM": true,
|
|
1106
1218
|
"relativePath": [
|
|
@@ -1108,28 +1220,25 @@
|
|
|
1108
1220
|
"commands",
|
|
1109
1221
|
"agent",
|
|
1110
1222
|
"adl",
|
|
1111
|
-
"
|
|
1223
|
+
"get.js"
|
|
1112
1224
|
],
|
|
1113
1225
|
"aliasPermutations": [],
|
|
1114
1226
|
"permutations": [
|
|
1115
|
-
"agent:adl:
|
|
1116
|
-
"adl:agent:
|
|
1117
|
-
"adl:
|
|
1118
|
-
"agent:
|
|
1119
|
-
"
|
|
1120
|
-
"
|
|
1227
|
+
"agent:adl:get",
|
|
1228
|
+
"adl:agent:get",
|
|
1229
|
+
"adl:get:agent",
|
|
1230
|
+
"agent:get:adl",
|
|
1231
|
+
"get:agent:adl",
|
|
1232
|
+
"get:adl:agent"
|
|
1121
1233
|
]
|
|
1122
1234
|
},
|
|
1123
|
-
"agent:
|
|
1235
|
+
"agent:adl:list": {
|
|
1124
1236
|
"aliases": [],
|
|
1125
1237
|
"args": {},
|
|
1126
|
-
"description": "
|
|
1238
|
+
"description": "Returns all data libraries in the target org, including their source type, status, and library ID.",
|
|
1127
1239
|
"examples": [
|
|
1128
|
-
"
|
|
1129
|
-
"
|
|
1130
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1131
|
-
"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\"",
|
|
1132
|
-
"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"
|
|
1240
|
+
"List all data libraries in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1241
|
+
"List data libraries and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --json"
|
|
1133
1242
|
],
|
|
1134
1243
|
"flags": {
|
|
1135
1244
|
"json": {
|
|
@@ -1164,164 +1273,52 @@
|
|
|
1164
1273
|
"multiple": false,
|
|
1165
1274
|
"type": "option"
|
|
1166
1275
|
},
|
|
1167
|
-
"type": {
|
|
1168
|
-
"name": "type",
|
|
1169
|
-
"summary": "
|
|
1170
|
-
"hasDynamicHelp": false,
|
|
1171
|
-
"multiple": false,
|
|
1172
|
-
"options": [
|
|
1173
|
-
"customer",
|
|
1174
|
-
"internal"
|
|
1175
|
-
],
|
|
1176
|
-
"type": "option"
|
|
1177
|
-
},
|
|
1178
|
-
"role": {
|
|
1179
|
-
"name": "role",
|
|
1180
|
-
"summary": "Role of the agent.",
|
|
1181
|
-
"hasDynamicHelp": false,
|
|
1182
|
-
"multiple": false,
|
|
1183
|
-
"type": "option"
|
|
1184
|
-
},
|
|
1185
|
-
"company-name": {
|
|
1186
|
-
"name": "company-name",
|
|
1187
|
-
"summary": "Name of your company.",
|
|
1188
|
-
"hasDynamicHelp": false,
|
|
1189
|
-
"multiple": false,
|
|
1190
|
-
"type": "option"
|
|
1191
|
-
},
|
|
1192
|
-
"company-description": {
|
|
1193
|
-
"name": "company-description",
|
|
1194
|
-
"summary": "Description of your company.",
|
|
1195
|
-
"hasDynamicHelp": false,
|
|
1196
|
-
"multiple": false,
|
|
1197
|
-
"type": "option"
|
|
1198
|
-
},
|
|
1199
|
-
"company-website": {
|
|
1200
|
-
"name": "company-website",
|
|
1201
|
-
"summary": "Website URL of your company.",
|
|
1202
|
-
"hasDynamicHelp": false,
|
|
1203
|
-
"multiple": false,
|
|
1204
|
-
"type": "option"
|
|
1205
|
-
},
|
|
1206
|
-
"max-topics": {
|
|
1207
|
-
"name": "max-topics",
|
|
1208
|
-
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1209
|
-
"hasDynamicHelp": false,
|
|
1210
|
-
"multiple": false,
|
|
1211
|
-
"type": "option"
|
|
1212
|
-
},
|
|
1213
|
-
"agent-user": {
|
|
1214
|
-
"name": "agent-user",
|
|
1215
|
-
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1216
|
-
"hasDynamicHelp": false,
|
|
1217
|
-
"multiple": false,
|
|
1218
|
-
"type": "option"
|
|
1219
|
-
},
|
|
1220
|
-
"enrich-logs": {
|
|
1221
|
-
"name": "enrich-logs",
|
|
1222
|
-
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1223
|
-
"hasDynamicHelp": false,
|
|
1224
|
-
"multiple": false,
|
|
1225
|
-
"options": [
|
|
1226
|
-
"true",
|
|
1227
|
-
"false"
|
|
1228
|
-
],
|
|
1229
|
-
"type": "option"
|
|
1230
|
-
},
|
|
1231
|
-
"tone": {
|
|
1232
|
-
"name": "tone",
|
|
1233
|
-
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1276
|
+
"source-type": {
|
|
1277
|
+
"name": "source-type",
|
|
1278
|
+
"summary": "Filter by source type: sfdrive, knowledge, or retriever.",
|
|
1234
1279
|
"hasDynamicHelp": false,
|
|
1235
1280
|
"multiple": false,
|
|
1236
1281
|
"options": [
|
|
1237
|
-
"
|
|
1238
|
-
"
|
|
1239
|
-
"
|
|
1240
|
-
],
|
|
1241
|
-
"type": "option"
|
|
1242
|
-
},
|
|
1243
|
-
"spec": {
|
|
1244
|
-
"name": "spec",
|
|
1245
|
-
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1246
|
-
"hasDynamicHelp": false,
|
|
1247
|
-
"multiple": false,
|
|
1248
|
-
"type": "option"
|
|
1249
|
-
},
|
|
1250
|
-
"output-file": {
|
|
1251
|
-
"name": "output-file",
|
|
1252
|
-
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1253
|
-
"default": "specs/agentSpec.yaml",
|
|
1254
|
-
"hasDynamicHelp": false,
|
|
1255
|
-
"multiple": false,
|
|
1256
|
-
"type": "option"
|
|
1257
|
-
},
|
|
1258
|
-
"full-interview": {
|
|
1259
|
-
"name": "full-interview",
|
|
1260
|
-
"summary": "Prompt for both required and optional flags.",
|
|
1261
|
-
"allowNo": false,
|
|
1262
|
-
"type": "boolean"
|
|
1263
|
-
},
|
|
1264
|
-
"prompt-template": {
|
|
1265
|
-
"name": "prompt-template",
|
|
1266
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1267
|
-
"hasDynamicHelp": false,
|
|
1268
|
-
"multiple": false,
|
|
1269
|
-
"type": "option"
|
|
1270
|
-
},
|
|
1271
|
-
"grounding-context": {
|
|
1272
|
-
"dependsOn": [
|
|
1273
|
-
"prompt-template"
|
|
1282
|
+
"sfdrive",
|
|
1283
|
+
"knowledge",
|
|
1284
|
+
"retriever"
|
|
1274
1285
|
],
|
|
1275
|
-
"name": "grounding-context",
|
|
1276
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1277
|
-
"hasDynamicHelp": false,
|
|
1278
|
-
"multiple": false,
|
|
1279
1286
|
"type": "option"
|
|
1280
|
-
},
|
|
1281
|
-
"force-overwrite": {
|
|
1282
|
-
"name": "force-overwrite",
|
|
1283
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1284
|
-
"allowNo": false,
|
|
1285
|
-
"type": "boolean"
|
|
1286
1287
|
}
|
|
1287
1288
|
},
|
|
1288
1289
|
"hasDynamicHelp": true,
|
|
1289
1290
|
"hiddenAliases": [],
|
|
1290
|
-
"id": "agent:
|
|
1291
|
+
"id": "agent:adl:list",
|
|
1291
1292
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1292
1293
|
"pluginName": "@salesforce/plugin-agent",
|
|
1293
1294
|
"pluginType": "core",
|
|
1294
1295
|
"strict": true,
|
|
1295
|
-
"summary": "
|
|
1296
|
+
"summary": "List Agentforce Data Libraries in an org.",
|
|
1296
1297
|
"enableJsonFlag": true,
|
|
1297
|
-
"requiresProject": true,
|
|
1298
1298
|
"isESM": true,
|
|
1299
1299
|
"relativePath": [
|
|
1300
1300
|
"lib",
|
|
1301
1301
|
"commands",
|
|
1302
1302
|
"agent",
|
|
1303
|
-
"
|
|
1304
|
-
"
|
|
1303
|
+
"adl",
|
|
1304
|
+
"list.js"
|
|
1305
1305
|
],
|
|
1306
1306
|
"aliasPermutations": [],
|
|
1307
1307
|
"permutations": [
|
|
1308
|
-
"agent:
|
|
1309
|
-
"
|
|
1310
|
-
"
|
|
1311
|
-
"agent:
|
|
1312
|
-
"
|
|
1313
|
-
"
|
|
1308
|
+
"agent:adl:list",
|
|
1309
|
+
"adl:agent:list",
|
|
1310
|
+
"adl:list:agent",
|
|
1311
|
+
"agent:list:adl",
|
|
1312
|
+
"list:agent:adl",
|
|
1313
|
+
"list:adl:agent"
|
|
1314
1314
|
]
|
|
1315
1315
|
},
|
|
1316
|
-
"agent:
|
|
1316
|
+
"agent:adl:status": {
|
|
1317
1317
|
"aliases": [],
|
|
1318
1318
|
"args": {},
|
|
1319
|
-
"description": "
|
|
1319
|
+
"description": "Returns the current indexing status including stage details (DATA_STREAM, DATA_LAKE_OBJECT, DATA_MODEL_OBJECT, SEARCH_INDEX, RETRIEVER) and any errors.",
|
|
1320
1320
|
"examples": [
|
|
1321
|
-
"
|
|
1322
|
-
"Generate an authoring bundle without using an agent spec file; give the bundle the label \"My Authoring Bundle\" and use your default org:\n<%= config.bin %> <%= command.id %> --no-spec --name \"My Authoring Bundle\"",
|
|
1323
|
-
"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\"",
|
|
1324
|
-
"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"
|
|
1321
|
+
"Get status of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
1325
1322
|
],
|
|
1326
1323
|
"flags": {
|
|
1327
1324
|
"json": {
|
|
@@ -1332,108 +1329,82 @@
|
|
|
1332
1329
|
"type": "boolean"
|
|
1333
1330
|
},
|
|
1334
1331
|
"flags-dir": {
|
|
1335
|
-
"helpGroup": "GLOBAL",
|
|
1336
|
-
"name": "flags-dir",
|
|
1337
|
-
"summary": "Import flag values from a directory.",
|
|
1338
|
-
"hasDynamicHelp": false,
|
|
1339
|
-
"multiple": false,
|
|
1340
|
-
"type": "option"
|
|
1341
|
-
},
|
|
1342
|
-
"target-org": {
|
|
1343
|
-
"char": "o",
|
|
1344
|
-
"name": "target-org",
|
|
1345
|
-
"noCacheDefault": true,
|
|
1346
|
-
"required": true,
|
|
1347
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1348
|
-
"hasDynamicHelp": true,
|
|
1349
|
-
"multiple": false,
|
|
1350
|
-
"type": "option"
|
|
1351
|
-
},
|
|
1352
|
-
"api-name": {
|
|
1353
|
-
"name": "api-name",
|
|
1354
|
-
"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.",
|
|
1355
|
-
"hasDynamicHelp": false,
|
|
1356
|
-
"multiple": false,
|
|
1357
|
-
"type": "option"
|
|
1358
|
-
},
|
|
1359
|
-
"api-version": {
|
|
1360
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1361
|
-
"name": "api-version",
|
|
1332
|
+
"helpGroup": "GLOBAL",
|
|
1333
|
+
"name": "flags-dir",
|
|
1334
|
+
"summary": "Import flag values from a directory.",
|
|
1362
1335
|
"hasDynamicHelp": false,
|
|
1363
1336
|
"multiple": false,
|
|
1364
1337
|
"type": "option"
|
|
1365
1338
|
},
|
|
1366
|
-
"
|
|
1367
|
-
"char": "
|
|
1368
|
-
"name": "
|
|
1369
|
-
"
|
|
1370
|
-
"
|
|
1339
|
+
"target-org": {
|
|
1340
|
+
"char": "o",
|
|
1341
|
+
"name": "target-org",
|
|
1342
|
+
"noCacheDefault": true,
|
|
1343
|
+
"required": true,
|
|
1344
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1345
|
+
"hasDynamicHelp": true,
|
|
1371
1346
|
"multiple": false,
|
|
1372
1347
|
"type": "option"
|
|
1373
1348
|
},
|
|
1374
|
-
"
|
|
1375
|
-
"
|
|
1376
|
-
"
|
|
1377
|
-
"allowNo": false,
|
|
1378
|
-
"type": "boolean"
|
|
1379
|
-
},
|
|
1380
|
-
"output-dir": {
|
|
1381
|
-
"char": "d",
|
|
1382
|
-
"name": "output-dir",
|
|
1383
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
1349
|
+
"api-version": {
|
|
1350
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1351
|
+
"name": "api-version",
|
|
1384
1352
|
"hasDynamicHelp": false,
|
|
1385
1353
|
"multiple": false,
|
|
1386
1354
|
"type": "option"
|
|
1387
1355
|
},
|
|
1388
|
-
"
|
|
1389
|
-
"char": "
|
|
1390
|
-
"name": "
|
|
1391
|
-
"
|
|
1356
|
+
"library-id": {
|
|
1357
|
+
"char": "i",
|
|
1358
|
+
"name": "library-id",
|
|
1359
|
+
"required": true,
|
|
1360
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
1392
1361
|
"hasDynamicHelp": false,
|
|
1393
1362
|
"multiple": false,
|
|
1394
1363
|
"type": "option"
|
|
1395
1364
|
},
|
|
1396
|
-
"
|
|
1397
|
-
"name": "
|
|
1398
|
-
"summary": "
|
|
1365
|
+
"include-artifacts": {
|
|
1366
|
+
"name": "include-artifacts",
|
|
1367
|
+
"summary": "Resolve DC asset artifacts (DataStream, DLO, DMO, SearchIndex, Retriever) with entity IDs and names on each stage. Slower — requires additional queries.",
|
|
1399
1368
|
"allowNo": false,
|
|
1400
1369
|
"type": "boolean"
|
|
1401
1370
|
}
|
|
1402
1371
|
},
|
|
1403
1372
|
"hasDynamicHelp": true,
|
|
1404
1373
|
"hiddenAliases": [],
|
|
1405
|
-
"id": "agent:
|
|
1374
|
+
"id": "agent:adl:status",
|
|
1406
1375
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1407
1376
|
"pluginName": "@salesforce/plugin-agent",
|
|
1408
1377
|
"pluginType": "core",
|
|
1409
1378
|
"strict": true,
|
|
1410
|
-
"summary": "
|
|
1379
|
+
"summary": "Get indexing status of an Agentforce Data Library.",
|
|
1411
1380
|
"enableJsonFlag": true,
|
|
1412
|
-
"requiresProject": true,
|
|
1413
1381
|
"isESM": true,
|
|
1414
1382
|
"relativePath": [
|
|
1415
1383
|
"lib",
|
|
1416
1384
|
"commands",
|
|
1417
1385
|
"agent",
|
|
1418
|
-
"
|
|
1419
|
-
"
|
|
1386
|
+
"adl",
|
|
1387
|
+
"status.js"
|
|
1420
1388
|
],
|
|
1421
1389
|
"aliasPermutations": [],
|
|
1422
1390
|
"permutations": [
|
|
1423
|
-
"agent:
|
|
1424
|
-
"
|
|
1425
|
-
"
|
|
1426
|
-
"agent:
|
|
1427
|
-
"
|
|
1428
|
-
"
|
|
1391
|
+
"agent:adl:status",
|
|
1392
|
+
"adl:agent:status",
|
|
1393
|
+
"adl:status:agent",
|
|
1394
|
+
"agent:status:adl",
|
|
1395
|
+
"status:agent:adl",
|
|
1396
|
+
"status:adl:agent"
|
|
1429
1397
|
]
|
|
1430
1398
|
},
|
|
1431
|
-
"agent:
|
|
1399
|
+
"agent:adl:update": {
|
|
1432
1400
|
"aliases": [],
|
|
1433
1401
|
"args": {},
|
|
1434
|
-
"description": "
|
|
1402
|
+
"description": "Updates the label, description, or other mutable properties of an existing data library.",
|
|
1435
1403
|
"examples": [
|
|
1436
|
-
"
|
|
1404
|
+
"Update the label of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --name \"New Name\" --target-org myOrg",
|
|
1405
|
+
"Update the description:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --description \"Updated description\" --target-org myOrg",
|
|
1406
|
+
"Update Knowledge library content fields (triggers re-indexing):\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --content-fields \"Answer**c,Summary**c\" --target-org myOrg",
|
|
1407
|
+
"Restrict Knowledge library to public articles:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg"
|
|
1437
1408
|
],
|
|
1438
1409
|
"flags": {
|
|
1439
1410
|
"json": {
|
|
@@ -1451,6 +1422,16 @@
|
|
|
1451
1422
|
"multiple": false,
|
|
1452
1423
|
"type": "option"
|
|
1453
1424
|
},
|
|
1425
|
+
"target-org": {
|
|
1426
|
+
"char": "o",
|
|
1427
|
+
"name": "target-org",
|
|
1428
|
+
"noCacheDefault": true,
|
|
1429
|
+
"required": true,
|
|
1430
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1431
|
+
"hasDynamicHelp": true,
|
|
1432
|
+
"multiple": false,
|
|
1433
|
+
"type": "option"
|
|
1434
|
+
},
|
|
1454
1435
|
"api-version": {
|
|
1455
1436
|
"description": "Override the api version used for api requests made by this command",
|
|
1456
1437
|
"name": "api-version",
|
|
@@ -1458,37 +1439,52 @@
|
|
|
1458
1439
|
"multiple": false,
|
|
1459
1440
|
"type": "option"
|
|
1460
1441
|
},
|
|
1461
|
-
"
|
|
1462
|
-
"char": "
|
|
1463
|
-
"name": "
|
|
1464
|
-
"noCacheDefault": true,
|
|
1442
|
+
"library-id": {
|
|
1443
|
+
"char": "i",
|
|
1444
|
+
"name": "library-id",
|
|
1465
1445
|
"required": true,
|
|
1466
|
-
"summary": "
|
|
1467
|
-
"hasDynamicHelp":
|
|
1446
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
1447
|
+
"hasDynamicHelp": false,
|
|
1468
1448
|
"multiple": false,
|
|
1469
1449
|
"type": "option"
|
|
1470
1450
|
},
|
|
1471
|
-
"
|
|
1472
|
-
"
|
|
1473
|
-
"
|
|
1474
|
-
"summary": "
|
|
1451
|
+
"name": {
|
|
1452
|
+
"char": "n",
|
|
1453
|
+
"name": "name",
|
|
1454
|
+
"summary": "New display name for the data library (max 80 characters).",
|
|
1475
1455
|
"hasDynamicHelp": false,
|
|
1476
1456
|
"multiple": false,
|
|
1477
1457
|
"type": "option"
|
|
1478
1458
|
},
|
|
1479
|
-
"
|
|
1480
|
-
"
|
|
1481
|
-
"
|
|
1482
|
-
"required": true,
|
|
1483
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
1459
|
+
"description": {
|
|
1460
|
+
"name": "description",
|
|
1461
|
+
"summary": "New description for the data library (max 255 characters).",
|
|
1484
1462
|
"hasDynamicHelp": false,
|
|
1485
1463
|
"multiple": false,
|
|
1486
1464
|
"type": "option"
|
|
1487
1465
|
},
|
|
1488
|
-
"
|
|
1489
|
-
"
|
|
1490
|
-
"
|
|
1491
|
-
"
|
|
1466
|
+
"content-fields": {
|
|
1467
|
+
"name": "content-fields",
|
|
1468
|
+
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (triggers re-indexing).",
|
|
1469
|
+
"hasDynamicHelp": false,
|
|
1470
|
+
"multiple": false,
|
|
1471
|
+
"type": "option"
|
|
1472
|
+
},
|
|
1473
|
+
"restrict-to-public-articles": {
|
|
1474
|
+
"name": "restrict-to-public-articles",
|
|
1475
|
+
"summary": "Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers re-indexing).",
|
|
1476
|
+
"allowNo": true,
|
|
1477
|
+
"type": "boolean"
|
|
1478
|
+
},
|
|
1479
|
+
"data-category-rule": {
|
|
1480
|
+
"name": "data-category-rule",
|
|
1481
|
+
"summary": "Enable or disable data category filtering for KNOWLEDGE libraries. Use --no-data-category-rule to disable.",
|
|
1482
|
+
"allowNo": true,
|
|
1483
|
+
"type": "boolean"
|
|
1484
|
+
},
|
|
1485
|
+
"retriever-id": {
|
|
1486
|
+
"name": "retriever-id",
|
|
1487
|
+
"summary": "Swap the retriever for a RETRIEVER library (must be an active Custom Retriever ID).",
|
|
1492
1488
|
"hasDynamicHelp": false,
|
|
1493
1489
|
"multiple": false,
|
|
1494
1490
|
"type": "option"
|
|
@@ -1496,44 +1492,47 @@
|
|
|
1496
1492
|
},
|
|
1497
1493
|
"hasDynamicHelp": true,
|
|
1498
1494
|
"hiddenAliases": [],
|
|
1499
|
-
"id": "agent:
|
|
1495
|
+
"id": "agent:adl:update",
|
|
1500
1496
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1501
1497
|
"pluginName": "@salesforce/plugin-agent",
|
|
1502
1498
|
"pluginType": "core",
|
|
1503
1499
|
"strict": true,
|
|
1504
|
-
"summary": "
|
|
1500
|
+
"summary": "Update an Agentforce Data Library.",
|
|
1505
1501
|
"enableJsonFlag": true,
|
|
1506
|
-
"requiresProject": true,
|
|
1507
1502
|
"isESM": true,
|
|
1508
1503
|
"relativePath": [
|
|
1509
1504
|
"lib",
|
|
1510
1505
|
"commands",
|
|
1511
1506
|
"agent",
|
|
1512
|
-
"
|
|
1513
|
-
"
|
|
1507
|
+
"adl",
|
|
1508
|
+
"update.js"
|
|
1514
1509
|
],
|
|
1515
1510
|
"aliasPermutations": [],
|
|
1516
1511
|
"permutations": [
|
|
1517
|
-
"agent:
|
|
1518
|
-
"
|
|
1519
|
-
"
|
|
1520
|
-
"agent:
|
|
1521
|
-
"
|
|
1522
|
-
"
|
|
1512
|
+
"agent:adl:update",
|
|
1513
|
+
"adl:agent:update",
|
|
1514
|
+
"adl:update:agent",
|
|
1515
|
+
"agent:update:adl",
|
|
1516
|
+
"update:agent:adl",
|
|
1517
|
+
"update:adl:agent"
|
|
1523
1518
|
]
|
|
1524
1519
|
},
|
|
1525
|
-
"agent:
|
|
1520
|
+
"agent:adl:upload": {
|
|
1526
1521
|
"aliases": [],
|
|
1527
1522
|
"args": {},
|
|
1528
|
-
"description": "
|
|
1523
|
+
"description": "Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file, triggers indexing, and optionally polls until the library is ready (retrieverId is populated).\n\nUpload triggers the full Data Cloud provisioning pipeline, creating all downstream assets (DLO, DMO, SearchIndex, Retriever). Use `sf agent adl status` to monitor progress. For adding files to an already-provisioned library, use `sf agent adl file add` instead.\n\nThis command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER libraries require no file upload.",
|
|
1529
1524
|
"examples": [
|
|
1530
|
-
"
|
|
1531
|
-
"
|
|
1532
|
-
"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",
|
|
1533
|
-
"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",
|
|
1534
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
1525
|
+
"Upload a file and wait for indexing to complete:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10",
|
|
1526
|
+
"Upload a file without waiting:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg"
|
|
1535
1527
|
],
|
|
1536
1528
|
"flags": {
|
|
1529
|
+
"json": {
|
|
1530
|
+
"description": "Format output as json.",
|
|
1531
|
+
"helpGroup": "GLOBAL",
|
|
1532
|
+
"name": "json",
|
|
1533
|
+
"allowNo": false,
|
|
1534
|
+
"type": "boolean"
|
|
1535
|
+
},
|
|
1537
1536
|
"flags-dir": {
|
|
1538
1537
|
"helpGroup": "GLOBAL",
|
|
1539
1538
|
"name": "flags-dir",
|
|
@@ -1542,66 +1541,75 @@
|
|
|
1542
1541
|
"multiple": false,
|
|
1543
1542
|
"type": "option"
|
|
1544
1543
|
},
|
|
1545
|
-
"
|
|
1546
|
-
"char": "
|
|
1547
|
-
"name": "
|
|
1548
|
-
"
|
|
1549
|
-
"
|
|
1544
|
+
"target-org": {
|
|
1545
|
+
"char": "o",
|
|
1546
|
+
"name": "target-org",
|
|
1547
|
+
"noCacheDefault": true,
|
|
1548
|
+
"required": true,
|
|
1549
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1550
|
+
"hasDynamicHelp": true,
|
|
1550
1551
|
"multiple": false,
|
|
1551
1552
|
"type": "option"
|
|
1552
1553
|
},
|
|
1553
|
-
"
|
|
1554
|
-
"
|
|
1555
|
-
"
|
|
1556
|
-
"
|
|
1557
|
-
"
|
|
1554
|
+
"api-version": {
|
|
1555
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1556
|
+
"name": "api-version",
|
|
1557
|
+
"hasDynamicHelp": false,
|
|
1558
|
+
"multiple": false,
|
|
1559
|
+
"type": "option"
|
|
1558
1560
|
},
|
|
1559
|
-
"
|
|
1560
|
-
"char": "
|
|
1561
|
-
"name": "
|
|
1562
|
-
"
|
|
1561
|
+
"library-id": {
|
|
1562
|
+
"char": "i",
|
|
1563
|
+
"name": "library-id",
|
|
1564
|
+
"required": true,
|
|
1565
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
1563
1566
|
"hasDynamicHelp": false,
|
|
1564
1567
|
"multiple": false,
|
|
1565
1568
|
"type": "option"
|
|
1566
1569
|
},
|
|
1567
|
-
"
|
|
1568
|
-
"
|
|
1569
|
-
"name": "
|
|
1570
|
-
"
|
|
1570
|
+
"file": {
|
|
1571
|
+
"char": "f",
|
|
1572
|
+
"name": "file",
|
|
1573
|
+
"required": true,
|
|
1574
|
+
"summary": "Path to the file to upload.",
|
|
1571
1575
|
"hasDynamicHelp": false,
|
|
1576
|
+
"multiple": true,
|
|
1577
|
+
"type": "option"
|
|
1578
|
+
},
|
|
1579
|
+
"wait": {
|
|
1580
|
+
"char": "w",
|
|
1581
|
+
"name": "wait",
|
|
1582
|
+
"summary": "Number of minutes to wait for indexing to complete. If not specified, returns after triggering indexing.",
|
|
1583
|
+
"hasDynamicHelp": true,
|
|
1572
1584
|
"multiple": false,
|
|
1573
|
-
"options": [
|
|
1574
|
-
"agentforce-studio",
|
|
1575
|
-
"testing-center"
|
|
1576
|
-
],
|
|
1577
1585
|
"type": "option"
|
|
1578
1586
|
}
|
|
1579
1587
|
},
|
|
1580
|
-
"hasDynamicHelp":
|
|
1588
|
+
"hasDynamicHelp": true,
|
|
1581
1589
|
"hiddenAliases": [],
|
|
1582
|
-
"id": "agent:
|
|
1590
|
+
"id": "agent:adl:upload",
|
|
1583
1591
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1584
1592
|
"pluginName": "@salesforce/plugin-agent",
|
|
1585
1593
|
"pluginType": "core",
|
|
1586
1594
|
"strict": true,
|
|
1587
|
-
"summary": "
|
|
1588
|
-
"enableJsonFlag":
|
|
1595
|
+
"summary": "Upload a file to an SFDRIVE Agentforce Data Library.",
|
|
1596
|
+
"enableJsonFlag": true,
|
|
1589
1597
|
"isESM": true,
|
|
1590
1598
|
"relativePath": [
|
|
1591
1599
|
"lib",
|
|
1592
1600
|
"commands",
|
|
1593
1601
|
"agent",
|
|
1594
|
-
"
|
|
1595
|
-
"
|
|
1602
|
+
"adl",
|
|
1603
|
+
"upload.js"
|
|
1596
1604
|
],
|
|
1597
1605
|
"aliasPermutations": [],
|
|
1598
1606
|
"permutations": [
|
|
1599
|
-
"agent:
|
|
1600
|
-
"
|
|
1601
|
-
"
|
|
1602
|
-
"agent:
|
|
1603
|
-
"
|
|
1604
|
-
"
|
|
1607
|
+
"agent:adl:upload",
|
|
1608
|
+
"adl:agent:upload",
|
|
1609
|
+
"adl:upload:agent",
|
|
1610
|
+
"agent:upload:adl",
|
|
1611
|
+
"upload:agent:adl",
|
|
1612
|
+
"upload:adl:agent"
|
|
1605
1613
|
]
|
|
1606
1614
|
},
|
|
1607
1615
|
"agent:mcp:create": {
|
|
@@ -2654,7 +2662,7 @@
|
|
|
2654
2662
|
"type": "boolean"
|
|
2655
2663
|
},
|
|
2656
2664
|
"context-variables": {
|
|
2657
|
-
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type
|
|
2665
|
+
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.",
|
|
2658
2666
|
"name": "context-variables",
|
|
2659
2667
|
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2660
2668
|
"delimiter": ",",
|
|
@@ -2662,6 +2670,14 @@
|
|
|
2662
2670
|
"multiple": true,
|
|
2663
2671
|
"type": "option"
|
|
2664
2672
|
},
|
|
2673
|
+
"context-variables-json": {
|
|
2674
|
+
"description": "Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a Number, Object, List, or Json value.\n\nThe value is a JSON array of objects, each with a \"name\", a \"type\", and an optional \"value\". The \"type\" is one of Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of \"value\" must match \"type\": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an array, and Json takes an object.\n\nExample: --context-variables-json '[{\"name\":\"probeGate\",\"type\":\"Boolean\",\"value\":true},{\"name\":\"retryCount\",\"type\":\"Number\",\"value\":3}]'.\n\nYou can pass both --context-variables and --context-variables-json in the same command. When the same variable name appears in both, the --context-variables-json value wins.\n\nTip: names follow the same rules as --context-variables. Use the \"$Context.\" prefix for linked context variables, and a bare name for state variables.",
|
|
2675
|
+
"name": "context-variables-json",
|
|
2676
|
+
"summary": "Typed session variables for the agent preview session, as a JSON array.",
|
|
2677
|
+
"hasDynamicHelp": false,
|
|
2678
|
+
"multiple": false,
|
|
2679
|
+
"type": "option"
|
|
2680
|
+
},
|
|
2665
2681
|
"agent-json": {
|
|
2666
2682
|
"dependsOn": [
|
|
2667
2683
|
"authoring-bundle"
|
|
@@ -4667,5 +4683,5 @@
|
|
|
4667
4683
|
]
|
|
4668
4684
|
}
|
|
4669
4685
|
},
|
|
4670
|
-
"version": "2.
|
|
4686
|
+
"version": "2.2.3"
|
|
4671
4687
|
}
|