@salesforce/plugin-agent 1.10.0 → 1.11.0

package/lib/commands/agent/test/create.js

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { join } from 'node:path';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Lifecycle, Messages } from '@salesforce/core';
+import { AgentTester, AgentTestCreateLifecycleStages } from '@salesforce/agents';
+import { MultiStageOutput } from '@oclif/multi-stage-output';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.test.create');
+export default class AgentTestCreate extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static state = 'beta';
+    static flags = {
+        spec: Flags.file({
+            summary: messages.getMessage('flags.spec.summary'),
+            description: messages.getMessage('flags.spec.description'),
+            char: 's',
+            required: true,
+            exists: true,
+        }),
+        'target-org': Flags.requiredOrg(),
+        'api-version': Flags.orgApiVersion(),
+        preview: Flags.boolean({
+            summary: messages.getMessage('flags.preview.summary'),
+        }),
+        'no-prompt': Flags.boolean({
+            summary: messages.getMessage('flags.no-prompt.summary'),
+            char: 'p',
+        }),
+    };
+    mso;
+    async run() {
+        const { flags } = await this.parse(AgentTestCreate);
+        const agentTester = new AgentTester(flags['target-org'].getConnection(flags['api-version']));
+        const lifecycle = Lifecycle.getInstance();
+        lifecycle.on(AgentTestCreateLifecycleStages.CreatingLocalMetadata, async () => {
+            this.mso = new MultiStageOutput({
+                jsonEnabled: this.jsonEnabled(),
+                stages: Object.values(AgentTestCreateLifecycleStages),
+                title: `Creating test for ${flags.spec}`,
+            });
+            this.mso?.skipTo(AgentTestCreateLifecycleStages.CreatingLocalMetadata);
+            return Promise.resolve();
+        });
+        lifecycle.on(AgentTestCreateLifecycleStages.DeployingMetadata, async () => Promise.resolve(this.mso?.skipTo(AgentTestCreateLifecycleStages.DeployingMetadata)));
+        lifecycle.on(AgentTestCreateLifecycleStages.Waiting, async () => Promise.resolve(this.mso?.skipTo(AgentTestCreateLifecycleStages.Waiting)));
+        lifecycle.on(AgentTestCreateLifecycleStages.Done, async (result) => {
+            if (result.response.success) {
+                this.mso?.skipTo(AgentTestCreateLifecycleStages.Done);
+                this.mso?.stop();
+            }
+            else {
+                this.mso?.error();
+                this.mso?.stop();
+            }
+            return Promise.resolve();
+        });
+        const confirmationCallback = flags['no-prompt']
+            ? async () => Promise.resolve(true)
+            : async (spec) => this.confirm({
+                message: `An AiEvaluationDefinition with the name ${spec.name} already exists in the org. Do you want to overwrite it?`,
+                defaultAnswer: false,
+            });
+        const { path, contents } = await agentTester.create(flags.spec, {
+            outputDir: join('force-app', 'main', 'default', 'aiEvaluationDefinitions'),
+            preview: flags.preview,
+            confirmationCallback,
+        });
+        if (flags.preview) {
+            this.mso?.skipTo(AgentTestCreateLifecycleStages.Done);
+            this.mso?.stop();
+            this.log(`Preview of AiEvaluationDefinition created at ${path}`);
+            this.log();
+            this.log(contents);
+        }
+        else {
+            this.log(`AiEvaluationDefinition created at ${path} and deployed to ${flags['target-org'].getUsername() ?? flags['target-org'].getOrgId()}`);
+        }
+        return {
+            path,
+            contents,
+        };
+    }
+    catch(error) {
+        this.mso?.error();
+        return super.catch(error);
+    }
+}
+//# sourceMappingURL=create.js.map

package/lib/commands/agent/test/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../../src/commands/agent/test/create.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAW,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAC;AAEjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAG7D,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,mBAAmB,CAAC,CAAC;AAOxF,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,SAAgC;IACpE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,KAAK,GAAG,MAAM,CAAC;IAE/B,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;SACtD,CAAC;QACF,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC;YACzB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,IAAI,EAAE,GAAG;SACV,CAAC;KACH,CAAC;IACM,GAAG,CAAsC;IAE1C,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAE7F,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1C,SAAS,CAAC,EAAE,CAAC,8BAA8B,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;YAC5E,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAgB,CAAmB;gBAChD,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;gBAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,8BAA8B,CAAC;gBACrD,KAAK,EAAE,qBAAqB,KAAK,CAAC,IAAI,EAAE;aACzC,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,8BAA8B,CAAC,qBAAqB,CAAC,CAAC;YACvE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,EAAE,CAAC,8BAA8B,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE,CACxE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC,CACpF,CAAC;QAEF,SAAS,CAAC,EAAE,CAAC,8BAA8B,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAC9D,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC,CAC1E,CAAC;QAEF,SAAS,CAAC,EAAE,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,EAAE,MAAoB,EAAE,EAAE;YAC/E,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;gBAC5B,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;gBACtD,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;gBAClB,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;YACnB,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,MAAM,oBAAoB,GAAG,KAAK,CAAC,WAAW,CAAC;YAC7C,CAAC,CAAC,KAAK,IAAsB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;YACrD,CAAC,CAAC,KAAK,EAAE,IAAsB,EAAoB,EAAE,CACjD,IAAI,CAAC,OAAO,CAAC;gBACX,OAAO,EAAE,2CAA2C,IAAI,CAAC,IAAI,0DAA0D;gBACvH,aAAa,EAAE,KAAK;aACrB,CAAC,CAAC;QAET,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;YAC9D,SAAS,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,yBAAyB,CAAC;YAC1E,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,oBAAoB;SACrB,CAAC,CAAC;QAEH,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,gDAAgD,IAAI,EAAE,CAAC,CAAC;YACjE,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CACN,qCAAqC,IAAI,oBACvC,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EACnE,EAAE,CACH,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI;YACJ,QAAQ;SACT,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,KAAiC;QAC/C,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC"}

