ai 3.3.24 → 3.3.25

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ai
 
+## 3.3.25
+
+### Patch Changes
+
+- 4f1530f: feat (ai/core): add OpenTelemetry Semantic Conventions for GenAI operations to v1.27.0 of standard
+- dad775f: feat (ai/core): add finish event and avg output tokens per second (telemetry)
+
 ## 3.3.24
 
 ### Patch Changes

package/dist/index.d.mts

@@ -924,6 +924,12 @@ Optional telemetry configuration (experimental).
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<OBJECT>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>>;
 /**
 Generate an array with structured, typed elements for a given prompt and element schema using a language model.
@@ -977,6 +983,12 @@ Optional telemetry configuration (experimental).
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<Array<ELEMENT>>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>>;
 /**
 Generate JSON with any schema for a given prompt using a language model.
@@ -1004,6 +1016,12 @@ Optional telemetry configuration (experimental).
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<JSONValue>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamObjectResult<JSONValue, JSONValue, never>>;
 /**
  * @deprecated Use `streamObject` instead.
@@ -1562,7 +1580,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1649,6 +1667,12 @@ Callback that is called when the LLM response and all request tool executions
      */
         readonly experimental_providerMetadata: ProviderMetadata | undefined;
     }) => Promise<void> | void;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamTextResult<TOOLS>>;
 
 /**

package/dist/index.d.ts

@@ -924,6 +924,12 @@ Optional telemetry configuration (experimental).
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<OBJECT>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>>;
 /**
 Generate an array with structured, typed elements for a given prompt and element schema using a language model.
@@ -977,6 +983,12 @@ Optional telemetry configuration (experimental).
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<Array<ELEMENT>>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamObjectResult<Array<ELEMENT>, Array<ELEMENT>, AsyncIterableStream<ELEMENT>>>;
 /**
 Generate JSON with any schema for a given prompt using a language model.
@@ -1004,6 +1016,12 @@ Optional telemetry configuration (experimental).
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<JSONValue>;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamObjectResult<JSONValue, JSONValue, never>>;
 /**
  * @deprecated Use `streamObject` instead.
@@ -1562,7 +1580,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1649,6 +1667,12 @@ Callback that is called when the LLM response and all request tool executions
      */
         readonly experimental_providerMetadata: ProviderMetadata | undefined;
     }) => Promise<void> | void;
