@salesforce/plugin-agent 1.20.13 → 1.21.1

package/oclif.manifest.json

@@ -3,11 +3,11 @@
     "agent:create": {
       "aliases": [],
       "args": {},
-      "description": "To run this comand, you must have an agent spec file, which is a YAML file that define the agent properties and contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the \"agent generate agent-spec\" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag, along with the name (label) of the new agent with the --agent-name flag. If you don't specify any of the required flags, the command prompts you.\n\nWhen this command completes, your org contains the new agent, which you can then edit and customize 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, or you can add them. 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. When previewing, the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the agent's API name and a timestamp.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <agent-api-name>\".",
+      "description": "To run this command, you must have an agent spec file, which is a YAML file that define the agent properties and contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the \"agent generate agent-spec\" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag, along with the name (label) of the new agent with the --name flag. If you don't specify any of the required flags, the command prompts you.\n\nWhen this command completes, your org contains the new agent, which you can then edit and customize 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, or you can add them. 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. When previewing, the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the agent's API name and a timestamp.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --api-name <api-name>\".",
       "examples": [
         "Create an agent by being prompted for the required information, such as the agent spec file and agent name, and then create it in your default org:\n<%= config.bin %> <%= command.id %>",
-        "Create an agent by specifying the agent name, API name, and spec file with flags; use the org with alias \"my-org\"; the command fails if the API name is already being used in your org:\n<%= config.bin %> <%= command.id %> --agent-name \"Resort Manager\" --agent-api-name Resort_Manager --spec specs/resortManagerAgent.yaml --target-org my-org",
-        "Preview the creation of an agent named \"Resort Manager\" and use your default org:\n<%= config.bin %> <%= command.id %> --agent-name \"Resort Manager\" --spec specs/resortManagerAgent.yaml --preview"
+        "Create an agent by specifying the agent name, API name, and spec file with flags; use the org with alias \"my-org\"; the command fails if the API name is already being used in your org:\n<%= config.bin %> <%= command.id %> --name \"Resort Manager\" --api-name Resort_Manager --spec specs/resortManagerAgent.yaml --target-org my-org",
+        "Preview the creation of an agent named \"Resort Manager\" and use your default org:\n<%= config.bin %> <%= command.id %> --name \"Resort Manager\" --spec specs/resortManagerAgent.yaml --preview"
       ],
       "flags": {
         "json": {
@@ -42,15 +42,15 @@
           "multiple": false,
           "type": "option"
         },
-        "agent-name": {
-          "name": "agent-name",
+        "name": {
+          "name": "name",
           "summary": "Name (label) of the new agent.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "agent-api-name": {
-          "name": "agent-api-name",
+        "api-name": {
+          "name": "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,
@@ -84,7 +84,6 @@
       "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,
@@ -105,7 +104,7 @@
     "agent:preview": {
       "aliases": [],
       "args": {},
-      "description": "Use this command to have a natural language conversation with an active agent in your org, as if you were an actual user. The interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nThis command is useful to test if the agent responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Conversation Preview panel in your org's Agent Builder UI.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory by setting the environment variable \"SF_AGENT_PREVIEW_OUTPUT_DIR\" to the directory. Or you can pass the directory to the --output-dir flag.\n\nFind the agent's API name in its main details page in your org's Agent page in Setup.\n\nBefore you use this command, you must complete these steps:\n-----------------------------------------------------------\n\n1. Create a connected app in your org as described in the \"Create a Connected App\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#create-a-connected-app. Do these four additional steps:\n\n   a. When specifying the connected app's Callback URL, add this second callback URL on a new line: \"http://localhost:1717/OauthRedirect\".\n\n   b. When adding the scopes to the connected app, add \"Manage user data via Web browsers (web)\".\n\n   c. Ensure that the \"Require Secret for Web Server Flow\" option is not selected.\n\n   d. Make note of the user that you specified as the \"Run As\" user when updating the Client Credentials Flow section.\n\n2. Add the connected app to your agent as described in the \"Add Connected App to Agent\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#add-connected-app-to-agent.\n\n3. Copy the consumer key from your connected app as described in the \"Obtain Credentials\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#obtain-credentials.\n\n4. Set the \"SFDX_AUTH_SCOPES\" environment variable to \"refresh_token sfap_api chatbot_api web api\". This step ensures that you get the specific OAuth scopes required by this command.\n\n5. Using the username of the user you specified as the \"Run As\" user above, authorize your org using the web server flow, as described in this document: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm.\n\n   IMPORTANT: You must use the \"--client-id <CONNECTED-APP-CONSUMER-KEY>\" flag of \"org login web\", where CONNECTED-APP-CONSUMER-KEY is the consumer key you previously copied. This step ensures that the \"org login web\" command uses your custom connected app, and not the default CLI connected app.\n\n   Press Enter to skip sharing the client secret.\n\n6. When you run this command to interact with an agent, specify the username you authorized in the preceding step with the --connected-app-user (-a) flag.",
+      "description": "Use this command to have a natural language conversation with an active agent in your org, as if you were an actual user. The interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nThis command is useful to test if the agent responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Conversation Preview panel in your org's Agent Builder UI.\n\nWhen the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the \"./temp/agent-preview\" directory. Specify a new default directory by setting the environment variable \"SF_AGENT_PREVIEW_OUTPUT_DIR\" to the directory. Or you can pass the directory to the --output-dir flag.\n\nFind the agent's API name in its main details page in your org's Agent page in Setup.\n\nBefore you use this command, you must complete these steps:\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n1. Create a connected app in your org as described in the \"Create a Connected App\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#create-a-connected-app. Do these four additional steps:\n\n   a. When specifying the connected app's Callback URL, add this second callback URL on a new line: \"http://localhost:1717/OauthRedirect\".\n\n   b. When adding the scopes to the connected app, add \"Manage user data via Web browsers (web)\".\n\n   c. Ensure that the \"Require Secret for Web Server Flow\" option is not selected.\n\n   d. Make note of the user that you specified as the \"Run As\" user when updating the Client Credentials Flow section.\n\n2. Add the connected app to your agent as described in the \"Add Connected App to Agent\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#add-connected-app-to-agent.\n\n3. Copy the consumer key from your connected app as described in the \"Obtain Credentials\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#obtain-credentials.\n\n4. Set the \"SFDX_AUTH_SCOPES\" environment variable to \"refresh_token sfap_api chatbot_api web api\". This step ensures that you get the specific OAuth scopes required by this command.\n\n5. Using the username of the user you specified as the \"Run As\" user above, authorize your org using the web server flow, as described in this document: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm.\n\n   IMPORTANT: You must use the \"--client-id <CONNECTED-APP-CONSUMER-KEY>\" flag of \"org login web\", where CONNECTED-APP-CONSUMER-KEY is the consumer key you previously copied. This step ensures that the \"org login web\" command uses your custom connected app, and not the default CLI connected app.\n\n   Press Enter to skip sharing the client secret.\n\n6. When you run this command to interact with an agent, specify the username you authorized in the preceding step with the --connected-app-user (-a) flag.",
       "examples": [
         "Interact with an agent with API name \"Resort_Manager\" in the org with alias \"my-org\". Connect to your agent using the alias \"my-agent-user\"; this alias must point to the username who is authorized using the Web server flow:\n<%= config.bin %> <%= command.id %> --api-name \"Resort_Manager\" --target-org my-org --connected-app-user my-agent-user",
         "Same as the preceding example, but this time save the conversation transcripts to the \"./transcripts/my-preview\" directory rather than the default \"./temp/agent-preview\":\n<%= config.bin %> <%= command.id %> --api-name \"Resort_Manager\" --target-org my-org --connected-app-user my-agent-user --output-dir \"transcripts/my-preview\""
@@ -169,7 +168,7 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "preview",
+      "state": "beta",
       "strict": true,
       "summary": "Interact with an active agent to preview how the agent responds to your statements, questions, and commands (utterances).",
       "enableJsonFlag": false,
@@ -358,7 +357,6 @@
       "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,
@@ -505,7 +503,6 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "beta",
       "strict": true,
       "summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
       "enableJsonFlag": false,
@@ -619,8 +616,8 @@
       "description": "To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the \"agent generate test-spec\" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.\n\nWhen this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI. This command also retrieves the metadata component (AiEvaluationDefinition) associated with the new test to your local Salesforce DX project and displays its filename.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
       "examples": [
         "Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
-        "Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --test-api-name Resort_Manager_Test --force-overwrite --target-org my-org",
-        "Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --test-api-name Resort_Manager_Test --preview"
+        "Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
+        "Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview"
       ],
       "flags": {
         "json": {
@@ -638,8 +635,8 @@
           "multiple": false,
           "type": "option"
         },
-        "test-api-name": {
-          "name": "test-api-name",
+        "api-name": {
+          "name": "api-name",
           "summary": "API name of the new test; the API name must not exist in the org.",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -688,7 +685,6 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "beta",
       "strict": true,
       "summary": "Create an agent test in your org using a local test spec YAML file.",
       "enableJsonFlag": true,
@@ -758,7 +754,6 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "beta",
       "strict": true,
       "summary": "List the available agent tests in your org.",
       "enableJsonFlag": true,
@@ -861,7 +856,6 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "beta",
       "strict": true,
       "summary": "Get the results of a completed agent test run.",
       "enableJsonFlag": true,
@@ -979,7 +973,6 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "beta",
       "strict": true,
       "summary": "Resume an agent test that you previously started in your org so you can view the test results.",
       "enableJsonFlag": true,
@@ -1089,7 +1082,6 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
-      "state": "beta",
       "strict": true,
       "summary": "Start an agent test in your org.",
       "enableJsonFlag": true,
@@ -1112,5 +1104,5 @@
       ]
     }
   },
-  "version": "1.20.13"
+  "version": "1.21.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.20.13",
+    "version": "1.21.1",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -9,8 +9,8 @@
         "@inquirer/prompts": "^7.2.0",
         "@oclif/core": "^4",
         "@oclif/multi-stage-output": "^0.7.12",
-        "@salesforce/agents": "^0.14.9",
-        "@salesforce/core": "^8.10.1",
+        "@salesforce/agents": "0.14.11",
+        "@salesforce/core": "^8.10.2",
         "@salesforce/kit": "^3.2.3",
         "@salesforce/sf-plugins-core": "^12.2.0",
         "@salesforce/source-deploy-retrieve": "^12.19.3",
@@ -229,7 +229,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.20.13.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.20.13.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.21.1.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.21.1.sig"
     }
 }