package/messages/agent.create-v2.md

@@ -1,12 +1,14 @@
 # summary
 
-Create an agent in your org from a local agent spec file.
+Create an agent in your org using a local agent spec file.
 
 # description
 
-To generate an agent spec file, run the "agent generate spec" CLI command, which outputs a YAML 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.
+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.
 
-When 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.
+When 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.
+
+Use 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.
 
 To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <api-name-of-your-agent>".
 
@@ -16,27 +18,27 @@ Path to an agent spec file.
 
 # flags.preview.summary
 
-Preview the agent without saving in your org.
+Preview the agent without saving it in your org.
 
 # flags.agent-name.summary
 
-Name for the new agent.
+Name (label) of the new agent.
 
 # flags.agent-api-name.summary
 
-API name for the new agent.
+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.
 
 # flags.user-id.summary
 
-Custom user ID for the agent.
+ID of a user in your org that is assigned to your agent; determines what your agent can access and do.
 
 # flags.enrich-logs.summary
 
-Adds agent conversation data to event logs.
+Adds agent conversation data to event logs so you can view all agent session activity in one place.
 
 # flags.tone.summary
 
-Conversational style of agent responses.
+Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.
 
 # flags.primary-language.summary
 
@@ -52,6 +54,10 @@ Missing required flags: %s
 
 # examples
 
-- Create an agent called "CustomerSupportAgent" in an org with alias "my-org" using the specified agent spec file:
+- Create an agent called "ResortManager" in an org with alias "my-org" using the specified agent spec file:
+
+  <%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --target-org my-org
+
+- Preview the creation of an agent called "ResortManager" and use your default org:
 
-  <%= config.bin %> <%= command.id %> --name CustomerSupportAgent --spec ./config/agentSpec.json --target-org my-org
+  <%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --preview

package/messages/agent.generate.spec-v2.md

@@ -1,44 +1,52 @@
 # summary
 
-Generate an agent spec, which is the list of jobs that the agent performs.
+Generate an agent spec, which is a YAML file that captures what an agent can do.
 
 # description
 
-When using Salesforce CLI to create an agent in your org, you can choose to generate a YAML-formatted agent spec file with this command as a first step.
+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.
 
-An 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.
+Use 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.
 
-When 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.
+You 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.
+
+You 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.
+
+When 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.
 
 # flags.output-file.summary
 
-Path for the generated agent spec file (yaml); can be an absolute or relative path.
+Path for the generated YAML agent spec file; can be an absolute or relative path.
 
 # flags.max-topics.summary
 
-Maximum number of agent job topics to generate in the spec; default is 10.
+Maximum number of topics to generate in the agent spec; default is 10.
 
 # flags.prompt-template.summary
 
-Developer name of a customized prompt template to use instead of the default.
+API name of a customized prompt template to use instead of the default prompt template.
 
 # flags.grounding-context.summary
 
-Context information to be used with the customized prompt template.
+Context information and personalization that's added to your prompts when using a custom prompt template.
 
 # flags.spec.summary
 
-Spec file (yaml) to use as input to the command.
+Agent spec file, in YAML format, to use as input to the 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:
+- 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:
+
+  <%= 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."
+
+- 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":
 
-  <%= 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"
+  <%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
 
-- 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":
+- 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:
 
-  <%= config.bin %> <%= command.id %> --output-dir specs --target-org my-org
+  <%= 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" --target-org my-org
 
 # error.missingRequiredFlags
 

package/messages/agent.generate.test-spec.md

@@ -0,0 +1,11 @@
+# summary
+
+Interactively generate a specification file for a AI evaluation test.
+
+# description
+
+This command will prompt you for the necessary information to create a new spec file (in yaml format). You can then create a new AI evaluation using "sf agent test create --spec <spec-file>".
+
+# examples
+
+- <%= config.bin %> <%= command.id %>

package/messages/agent.test.create.md

@@ -0,0 +1,27 @@
+# summary
+
+Summary of a command.
+
+# description
+
+More information about a command. Don't repeat the summary.
+
+# flags.spec.summary
+
+Description of a flag.
+
+# flags.spec.description
+
+More information about a flag. Don't repeat the summary.
+
+# flags.preview.summary
+
+Preview the test metadata without deploying to your org.
+
+# flags.no-prompt.summary
+
+Don't prompt for confirmation when overwriting an existing test.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>