@salesforce/plugin-agent 1.11.0 → 1.12.0

package/oclif.manifest.json

@@ -1,6 +1,6 @@
 {
   "commands": {
-    "agent:create-v2": {
+    "agent:create": {
       "aliases": [],
       "args": {},
       "description": "Before you run this command, you must first generate an agent spec file by running the \"agent generate spec\" CLI command, which outputs a YAML file with the agent properties and list of AI-generated topics. Topics define the range of jobs the agent can handle. Then specify the generated agent spec file to this command using the --spec flag, along with the name (label) of the new agent using the --agent-name flag.\n\nWhen this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have some AI-generated actions. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.\n\nUse the --preview flag to review what the agent looks like without actually saving it in your org. Rather, the command creates a JSON file with all the agent details in the current directory.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <api-name-of-your-agent>\".",
@@ -48,36 +48,6 @@
           "multiple": false,
           "type": "option"
         },
-        "user-id": {
-          "name": "user-id",
-          "summary": "ID of a user in your org that is assigned to your agent; determines what your agent can access and do.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "enrich-logs": {
-          "name": "enrich-logs",
-          "summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "true",
-            "false"
-          ],
-          "type": "option"
-        },
-        "tone": {
-          "name": "tone",
-          "summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "formal",
-            "casual",
-            "neutral"
-          ],
-          "type": "option"
-        },
         "spec": {
           "name": "spec",
           "required": true,
@@ -93,111 +63,16 @@
           "type": "boolean"
         },
         "agent-api-name": {
-          "hidden": true,
           "name": "agent-api-name",
           "summary": "API name of the new agent; if not specified, the API name is derived from the agent name (label); the API name must not exist in the org.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "primary-language": {
-          "hidden": true,
-          "name": "primary-language",
-          "summary": "Language the agent uses in conversations.",
-          "default": "en_US",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "en_US"
-          ],
-          "type": "option"
-        },
         "planner-id": {
+          "hidden": true,
           "name": "planner-id",
-          "summary": "The GenAiPlanner ID to associate with the agent.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": true,
-      "hiddenAliases": [],
-      "id": "agent:create-v2",
-      "pluginAlias": "@salesforce/plugin-agent",
-      "pluginName": "@salesforce/plugin-agent",
-      "pluginType": "core",
-      "state": "beta",
-      "strict": true,
-      "summary": "Create an agent in your org using a local agent spec file.",
-      "enableJsonFlag": true,
-      "requiresProject": true,
-      "isESM": true,
-      "relativePath": [
-        "lib",
-        "commands",
-        "agent",
-        "create-v2.js"
-      ],
-      "aliasPermutations": [],
-      "permutations": [
-        "agent:create-v2",
-        "create-v2:agent"
-      ]
-    },
-    "agent:create": {
-      "aliases": [],
-      "args": {},
-      "description": "To generate an agent spec file, run the \"agent generate spec\" CLI command, which outputs a JSON file with the list of jobs and descriptions that the new agent can perform. Then specify this generated spec file to the --spec flag of this command, along with the name of the new agent.\n\nWhen this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent already has a list of topics and actions that were automatically created from the list of jobs in the provided agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX project.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <api-name-of-your-agent>\".",
-      "examples": [
-        "Create an agent called \"CustomerSupportAgent\" in an org with alias \"my-org\" using the specified agent spec file:\n<%= config.bin %> <%= command.id %> --name CustomerSupportAgent --spec ./config/agentSpec.json --target-org my-org"
-      ],
-      "flags": {
-        "json": {
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "name": "json",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "flags-dir": {
-          "helpGroup": "GLOBAL",
-          "name": "flags-dir",
-          "summary": "Import flag values from a directory.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "target-org": {
-          "char": "o",
-          "name": "target-org",
-          "noCacheDefault": true,
-          "required": true,
-          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
-          "hasDynamicHelp": true,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-version": {
-          "description": "Override the api version used for api requests made by this command",
-          "name": "api-version",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "spec": {
-          "char": "f",
-          "name": "spec",
-          "required": true,
-          "summary": "Path to an agent spec file.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "name": {
-          "char": "n",
-          "name": "name",
-          "required": true,
-          "summary": "API name of the new agent.",
+          "summary": "An existing GenAiPlanner ID to associate with the agent.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -211,7 +86,7 @@
       "pluginType": "core",
       "state": "beta",
       "strict": true,
-      "summary": "Create an agent in your org from a local agent spec file.",
+      "summary": "Create an agent in your org using a local agent spec file.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "isESM": true,
@@ -295,7 +170,7 @@
         "preview:agent"
       ]
     },
-    "agent:generate:spec-v2": {
+    "agent:generate:spec": {
       "aliases": [],
       "args": {},
       "description": "Before you use Salesforce CLI to create an agent in your org, you must first generate an agent spec with this command. An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company description, and then 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 information. Upon command execution, the large language model (LLM) associated with your org uses the information you provided 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 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 to your agent or change the description of a particular topic.\n\nYou can 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 a custom prompt template that the agent uses, and ground the prompt template to add context and personalization to the agent's prompts.\n\nWhen your agent spec is ready, you then create the agent in your org by running the \"agent create\" CLI command and specifying the spec with the --spec flag.",
@@ -377,21 +252,6 @@
           "multiple": false,
           "type": "option"
         },
-        "spec": {
-          "name": "spec",
-          "summary": "Agent spec file, in YAML format, to use as input to the command.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "output-file": {
-          "name": "output-file",
-          "summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
-          "default": "config/agentSpec.yaml",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "max-topics": {
           "name": "max-topics",
           "summary": "Maximum number of topics to generate in the agent spec; default is 10.",
@@ -399,151 +259,79 @@
           "multiple": false,
           "type": "option"
         },
-        "prompt-template": {
-          "name": "prompt-template",
-          "summary": "API name of a customized prompt template to use instead of the default prompt template.",
+        "agent-user": {
+          "name": "agent-user",
+          "summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "grounding-context": {
-          "dependsOn": [
-            "prompt-template"
-          ],
-          "name": "grounding-context",
-          "summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": true,
-      "hiddenAliases": [],
-      "id": "agent:generate:spec-v2",
-      "pluginAlias": "@salesforce/plugin-agent",
-      "pluginName": "@salesforce/plugin-agent",
-      "pluginType": "core",
-      "state": "beta",
-      "strict": true,
-      "summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
-      "enableJsonFlag": true,
-      "requiresProject": true,
-      "isESM": true,
-      "relativePath": [
-        "lib",
-        "commands",
-        "agent",
-        "generate",
-        "spec-v2.js"
-      ],
-      "aliasPermutations": [],
-      "permutations": [
-        "agent:generate:spec-v2",
-        "generate:agent:spec-v2",
-        "generate:spec-v2:agent",
-        "agent:spec-v2:generate",
-        "spec-v2:agent:generate",
-        "spec-v2:generate:agent"
-      ]
-    },
-    "agent:generate:spec": {
-      "aliases": [],
-      "args": {},
-      "description": "When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent spec file with this command.\n\nAn agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and --company-description to provide details about your company and the role that the agent plays in your company; you can also enter the information interactively if you prefer. When you then execute this command, the large language model (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs. We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can remove jobs that don't apply to your agent.\n\nWhen your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the --job-spec flag of the \"agent create\" CLI command.",
-      "examples": [
-        "Create an agent spec for your default org in the default location and use flags to specify the agent's role and your company details:\n<%= config.bin %> <%= command.id %> --type customer --role \"Assist users in navigating and managing bookings\" --company-name \"Coral Cloud\" --company-description \"Resort that manages guests and their reservations and experiences\"",
-        "Create an agent spec by being prompted for role and company details interactively; write the generated file to the \"specs\" directory and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --output-dir specs --target-org my-org"
-      ],
-      "flags": {
-        "json": {
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "name": "json",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "flags-dir": {
-          "helpGroup": "GLOBAL",
-          "name": "flags-dir",
-          "summary": "Import flag values from a directory.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "target-org": {
-          "char": "o",
-          "name": "target-org",
-          "noCacheDefault": true,
-          "required": true,
-          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
-          "hasDynamicHelp": true,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-version": {
-          "description": "Override the api version used for api requests made by this command",
-          "name": "api-version",
+        "enrich-logs": {
+          "name": "enrich-logs",
+          "summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
           "hasDynamicHelp": false,
           "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
           "type": "option"
         },
-        "type": {
-          "char": "t",
-          "name": "type",
-          "summary": "Type of agent to create.",
+        "tone": {
+          "name": "tone",
+          "summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
-            "customer",
-            "internal"
+            "formal",
+            "casual",
+            "neutral"
           ],
           "type": "option"
         },
-        "role": {
-          "name": "role",
-          "summary": "Role of the agent.",
+        "spec": {
+          "name": "spec",
+          "summary": "Agent spec file, in YAML format, to use as input to the command.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "company-name": {
-          "name": "company-name",
-          "summary": "Name of your company.",
+        "output-file": {
+          "name": "output-file",
+          "summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
+          "default": "config/agentSpec.yaml",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "company-description": {
-          "name": "company-description",
-          "summary": "Description of your company.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "full-interview": {
+          "name": "full-interview",
+          "summary": "Prompt for both required and optional flags.",
+          "allowNo": false,
+          "type": "boolean"
         },
-        "company-website": {
-          "name": "company-website",
-          "summary": "Website URL of your company.",
+        "prompt-template": {
+          "name": "prompt-template",
+          "summary": "API name of a customized prompt template to use instead of the default prompt template.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "output-dir": {
-          "char": "d",
-          "name": "output-dir",
-          "summary": "Directory where the agent spec file is written; can be an absolute or relative path.",
-          "default": "config",
+        "grounding-context": {
+          "dependsOn": [
+            "prompt-template"
+          ],
+          "name": "grounding-context",
+          "summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "file-name": {
-          "char": "f",
-          "name": "file-name",
-          "summary": "Name of the generated agent spec file.",
-          "default": "agentSpec.json",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "no-prompt": {
+          "name": "no-prompt",
+          "summary": "Don't prompt the user to confirm spec file overwrite.",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": true,
@@ -554,7 +342,7 @@
       "pluginType": "core",
       "state": "beta",
       "strict": true,
-      "summary": "Generate an agent spec, which is the list of jobs that the agent performs.",
+      "summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "isESM": true,
@@ -1198,5 +986,5 @@
       ]
     }
   },
-  "version": "1.11.0"
+  "version": "1.12.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.11.0",
+    "version": "1.12.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -9,7 +9,7 @@
         "@inquirer/prompts": "^7.2.0",
         "@oclif/core": "^4",
         "@oclif/multi-stage-output": "^0.7.12",
-        "@salesforce/agents": "^0.9.0",
+        "@salesforce/agents": "^0.9.2",
         "@salesforce/core": "^8.8.0",
         "@salesforce/kit": "^3.2.1",
         "@salesforce/sf-plugins-core": "^12.1.0",
@@ -226,7 +226,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.11.0.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.11.0.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.12.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.12.0.sig"
     }
 }

package/schemas/agent-create.json

@@ -4,18 +4,142 @@
   "definitions": {
     "AgentCreateResult": {
       "type": "object",
+      "additionalProperties": false,
       "properties": {
+        "previewFilePath": {
+          "type": "string"
+        },
         "isSuccess": {
           "type": "boolean"
         },
         "errorMessage": {
           "type": "string"
+        },
+        "agentId": {
+          "type": "object",
+          "properties": {
+            "botId": {
+              "type": "string"
+            },
+            "botVersionId": {
+              "type": "string"
+            },
+            "plannerId": {
+              "type": "string"
+            }
+          },
+          "required": ["botId", "botVersionId", "plannerId"],
+          "additionalProperties": false,
+          "description": "If the agent was created with saveAgent=true, these are the IDs that make up an agent; Bot, BotVersion, and GenAiPlanner metadata."
+        },
+        "agentDefinition": {
+          "type": "object",
+          "properties": {
+            "agentDescription": {
+              "type": "string"
+            },
+            "topics": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "scope": {
+                    "type": "string"
+                  },
+                  "topic": {
+                    "type": "string"
+                  },
+                  "actions": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "actionName": {
+                          "type": "string"
+                        },
+                        "exampleOutput": {
+                          "type": "string"
+                        },
+                        "actionDescription": {
+                          "type": "string"
+                        },
+                        "inputs": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "inputName": {
+                                "type": "string"
+                              },
+                              "inputDataType": {
+                                "type": "string"
+                              },
+                              "inputDescription": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["inputName", "inputDataType", "inputDescription"],
+                            "additionalProperties": false
+                          },
+                          "minItems": 1,
+                          "maxItems": 1
+                        },
+                        "outputs": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "outputName": {
+                                "type": "string"
+                              },
+                              "outputDataType": {
+                                "type": "string"
+                              },
+                              "outputDescription": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["outputName", "outputDataType", "outputDescription"],
+                            "additionalProperties": false
+                          },
+                          "minItems": 1,
+                          "maxItems": 1
+                        }
+                      },
+                      "required": ["actionName", "exampleOutput", "actionDescription", "inputs", "outputs"],
+                      "additionalProperties": false
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                  },
+                  "instructions": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "classificationDescription": {
+                    "type": "string"
+                  }
+                },
+                "required": ["scope", "topic", "actions", "instructions", "classificationDescription"],
+                "additionalProperties": false
+              },
+              "minItems": 1,
+              "maxItems": 1
+            },
+            "sampleUtterances": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "required": ["agentDescription", "topics", "sampleUtterances"],
+          "additionalProperties": false
         }
       },
-      "required": [
-        "isSuccess"
-      ],
-      "additionalProperties": false
+      "required": ["agentDefinition", "isSuccess"]
     }
   }
-}
+}

package/schemas/agent-generate-spec.json

@@ -4,21 +4,69 @@
   "definitions": {
     "AgentCreateSpecResult": {
       "type": "object",
+      "additionalProperties": false,
       "properties": {
+        "topics": {
+          "$ref": "#/definitions/DraftAgentTopics"
+        },
+        "agentType": {
+          "type": "string",
+          "enum": ["customer", "internal"],
+          "description": "Internal type is copilots; used by customers' employees. Customer type is agents; used by customers' customers."
+        },
+        "role": {
+          "type": "string"
+        },
+        "companyName": {
+          "type": "string"
+        },
+        "companyDescription": {
+          "type": "string"
+        },
+        "companyWebsite": {
+          "type": "string"
+        },
+        "maxNumOfTopics": {
+          "type": "number",
+          "description": "The maximum number of topics to create in the spec. Default is 10."
+        },
+        "promptTemplateName": {
+          "type": "string",
+          "description": "Developer name of the prompt template."
+        },
+        "groundingContext": {
+          "type": "string",
+          "description": "Context info to be used in customized prompt template"
+        },
         "isSuccess": {
           "type": "boolean"
         },
         "errorMessage": {
           "type": "string"
         },
-        "jobSpec": {
+        "specPath": {
           "type": "string"
         }
       },
-      "required": [
-        "isSuccess"
-      ],
-      "additionalProperties": false
+      "required": ["agentType", "companyDescription", "companyName", "isSuccess", "role", "topics"]
+    },
+    "DraftAgentTopics": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "description"],
+        "additionalProperties": false
+      },
+      "minItems": 1,
+      "maxItems": 1
     }
   }
-}
+}