@salesforce/agents 0.17.1 → 0.17.2

package/lib/agentTrace.d.ts

@@ -0,0 +1,23 @@
+import { Connection } from '@salesforce/core';
+import { type AgentTraceResponse } from './types';
+/**
+ * A service for retrieving agent execution traces. Provides detailed information
+ * about agent plan execution including steps, timing, and safety scores.
+ *
+ * **Examples**
+ *
+ * Get trace data for a specific trace ID:
+ *
+ * `const traceData = await AgentTrace.getTrace(connection, '12-23-34');`
+ */
+export declare class AgentTrace {
+    /**
+     * Get the trace data for a given trace ID.
+     *
+     * @param connection The connection to use for making the API request
+     * @param traceId The trace ID to retrieve trace data for
+     * @returns Promise that resolves with the trace data response containing actions and their execution details
+     * @beta
+     */
+    static getTrace(connection: Connection, traceId: string): Promise<AgentTraceResponse>;
+}

package/lib/agentTrace.js

@@ -0,0 +1,38 @@
+"use strict";
+/*
+ * Copyright (c) 2023, 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentTrace = void 0;
+const maybe_mock_1 = require("./maybe-mock");
+/**
+ * A service for retrieving agent execution traces. Provides detailed information
+ * about agent plan execution including steps, timing, and safety scores.
+ *
+ * **Examples**
+ *
+ * Get trace data for a specific trace ID:
+ *
+ * `const traceData = await AgentTrace.getTrace(connection, '12-23-34');`
+ */
+class AgentTrace {
+    /**
+     * Get the trace data for a given trace ID.
+     *
+     * @param connection The connection to use for making the API request
+     * @param traceId The trace ID to retrieve trace data for
+     * @returns Promise that resolves with the trace data response containing actions and their execution details
+     * @beta
+     */
+    static async getTrace(connection, traceId) {
+        const maybeMock = new maybe_mock_1.MaybeMock(connection);
+        // TODO: who knows what the real endpoint will be, or if the return type is 100% accurate
+        const url = `/api/trace/${traceId}`;
+        return maybeMock.request('GET', url);
+    }
+}
+exports.AgentTrace = AgentTrace;
+//# sourceMappingURL=agentTrace.js.map

package/lib/agentTrace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentTrace.js","sourceRoot":"","sources":["../src/agentTrace.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,6CAAyC;AAGzC;;;;;;;;;GASG;AACH,MAAa,UAAU;IACrB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAsB,EAAE,OAAe;QAClE,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,yFAAyF;QACzF,MAAM,GAAG,GAAG,cAAc,OAAO,EAAE,CAAC;QAEpC,OAAO,SAAS,CAAC,OAAO,CAAqB,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;CACF;AAhBD,gCAgBC"}

package/lib/index.d.ts

@@ -1,8 +1,9 @@
-export { type AgentCreateConfig, type AgentCreateResponse, type AgentJobSpec, type AgentJobSpecCreateConfig, type AgentOptions, type AgentTone, type AgentType, type AgentPreviewMessageLinks, type AgentPreviewMessage, type AgentPreviewStartResponse, type AgentPreviewSendResponse, type AgentPreviewEndResponse, type BotMetadata, type BotVersionMetadata, type DraftAgentTopics, type DraftAgentTopicsBody, type DraftAgentTopicsResponse, type AvailableDefinition, type AgentTestResultsResponse, type AgentTestStartResponse, type AgentTestStatusResponse, type TestCaseResult, type TestStatus, } from './types';
+export { type AgentCreateConfig, type AgentCreateResponse, type AgentJobSpec, type AgentJobSpecCreateConfig, type AgentOptions, type AgentTone, type AgentType, type AgentPreviewMessageLinks, type AgentPreviewMessage, type AgentPreviewStartResponse, type AgentPreviewSendResponse, type AgentPreviewEndResponse, type AgentTraceResponse, type AgentTraceStep, type BotMetadata, type BotVersionMetadata, type DraftAgentTopics, type DraftAgentTopicsBody, type DraftAgentTopicsResponse, type AvailableDefinition, type AgentTestResultsResponse, type AgentTestStartResponse, type AgentTestStatusResponse, type TestCaseResult, type TestStatus, } from './types';
 export { metric } from './utils';
 export { Agent, AgentCreateLifecycleStages } from './agent';
 export { AgentTester } from './agentTester';
 export { AgentTest, AgentTestCreateLifecycleStages } from './agentTest';
+export { AgentTrace } from './agentTrace';
 export { convertTestResultsToFormat, humanFriendlyName } from './agentTestResults';
 export { AgentPreview } from './agentPreview';
 export { writeDebugLog } from './apexUtils';

