feat!: Rename LDAIMetrics.usage and LDAIGraphMetrics.usage to .tokens (#1366)

jsonbailey · web-flow · commit ca9ebb21e2bb · 2026-05-07T11:58:32.000-05:00
diff --git a/packages/ai-providers/server-ai-langchain/__tests__/LangChainAgentRunner.test.ts b/packages/ai-providers/server-ai-langchain/__tests__/LangChainAgentRunner.test.ts
@@ -27,7 +27,7 @@ it('returns content with no toolCalls when the agent returns a simple response',
   expect(result.content).toBe('done');
   expect(result.metrics.success).toBe(true);
   expect(result.metrics.toolCalls).toBeUndefined();
-  expect(result.metrics.usage).toEqual({ total: 6, input: 4, output: 2 });
+  expect(result.metrics.tokens).toEqual({ total: 6, input: 4, output: 2 });
 });
 
 it('extracts tool calls and aggregates usage from multi-step agent messages', async () => {
@@ -56,7 +56,7 @@ it('extracts tool calls and aggregates usage from multi-step agent messages', as
 
   expect(result.content).toBe('Answer is 42.');
   expect(result.metrics.toolCalls).toEqual(['lookup']);
-  expect(result.metrics.usage).toEqual({ total: 28, input: 16, output: 12 });
+  expect(result.metrics.tokens).toEqual({ total: 28, input: 16, output: 12 });
 });
 
 it('returns success=false when the agent throws', async () => {
@@ -83,5 +83,5 @@ it('handles empty messages array gracefully', async () => {
   expect(result.content).toBe('');
   expect(result.metrics.success).toBe(true);
   expect(result.metrics.toolCalls).toBeUndefined();
-  expect(result.metrics.usage).toBeUndefined();
+  expect(result.metrics.tokens).toBeUndefined();
 });
diff --git a/packages/ai-providers/server-ai-langchain/__tests__/LangChainHelper.test.ts b/packages/ai-providers/server-ai-langchain/__tests__/LangChainHelper.test.ts
@@ -102,7 +102,7 @@ it('returns success=true with usage from the response', () => {
   message.usage_metadata = { total_tokens: 3, input_tokens: 1, output_tokens: 2 };
   expect(getAIMetricsFromResponse(message)).toEqual({
     success: true,
-    usage: { total: 3, input: 1, output: 2 },
+    tokens: { total: 3, input: 1, output: 2 },
   });
 });
 
diff --git a/packages/ai-providers/server-ai-langchain/__tests__/LangChainModelRunner.test.ts b/packages/ai-providers/server-ai-langchain/__tests__/LangChainModelRunner.test.ts
@@ -41,7 +41,7 @@ describe('LangChainModelRunner', () => {
     expect(result.content).toBe('hello');
     expect(result.metrics).toEqual({
       success: true,
-      usage: { total: 12, input: 7, output: 5 },
+      tokens: { total: 12, input: 7, output: 5 },
     });
     expect(result.raw).toBe(response);
   });
diff --git a/packages/ai-providers/server-ai-langchain/src/LangChainAgentRunner.ts b/packages/ai-providers/server-ai-langchain/src/LangChainAgentRunner.ts
@@ -61,7 +61,7 @@ export class LangChainAgentRunner implements Runner {
 
       const metrics: LDAIMetrics = {
         success: true,
-        usage: sumTokenUsageFromMessages(messages),
+        tokens: sumTokenUsageFromMessages(messages),
         toolCalls: toolCalls.length > 0 ? toolCalls : undefined,
       };
 
diff --git a/packages/ai-providers/server-ai-langchain/src/LangChainHelper.ts b/packages/ai-providers/server-ai-langchain/src/LangChainHelper.ts
@@ -80,7 +80,7 @@ export function getAIUsageFromResponse(response: AIMessage): LDTokenUsage | unde
 export function getAIMetricsFromResponse(response: AIMessage): LDAIMetrics {
   return {
     success: true,
-    usage: getAIUsageFromResponse(response),
+    tokens: getAIUsageFromResponse(response),
   };
 }
 
diff --git a/packages/ai-providers/server-ai-langchain/src/LangChainModelRunner.ts b/packages/ai-providers/server-ai-langchain/src/LangChainModelRunner.ts
@@ -96,7 +96,7 @@ export class LangChainModelRunner implements Runner {
 
       const metrics = {
         success: true,
-        usage: { total: 0, input: 0, output: 0 },
+        tokens: { total: 0, input: 0, output: 0 },
       };
 
       return {
@@ -111,7 +111,7 @@ export class LangChainModelRunner implements Runner {
         content: '',
         metrics: {
           success: false,
-          usage: { total: 0, input: 0, output: 0 },
+          tokens: { total: 0, input: 0, output: 0 },
         },
       };
     }
diff --git a/packages/ai-providers/server-ai-openai/__tests__/OpenAIAgentRunner.test.ts b/packages/ai-providers/server-ai-openai/__tests__/OpenAIAgentRunner.test.ts
@@ -32,7 +32,7 @@ describe('OpenAIAgentRunner', () => {
     expect(result.content).toBe('Done');
     expect(result.metrics.success).toBe(true);
     expect(result.metrics.toolCalls).toBeUndefined();
-    expect(result.metrics.usage).toEqual({ total: 12, input: 8, output: 4 });
+    expect(result.metrics.tokens).toEqual({ total: 12, input: 8, output: 4 });
   });
 
   it('reports tool calls from newItems with LD config name mapping', async () => {
@@ -55,7 +55,7 @@ describe('OpenAIAgentRunner', () => {
 
     expect(result.content).toBe('The answer is 42.');
     expect(result.metrics.toolCalls).toEqual(['lookup']);
-    expect(result.metrics.usage).toEqual({ total: 28, input: 16, output: 12 });
+    expect(result.metrics.tokens).toEqual({ total: 28, input: 16, output: 12 });
   });
 
   it('returns an unsuccessful RunnerResult when the agent run throws', async () => {
diff --git a/packages/ai-providers/server-ai-openai/__tests__/OpenAIHelper.test.ts b/packages/ai-providers/server-ai-openai/__tests__/OpenAIHelper.test.ts
@@ -41,7 +41,7 @@ it('returns success=true with usage extracted from the response', () => {
 
   expect(metrics).toEqual({
     success: true,
-    usage: { total: 3, input: 1, output: 2 },
+    tokens: { total: 3, input: 1, output: 2 },
   });
 });
 
diff --git a/packages/ai-providers/server-ai-openai/__tests__/OpenAIModelRunner.test.ts b/packages/ai-providers/server-ai-openai/__tests__/OpenAIModelRunner.test.ts
@@ -46,7 +46,7 @@ describe('OpenAIModelRunner', () => {
       expect(result.content).toBe('Hello there!');
       expect(result.metrics).toEqual({
         success: true,
-        usage: { total: 15, input: 10, output: 5 },
+        tokens: { total: 15, input: 10, output: 5 },
       });
       expect(result.raw).toBe(mockResponse);
       expect(result.parsed).toBeUndefined();
diff --git a/packages/ai-providers/server-ai-openai/src/OpenAIAgentRunner.ts b/packages/ai-providers/server-ai-openai/src/OpenAIAgentRunner.ts
@@ -61,10 +61,10 @@ export class OpenAIAgentRunner implements Runner {
         [],
       );
 
-      const usage: LDTokenUsage | undefined = getAIUsageFromAgentResult(result);
+      const tokens: LDTokenUsage | undefined = getAIUsageFromAgentResult(result);
       const metrics: LDAIMetrics = {
         success: true,
-        usage,
+        tokens,
         toolCalls: toolCalls.length > 0 ? toolCalls : undefined,
       };
 
diff --git a/packages/ai-providers/server-ai-openai/src/OpenAIHelper.ts b/packages/ai-providers/server-ai-openai/src/OpenAIHelper.ts
@@ -42,7 +42,7 @@ export function getAIUsageFromResponse(response: any): LDTokenUsage | undefined
 export function getAIMetricsFromResponse(response: any): LDAIMetrics {
   return {
     success: true,
-    usage: getAIUsageFromResponse(response),
+    tokens: getAIUsageFromResponse(response),
   };
 }
 
diff --git a/packages/ai-providers/server-ai-vercel/__tests__/VercelHelper.test.ts b/packages/ai-providers/server-ai-vercel/__tests__/VercelHelper.test.ts
@@ -62,7 +62,7 @@ describe('getAIMetricsFromResponse', () => {
       getAIMetricsFromResponse({
         usage: { totalTokens: 5, promptTokens: 2, completionTokens: 3 },
       }),
-    ).toEqual({ success: true, usage: { total: 5, input: 2, output: 3 } });
+    ).toEqual({ success: true, tokens: { total: 5, input: 2, output: 3 } });
   });
 
   it('marks success=false when finishReason is "error"', () => {
@@ -83,7 +83,7 @@ describe('getAIMetricsFromStream', () => {
     });
     expect(result).toEqual({
       success: true,
-      usage: { total: 100, input: 49, output: 51 },
+      tokens: { total: 100, input: 49, output: 51 },
     });
   });
 
diff --git a/packages/ai-providers/server-ai-vercel/__tests__/VercelModelRunner.test.ts b/packages/ai-providers/server-ai-vercel/__tests__/VercelModelRunner.test.ts
@@ -51,7 +51,7 @@ describe('VercelModelRunner', () => {
       expect(out.content).toBe('Hi!');
       expect(out.metrics).toEqual({
         success: true,
-        usage: { total: 12, input: 7, output: 5 },
+        tokens: { total: 12, input: 7, output: 5 },
       });
       expect(out.raw).toBe(result);
     });
@@ -87,7 +87,7 @@ describe('VercelModelRunner', () => {
 
       const out = await runner.run('hello');
 
-      expect(out.metrics.usage).toEqual({ total: 100, input: 40, output: 60 });
+      expect(out.metrics.tokens).toEqual({ total: 100, input: 40, output: 60 });
     });
 
     it('returns success=false when generateText throws', async () => {
diff --git a/packages/ai-providers/server-ai-vercel/src/VercelHelper.ts b/packages/ai-providers/server-ai-vercel/src/VercelHelper.ts
@@ -44,16 +44,16 @@ export function mapUsageDataToLDTokenUsage(usageData: ModelUsageTokens): LDToken
 export function getAIMetricsFromResponse(response: TextResponse): LDAIMetrics {
   const finishReason = response?.finishReason ?? 'unknown';
 
-  let usage: LDTokenUsage | undefined;
+  let tokens: LDTokenUsage | undefined;
   if (response?.totalUsage) {
-    usage = mapUsageDataToLDTokenUsage(response.totalUsage);
+    tokens = mapUsageDataToLDTokenUsage(response.totalUsage);
   } else if (response?.usage) {
-    usage = mapUsageDataToLDTokenUsage(response.usage);
+    tokens = mapUsageDataToLDTokenUsage(response.usage);
   }
 
   return {
     success: finishReason !== 'error',
-    usage,
+    tokens,
   };
 }
 
@@ -66,24 +66,24 @@ export function getAIMetricsFromResponse(response: TextResponse): LDAIMetrics {
 export async function getAIMetricsFromStream(stream: StreamResponse): Promise<LDAIMetrics> {
   const finishReason = (await stream.finishReason?.catch(() => 'error')) ?? 'unknown';
 
-  let usage: LDTokenUsage | undefined;
+  let tokens: LDTokenUsage | undefined;
 
   if (stream.totalUsage) {
     const usageData = await stream.totalUsage.catch(() => undefined);
     if (usageData) {
-      usage = mapUsageDataToLDTokenUsage(usageData);
+      tokens = mapUsageDataToLDTokenUsage(usageData);
     }
   }
 
-  if (!usage && stream.usage) {
+  if (!tokens && stream.usage) {
     const usageData = await stream.usage.catch(() => undefined);
     if (usageData) {
-      usage = mapUsageDataToLDTokenUsage(usageData);
+      tokens = mapUsageDataToLDTokenUsage(usageData);
     }
   }
 
   return {
     success: finishReason !== 'error',
-    usage,
+    tokens,
   };
 }
diff --git a/packages/sdk/server-ai/__tests__/Judge.test.ts b/packages/sdk/server-ai/__tests__/Judge.test.ts
@@ -192,7 +192,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: {
+          tokens: {
             total: 100,
             input: 50,
             output: 50,
@@ -254,7 +254,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -283,7 +283,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -356,7 +356,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -391,7 +391,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -426,7 +426,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -462,7 +462,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -512,7 +512,7 @@ describe('Judge', () => {
         parsed: undefined,
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -538,7 +538,7 @@ describe('Judge', () => {
         parsed: {},
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -568,7 +568,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
@@ -642,7 +642,7 @@ describe('Judge', () => {
         },
         metrics: {
           success: true,
-          usage: { total: 100, input: 50, output: 50 },
+          tokens: { total: 100, input: 50, output: 50 },
         },
       };
 
diff --git a/packages/sdk/server-ai/__tests__/LDAIConfigTrackerImpl.test.ts b/packages/sdk/server-ai/__tests__/LDAIConfigTrackerImpl.test.ts
@@ -723,7 +723,7 @@ describe('trackMetricsOf', () => {
     const mockResult = { response: 'test' };
     const mockMetrics = {
       success: true,
-      usage: { total: 100, input: 50, output: 50 },
+      tokens: { total: 100, input: 50, output: 50 },
     };
 
     const metricsExtractor = jest.fn().mockReturnValue(mockMetrics);
diff --git a/packages/sdk/server-ai/__tests__/ManagedAgentGraph.test.ts b/packages/sdk/server-ai/__tests__/ManagedAgentGraph.test.ts
@@ -68,10 +68,10 @@ describe('ManagedAgentGraph', () => {
         success: true,
         path: ['node-a', 'node-b'],
         durationMs: 1500,
-        usage: { total: 100, input: 50, output: 50 },
+        tokens: { total: 100, input: 50, output: 50 },
         nodeMetrics: {
-          'node-a': { success: true, usage: { total: 40, input: 20, output: 20 } },
-          'node-b': { success: true, usage: { total: 60, input: 30, output: 30 } },
+          'node-a': { success: true, tokens: { total: 40, input: 20, output: 20 } },
+          'node-b': { success: true, tokens: { total: 60, input: 30, output: 30 } },
         },
       },
     };
@@ -103,7 +103,7 @@ describe('ManagedAgentGraph', () => {
         nodeMetrics: {
           n1: {
             success: true,
-            usage: { total: 10, input: 5, output: 5 },
+            tokens: { total: 10, input: 5, output: 5 },
             durationMs: 200,
             toolCalls: ['tool-a'],
           },
diff --git a/packages/sdk/server-ai/__tests__/ManagedModel.test.ts b/packages/sdk/server-ai/__tests__/ManagedModel.test.ts
@@ -50,7 +50,7 @@ describe('ManagedModel', () => {
   it('passes the prompt directly to the runner without prepending config messages', async () => {
     const runnerResult: RunnerResult = {
       content: 'Response from model',
-      metrics: { success: true, usage: { total: 10, input: 4, output: 6 } },
+      metrics: { success: true, tokens: { total: 10, input: 4, output: 6 } },
     };
 
     mockTracker.trackMetricsOf.mockImplementation(async (_extractor, func) => func());
@@ -68,7 +68,7 @@ describe('ManagedModel', () => {
       content: 'Hi there',
       metrics: {
         success: true,
-        usage: { total: 12, input: 5, output: 7 },
+        tokens: { total: 12, input: 5, output: 7 },
         toolCalls: ['tool-1'],
         durationMs: 42,
       },
@@ -99,7 +99,7 @@ describe('ManagedModel', () => {
   it('forwards the runner result through tracker.trackMetricsOf', async () => {
     const runnerResult: RunnerResult = {
       content: 'tracked',
-      metrics: { success: true, usage: { total: 1, input: 1, output: 0 } },
+      metrics: { success: true, tokens: { total: 1, input: 1, output: 0 } },
     };
 
     mockTracker.trackMetricsOf.mockImplementation(async (_extractor, func) => func());
@@ -117,7 +117,7 @@ describe('ManagedModel', () => {
   it('does not retain conversation state across runs', async () => {
     const runnerResult: RunnerResult = {
       content: 'ok',
-      metrics: { success: true, usage: { total: 1, input: 1, output: 0 } },
+      metrics: { success: true, tokens: { total: 1, input: 1, output: 0 } },
     };
 
     mockTracker.trackMetricsOf.mockImplementation(async (_extractor, func) => func());
diff --git a/packages/sdk/server-ai/src/LDAIConfigTrackerImpl.ts b/packages/sdk/server-ai/src/LDAIConfigTrackerImpl.ts
diff --git a/packages/sdk/server-ai/src/api/graph/ManagedAgentGraph.ts b/packages/sdk/server-ai/src/api/graph/ManagedAgentGraph.ts
diff --git a/packages/sdk/server-ai/src/api/graph/types.ts b/packages/sdk/server-ai/src/api/graph/types.ts
diff --git a/packages/sdk/server-ai/src/api/metrics/LDAIMetrics.ts b/packages/sdk/server-ai/src/api/metrics/LDAIMetrics.ts

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ export function getAIUsageFromResponse(response: AIMessage): LDTokenUsage \| unde`
`80`	`80`	`export function getAIMetricsFromResponse(response: AIMessage): LDAIMetrics {`
`81`	`81`	`return {`
`82`	`82`	`success: true,`
`83`		`- usage: getAIUsageFromResponse(response),`
	`83`	`+ tokens: getAIUsageFromResponse(response),`
`84`	`84`	`};`
`85`	`85`	`}`
`86`	`86`