+    /**
+     * Internal. For test use only. May change without notice.
+     */
+    _internal?: {
+        now?: () => number;
+    };
 }): Promise<StreamTextResult<TOOLS>>;
 
 /**

package/dist/index.js

@@ -1819,10 +1819,13 @@ async function generateObject({
                   },
                   "ai.settings.mode": mode,
                   // standardized gen-ai llm span attributes:
-                  "gen_ai.request.model": model.modelId,
                   "gen_ai.system": model.provider,
+                  "gen_ai.request.model": model.modelId,
+                  "gen_ai.request.frequency_penalty": settings.frequencyPenalty,
                   "gen_ai.request.max_tokens": settings.maxTokens,
+                  "gen_ai.request.presence_penalty": settings.presencePenalty,
                   "gen_ai.request.temperature": settings.temperature,
+                  "gen_ai.request.top_k": settings.topK,
                   "gen_ai.request.top_p": settings.topP
                 }
               }),
@@ -1848,9 +1851,12 @@ async function generateObject({
                   selectTelemetryAttributes({
                     telemetry,
                     attributes: {
-                      "ai.finishReason": result2.finishReason,
+                      "ai.response.finishReason": result2.finishReason,
+                      "ai.response.object": { output: () => result2.text },
                       "ai.usage.promptTokens": result2.usage.promptTokens,
                       "ai.usage.completionTokens": result2.usage.completionTokens,
+                      // deprecated:
+                      "ai.finishReason": result2.finishReason,
                       "ai.result.object": { output: () => result2.text },
                       // standardized gen-ai llm span attributes:
                       "gen_ai.response.finish_reasons": [result2.finishReason],
@@ -1902,10 +1908,13 @@ async function generateObject({
                   },
                   "ai.settings.mode": mode,
                   // standardized gen-ai llm span attributes:
-                  "gen_ai.request.model": model.modelId,
                   "gen_ai.system": model.provider,
+                  "gen_ai.request.model": model.modelId,
+                  "gen_ai.request.frequency_penalty": settings.frequencyPenalty,
                   "gen_ai.request.max_tokens": settings.maxTokens,
+                  "gen_ai.request.presence_penalty": settings.presencePenalty,
                   "gen_ai.request.temperature": settings.temperature,
+                  "gen_ai.request.top_k": settings.topK,
                   "gen_ai.request.top_p": settings.topP
                 }
               }),
@@ -1936,14 +1945,17 @@ async function generateObject({
                   selectTelemetryAttributes({
                     telemetry,
                     attributes: {
-                      "ai.finishReason": result2.finishReason,
+                      "ai.response.finishReason": result2.finishReason,
+                      "ai.response.object": { output: () => objectText },
                       "ai.usage.promptTokens": result2.usage.promptTokens,
                       "ai.usage.completionTokens": result2.usage.completionTokens,
+                      // deprecated:
+                      "ai.finishReason": result2.finishReason,
                       "ai.result.object": { output: () => objectText },
                       // standardized gen-ai llm span attributes:
                       "gen_ai.response.finish_reasons": [result2.finishReason],
-                      "gen_ai.usage.prompt_tokens": result2.usage.promptTokens,
-                      "gen_ai.usage.completion_tokens": result2.usage.completionTokens
+                      "gen_ai.usage.input_tokens": result2.usage.promptTokens,
+                      "gen_ai.usage.output_tokens": result2.usage.completionTokens
                     }
                   })
                 );
@@ -1984,9 +1996,14 @@ async function generateObject({
         selectTelemetryAttributes({
           telemetry,
           attributes: {
-            "ai.finishReason": finishReason,
+            "ai.response.finishReason": finishReason,
+            "ai.response.object": {
+              output: () => JSON.stringify(validationResult.value)
+            },
             "ai.usage.promptTokens": usage.promptTokens,
             "ai.usage.completionTokens": usage.completionTokens,
+            // deprecated:
+            "ai.finishReason": finishReason,
             "ai.result.object": {
               output: () => JSON.stringify(validationResult.value)
             }
@@ -2105,6 +2122,7 @@ async function streamObject({
   headers,
   experimental_telemetry: telemetry,
   onFinish,
+  _internal: { now: now2 = now } = {},
   ...settings
 }) {
   var _a11;
@@ -2270,17 +2288,20 @@ async function streamObject({
               },
               "ai.settings.mode": mode,
               // standardized gen-ai llm span attributes:
-              "gen_ai.request.model": model.modelId,
               "gen_ai.system": model.provider,
+              "gen_ai.request.model": model.modelId,
+              "gen_ai.request.frequency_penalty": settings.frequencyPenalty,
               "gen_ai.request.max_tokens": settings.maxTokens,
+              "gen_ai.request.presence_penalty": settings.presencePenalty,
               "gen_ai.request.temperature": settings.temperature,
+              "gen_ai.request.top_k": settings.topK,
               "gen_ai.request.top_p": settings.topP
             }
           }),
           tracer,
           endWhenDone: false,
           fn: async (doStreamSpan2) => ({
-            startTimestampMs: now(),
+            startTimestampMs: now2(),
             doStreamSpan: doStreamSpan2,
             result: await model.doStream(callOptions)
           })
@@ -2295,7 +2316,8 @@ async function streamObject({
         rootSpan,
         doStreamSpan,
         telemetry,
-        startTimestampMs
+        startTimestampMs,
+        now: now2
       });
     }
   });
@@ -2310,7 +2332,8 @@ var DefaultStreamObjectResult = class {
     rootSpan,
     doStreamSpan,
     telemetry,
-    startTimestampMs
+    startTimestampMs,
+    now: now2
   }) {
     this.warnings = warnings;
     this.rawResponse = rawResponse;
@@ -2339,7 +2362,7 @@ var DefaultStreamObjectResult = class {
       new TransformStream({
         async transform(chunk, controller) {
           if (isFirstChunk) {
-            const msToFirstChunk = now() - startTimestampMs;
+            const msToFirstChunk = now2() - startTimestampMs;
             isFirstChunk = false;
             doStreamSpan.addEvent("ai.stream.firstChunk", {
               "ai.stream.msToFirstChunk": msToFirstChunk
@@ -2416,15 +2439,18 @@ var DefaultStreamObjectResult = class {
               selectTelemetryAttributes({
                 telemetry,
                 attributes: {
-                  "ai.finishReason": finishReason,
-                  "ai.usage.promptTokens": finalUsage.promptTokens,
-                  "ai.usage.completionTokens": finalUsage.completionTokens,
-                  "ai.result.object": {
+                  "ai.response.finishReason": finishReason,
+                  "ai.response.object": {
                     output: () => JSON.stringify(object)
                   },
+                  "ai.usage.promptTokens": finalUsage.promptTokens,
+                  "ai.usage.completionTokens": finalUsage.completionTokens,
+                  // deprecated
+                  "ai.finishReason": finishReason,
+                  "ai.result.object": { output: () => JSON.stringify(object) },
                   // standardized gen-ai llm span attributes:
-                  "gen_ai.usage.prompt_tokens": finalUsage.promptTokens,
-                  "gen_ai.usage.completion_tokens": finalUsage.completionTokens,
+                  "gen_ai.usage.input_tokens": finalUsage.promptTokens,
+                  "gen_ai.usage.output_tokens": finalUsage.completionTokens,
                   "gen_ai.response.finish_reasons": [finishReason]
                 }
               })
@@ -2436,9 +2462,11 @@ var DefaultStreamObjectResult = class {
                 attributes: {
                   "ai.usage.promptTokens": finalUsage.promptTokens,
                   "ai.usage.completionTokens": finalUsage.completionTokens,
-                  "ai.result.object": {
+                  "ai.response.object": {
                     output: () => JSON.stringify(object)
-                  }
+                  },
+                  // deprecated
+                  "ai.result.object": { output: () => JSON.stringify(object) }
                 }
               })
             );
@@ -2817,10 +2845,14 @@ async function generateText({
                   input: () => JSON.stringify(promptMessages)
                 },
                 // standardized gen-ai llm span attributes:
-                "gen_ai.request.model": model.modelId,
                 "gen_ai.system": model.provider,
+                "gen_ai.request.model": model.modelId,
+                "gen_ai.request.frequency_penalty": settings.frequencyPenalty,
                 "gen_ai.request.max_tokens": settings.maxTokens,
+                "gen_ai.request.presence_penalty": settings.presencePenalty,
+                "gen_ai.request.stop_sequences": settings.stopSequences,
                 "gen_ai.request.temperature": settings.temperature,
+                "gen_ai.request.top_k": settings.topK,
                 "gen_ai.request.top_p": settings.topP
               }
             }),
@@ -2838,9 +2870,17 @@ async function generateText({
                 selectTelemetryAttributes({
                   telemetry,
                   attributes: {
-                    "ai.finishReason": result.finishReason,
+                    "ai.response.finishReason": result.finishReason,
+                    "ai.response.text": {
+                      output: () => result.text
+                    },
+                    "ai.response.toolCalls": {
+                      output: () => JSON.stringify(result.toolCalls)
+                    },
                     "ai.usage.promptTokens": result.usage.promptTokens,
                     "ai.usage.completionTokens": result.usage.completionTokens,
+                    // deprecated:
+                    "ai.finishReason": result.finishReason,
                     "ai.result.text": {
                       output: () => result.text
                     },
@@ -2849,8 +2889,8 @@ async function generateText({
                     },
                     // standardized gen-ai llm span attributes:
                     "gen_ai.response.finish_reasons": [result.finishReason],
-                    "gen_ai.usage.prompt_tokens": result.usage.promptTokens,
-                    "gen_ai.usage.completion_tokens": result.usage.completionTokens
+                    "gen_ai.usage.input_tokens": result.usage.promptTokens,
+                    "gen_ai.usage.output_tokens": result.usage.completionTokens
                   }
                 })
               );
@@ -2903,9 +2943,17 @@ async function generateText({
         selectTelemetryAttributes({
           telemetry,
           attributes: {
-            "ai.finishReason": currentModelResponse.finishReason,
+            "ai.response.finishReason": currentModelResponse.finishReason,
+            "ai.response.text": {
+              output: () => currentModelResponse.text
+            },
+            "ai.response.toolCalls": {
+              output: () => JSON.stringify(currentModelResponse.toolCalls)
+            },
             "ai.usage.promptTokens": currentModelResponse.usage.promptTokens,
             "ai.usage.completionTokens": currentModelResponse.usage.completionTokens,
+            // deprecated:
+            "ai.finishReason": currentModelResponse.finishReason,
             "ai.result.text": {
               output: () => currentModelResponse.text
             },
@@ -3363,6 +3411,7 @@ async function streamText({
   experimental_toolCallStreaming: toolCallStreaming = false,
   onChunk,
   onFinish,
+  _internal: { now: now2 = now } = {},
   ...settings
 }) {
   var _a11;
@@ -3416,17 +3465,21 @@ async function streamText({
                   input: () => JSON.stringify(promptMessages2)
                 },
                 // standardized gen-ai llm span attributes:
-                "gen_ai.request.model": model.modelId,
                 "gen_ai.system": model.provider,
+                "gen_ai.request.model": model.modelId,
+                "gen_ai.request.frequency_penalty": settings.frequencyPenalty,
                 "gen_ai.request.max_tokens": settings.maxTokens,
+                "gen_ai.request.presence_penalty": settings.presencePenalty,
+                "gen_ai.request.stop_sequences": settings.stopSequences,
                 "gen_ai.request.temperature": settings.temperature,
+                "gen_ai.request.top_k": settings.topK,
                 "gen_ai.request.top_p": settings.topP
               }
             }),
             tracer,
             endWhenDone: false,
             fn: async (doStreamSpan3) => ({
-              startTimestampMs: now(),
+              startTimestampMs: now2(),
               // get before the call
               doStreamSpan: doStreamSpan3,
               result: await model.doStream({
@@ -3483,7 +3536,8 @@ async function streamText({
         startTimestampMs,
         maxToolRoundtrips,
         startRoundtrip,
-        promptMessages
+        promptMessages,
+        now: now2
       });
     }
   });
@@ -3501,7 +3555,8 @@ var DefaultStreamTextResult = class {
     startTimestampMs,
     maxToolRoundtrips,
     startRoundtrip,
-    promptMessages
+    promptMessages,
+    now: now2
   }) {
     this.warnings = warnings;
     this.rawResponse = rawResponse;
@@ -3556,12 +3611,16 @@ var DefaultStreamTextResult = class {
           new TransformStream({
             async transform(chunk, controller) {
               if (roundtripFirstChunk) {
-                const msToFirstChunk = now() - startTimestamp;
+                const msToFirstChunk = now2() - startTimestamp;
                 roundtripFirstChunk = false;
                 doStreamSpan2.addEvent("ai.stream.firstChunk", {
+                  "ai.response.msToFirstChunk": msToFirstChunk,
+                  // deprecated:
                   "ai.stream.msToFirstChunk": msToFirstChunk
                 });
                 doStreamSpan2.setAttributes({
+                  "ai.response.msToFirstChunk": msToFirstChunk,
+                  // deprecated:
                   "ai.stream.msToFirstChunk": msToFirstChunk
                 });
               }
@@ -3590,6 +3649,12 @@ var DefaultStreamTextResult = class {
                   roundtripFinishReason = chunk.finishReason;
                   roundtripProviderMetadata = chunk.experimental_providerMetadata;
                   roundtripLogProbs = chunk.logprobs;
+                  const msToFinish = now2() - startTimestamp;
+                  doStreamSpan2.addEvent("ai.stream.finish");
+                  doStreamSpan2.setAttributes({
+                    "ai.response.msToFinish": msToFinish,
+                    "ai.response.avgCompletionTokensPerSecond": 1e3 * roundtripUsage.completionTokens / msToFinish
+                  });
                   break;
                 case "tool-call-streaming-start":
                 case "tool-call-delta": {
@@ -3622,17 +3687,23 @@ var DefaultStreamTextResult = class {
                   selectTelemetryAttributes({
                     telemetry,
                     attributes: {
-                      "ai.finishReason": roundtripFinishReason,
+                      "ai.response.finishReason": roundtripFinishReason,
+                      "ai.response.text": { output: () => roundtripText },
+                      "ai.response.toolCalls": {
+                        output: () => telemetryToolCalls
+                      },
                       "ai.usage.promptTokens": roundtripUsage.promptTokens,
                       "ai.usage.completionTokens": roundtripUsage.completionTokens,
+                      // deprecated
+                      "ai.finishReason": roundtripFinishReason,
                       "ai.result.text": { output: () => roundtripText },
                       "ai.result.toolCalls": {
                         output: () => telemetryToolCalls
                       },
                       // standardized gen-ai llm span attributes:
                       "gen_ai.response.finish_reasons": [roundtripFinishReason],
-                      "gen_ai.usage.prompt_tokens": roundtripUsage.promptTokens,
-                      "gen_ai.usage.completion_tokens": roundtripUsage.completionTokens
+                      "gen_ai.usage.input_tokens": roundtripUsage.promptTokens,
+                      "gen_ai.usage.output_tokens": roundtripUsage.completionTokens
                     }
                   })
                 );
@@ -3693,9 +3764,15 @@ var DefaultStreamTextResult = class {
                   selectTelemetryAttributes({
                     telemetry,
                     attributes: {
-                      "ai.finishReason": roundtripFinishReason,
+                      "ai.response.finishReason": roundtripFinishReason,
+                      "ai.response.text": { output: () => roundtripText },
+                      "ai.response.toolCalls": {
+                        output: () => telemetryToolCalls
+                      },
                       "ai.usage.promptTokens": combinedUsage.promptTokens,
                       "ai.usage.completionTokens": combinedUsage.completionTokens,
+                      // deprecated
+                      "ai.finishReason": roundtripFinishReason,
                       "ai.result.text": { output: () => roundtripText },
                       "ai.result.toolCalls": {
                         output: () => telemetryToolCalls