@salesforce/plugin-agent 1.3.2

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

@@ -0,0 +1,54 @@
+/*
+ * 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 { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.test.run');
+export default class AgentTestRun extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        // AiEvalDefinitionVersion.Id -- This should really be "test-name"
+        id: Flags.string({
+            char: 'i',
+            required: true,
+            summary: messages.getMessage('flags.id.summary'),
+            description: messages.getMessage('flags.id.description'),
+        }),
+        wait: Flags.duration({
+            char: 'w',
+            unit: 'minutes',
+            min: 1,
+            summary: messages.getMessage('flags.wait.summary'),
+            description: messages.getMessage('flags.wait.description'),
+        }),
+        'output-dir': Flags.directory({
+            char: 'd',
+            summary: messages.getMessage('flags.output-dir.summary'),
+        }),
+        //
+        // Future flags:
+        //   result-format [csv, json, table, junit, TAP]
+        //   suites [array of suite names]
+        //   verbose [boolean]
+        //   ??? api-version or build-version ???
+    };
+    async run() {
+        const { flags } = await this.parse(AgentTestRun);
+        this.log(`Starting tests for AiEvalDefinitionVersion: ${flags.id}`);
+        // Call SF Eval Connect API passing AiEvalDefinitionVersion.Id
+        // POST to /einstein/ai-evaluations/{aiEvalDefinitionVersionId}/start
+        // Returns: AiEvaluation.Id
+        return {
+            success: true,
+            jobId: '4KBSM000000003F4AQ', // AiEvaluation.Id; needed for getting status and stopping
+        };
+    }
+}
+//# sourceMappingURL=run.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../../../src/commands/agent/test/run.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,gBAAgB,CAAC,CAAC;AASrF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,SAA6B;IAC9D,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;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,kEAAkE;QAClE,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;YAChD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;SACzD,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,CAAC;YACN,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC3D,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC;YAC5B,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;SACzD,CAAC;QACF,EAAE;QACF,gBAAgB;QAChB,iDAAiD;QACjD,kCAAkC;QAClC,sBAAsB;QACtB,yCAAyC;KAC1C,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAEjD,IAAI,CAAC,GAAG,CAAC,+CAA+C,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAEpE,8DAA8D;QAC9D,qEAAqE;QAErE,2BAA2B;QAE3B,OAAO;YACL,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,oBAAoB,EAAE,0DAA0D;SACxF,CAAC;IACJ,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2021, 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
+ */
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,EAAE,CAAC"}

package/messages/agent.create.md

@@ -0,0 +1,25 @@
+# summary
+
+Create an Agent from an agent spec.
+
+# description
+
+Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.
+
+# flags.job-spec.summary
+
+The path to an agent spec file.
+
+# flags.job-spec.description
+
+The agent spec file defines job titles and descriptions for the agent and can be created using the `sf agent create spec` command.
+
+# flags.name.summary
+
+The name of the agent.
+
+# examples
+
+- Create an Agent:
+
+  <%= config.bin %> <%= command.id %> --spec ./agent-spec.json

package/messages/agent.generate.spec.md

@@ -0,0 +1,41 @@
+# summary
+
+Create an Agent spec.
+
+# description
+
+Create an Agent spec, which is a list of job titles and descriptions that the agent performs.
+
+# flags.type.summary
+
+The type of agent to create.
+
+# flags.role.summary
+
+The role of the agent.
+
+# flags.company-name.summary
+
+The name of the company.
+
+# flags.company-description.summary
+
+The description of the company, containing details to be used when generating agent job descriptions.
+
+# flags.company-website.summary
+
+The website URL for the company.
+
+# flags.output-dir.summary
+
+The location within the project where the agent spec will be written.
+
+# flags.file-name.summary
+
+The name of the file to write the agent spec to.
+
+# examples
+
+- Create an Agent spec in the default location:
+
+  <%= config.bin %> <%= command.id %> --type customer_facing --role Support --company-name "Coral Cloud" --company-description "A meaningful description"

package/messages/agent.test.cancel.md

@@ -0,0 +1,21 @@
+# summary
+
+Cancel a running test for an Agent.
+
+# description
+
+Cancel a running test for an Agent, providing the AiEvaluation ID.
+
+# flags.id.summary
+
+The AiEvaluation ID.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent test evaluation.
+
+# examples
+
+- Cancel a test for an Agent:
+
+  <%= config.bin %> <%= command.id %> --id AiEvalId

package/messages/agent.test.run.md

@@ -0,0 +1,33 @@
+# summary
+
+Start a test for an Agent.
+
+# description
+
+Start a test for an Agent, providing the AiEvalDefinitionVersion ID. Returns the job ID.
+
+# flags.id.summary
+
+The AiEvalDefinitionVersion ID.
+
+# flags.id.description
+
+The AiEvalDefinitionVersion ID.
+
+# flags.wait.summary
+
+Number of minutes to wait for the command to complete and display results to the terminal window.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
+
+# flags.output-dir.summary
+
+Directory in which to store test run files.
+
+# examples
+
+- Start a test for an Agent:
+
+  <%= config.bin %> <%= command.id %> --id AiEvalDefVerId