package/lib/index.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeDebugLog = exports.AgentPreview = exports.humanFriendlyName = exports.convertTestResultsToFormat = exports.AgentTestCreateLifecycleStages = exports.AgentTest = exports.AgentTester = exports.AgentCreateLifecycleStages = exports.Agent = exports.metric = void 0;
+exports.writeDebugLog = exports.AgentPreview = exports.humanFriendlyName = exports.convertTestResultsToFormat = exports.AgentTrace = exports.AgentTestCreateLifecycleStages = exports.AgentTest = exports.AgentTester = exports.AgentCreateLifecycleStages = exports.Agent = exports.metric = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "metric", { enumerable: true, get: function () { return utils_1.metric; } });
 var agent_1 = require("./agent");
@@ -17,6 +17,8 @@ Object.defineProperty(exports, "AgentTester", { enumerable: true, get: function
 var agentTest_1 = require("./agentTest");
 Object.defineProperty(exports, "AgentTest", { enumerable: true, get: function () { return agentTest_1.AgentTest; } });
 Object.defineProperty(exports, "AgentTestCreateLifecycleStages", { enumerable: true, get: function () { return agentTest_1.AgentTestCreateLifecycleStages; } });
+var agentTrace_1 = require("./agentTrace");
+Object.defineProperty(exports, "AgentTrace", { enumerable: true, get: function () { return agentTrace_1.AgentTrace; } });
 var agentTestResults_1 = require("./agentTestResults");
 Object.defineProperty(exports, "convertTestResultsToFormat", { enumerable: true, get: function () { return agentTestResults_1.convertTestResultsToFormat; } });
 Object.defineProperty(exports, "humanFriendlyName", { enumerable: true, get: function () { return agentTestResults_1.humanFriendlyName; } });

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AA2BH,iCAAiC;AAAxB,+FAAA,MAAM,OAAA;AACf,iCAA4D;AAAnD,8FAAA,KAAK,OAAA;AAAE,mHAAA,0BAA0B,OAAA;AAC1C,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,yCAAwE;AAA/D,sGAAA,SAAS,OAAA;AAAE,2HAAA,8BAA8B,OAAA;AAClD,uDAAmF;AAA1E,8HAAA,0BAA0B,OAAA;AAAE,qHAAA,iBAAiB,OAAA;AACtD,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,yCAA4C;AAAnC,0GAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AA6BH,iCAAiC;AAAxB,+FAAA,MAAM,OAAA;AACf,iCAA4D;AAAnD,8FAAA,KAAK,OAAA;AAAE,mHAAA,0BAA0B,OAAA;AAC1C,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,yCAAwE;AAA/D,sGAAA,SAAS,OAAA;AAAE,2HAAA,8BAA8B,OAAA;AAClD,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,uDAAmF;AAA1E,8HAAA,0BAA0B,OAAA;AAAE,qHAAA,iBAAiB,OAAA;AACtD,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,yCAA4C;AAAnC,0GAAA,aAAa,OAAA"}

package/lib/types.d.ts

@@ -458,4 +458,73 @@ export type AgentPreviewEndResponse = {
     _links: AgentPreviewMessageLinks;
 };
 export type EndReason = 'UserRequest' | 'Transfer' | 'Expiration' | 'Error' | 'Other';
+export type AgentTraceStep = UserInputStep | LLMExecutionStep | UpdateTopicStep | EventStep | ReasoningStep | PlannerResponseStep;
+export type UserInputStep = {
+    type: 'UserInputStep';
+    message: string;
+};
+export type LLMExecutionStep = {
+    type: 'LLMExecutionStep';
+    promptName: string;
+    promptContent: string;
+    promptResponse: string;
+    executionLatency: number;
+    startExecutionTime: number;
+    endExecutionTime: number;
+};
+export type UpdateTopicStep = {
+    type: 'UpdateTopicStep';
+    topic: string;
+    description: string;
+    job: string;
+    instructions: string[];
+    availableFunctions: unknown[];
+};
+export type EventStep = {
+    type: 'EventStep';
+    eventName: string;
+    isError: boolean;
+    payload: {
+        oldTopic: string;
+        newTopic: string;
+    };
+};
+export type ReasoningStep = {
+    type: 'ReasoningStep';
+    reason: string;
+};
+export type PlannerResponseStep = {
+    type: 'PlannerResponseStep';
+    message: string;
+    responseType: string;
+    isContentSafe: boolean;
+    safetyScore: {
+        safety_score: number;
+        category_scores: {
+            toxicity: number;
+            hate: number;
+            identity: number;
+            violence: number;
+            physical: number;
+            sexual: number;
+            profanity: number;
+            biased: number;
+        };
+    };
+};
+export type AgentTraceResponse = {
+    actions: Array<{
+        id: string;
+        state: string;
+        returnValue: {
+            type: string;
+            planId: string;
+            sessionId: string;
+            intent: string;
+            topic: string;
+            plan: AgentTraceStep[];
+        };
+        error: unknown[];
+    }>;
+};
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/agents",
   "description": "Client side APIs for working with Salesforce agents",
-  "version": "0.17.1",
+  "version": "0.17.2",
   "license": "BSD-3-Clause",
   "author": "Salesforce",
   "main": "lib/index",