ai 3.2.19 → 3.2.20

package/dist/index.d.mts

@@ -4,6 +4,7 @@ import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageM
 export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ServerResponse } from 'http';
+import { AttributeValue, Span } from '@opentelemetry/api';
 import { ServerResponse as ServerResponse$1 } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
@@ -921,6 +922,24 @@ declare class InvalidMessageRoleError extends Error {
     };
 }
 
+/**
+ * Telemetry configuration.
+ */
+type TelemetrySettings = {
+    /**
+     * Enable or disable telemetry. Disabled by default while experimental.
+     */
+    isEnabled?: boolean;
+    /**
+     * Identifier for this function. Used to group telemetry data by function.
+     */
+    functionId?: string;
+    /**
+     * Additional information to include in the telemetry data.
+     */
+    metadata?: Record<string, AttributeValue>;
+};
+
 type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
@@ -970,7 +989,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1000,6 +1019,10 @@ case of misconfigured tools.
 By default, it's set to 0, which will disable the feature.
      */
     maxToolRoundtrips?: number;
+    /**
+     * Optional telemetry configuration (experimental).
+     */
+    experimental_telemetry?: TelemetrySettings;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.
@@ -1109,7 +1132,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, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1123,6 +1146,10 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
+     * Optional telemetry configuration (experimental).
+     */
+    experimental_telemetry?: TelemetrySettings;
+    /**
 Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
      */
@@ -1221,13 +1248,15 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
          */
         headers?: Record<string, string>;
     };
-    constructor({ stream, warnings, rawResponse, onFinish, }: {
+    constructor({ stream, warnings, rawResponse, onFinish, rootSpan, doStreamSpan, }: {
         stream: ReadableStream<TextStreamPart<TOOLS>>;
         warnings: CallWarning[] | undefined;
         rawResponse?: {
             headers?: Record<string, string>;
         };
         onFinish?: Parameters<typeof streamText>[0]['onFinish'];
+        rootSpan: Span;
+        doStreamSpan: Span;
     });
     /**
   Split out a new stream from the original stream.

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageM
 export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ServerResponse } from 'http';
+import { AttributeValue, Span } from '@opentelemetry/api';
 import { ServerResponse as ServerResponse$1 } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
@@ -921,6 +922,24 @@ declare class InvalidMessageRoleError extends Error {
     };
 }
 
+/**
+ * Telemetry configuration.
+ */
+type TelemetrySettings = {
+    /**
+     * Enable or disable telemetry. Disabled by default while experimental.
+     */
+    isEnabled?: boolean;
+    /**
+     * Identifier for this function. Used to group telemetry data by function.
+     */
+    functionId?: string;
+    /**
+     * Additional information to include in the telemetry data.
+     */
+    metadata?: Record<string, AttributeValue>;
+};
+
 type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
@@ -970,7 +989,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1000,6 +1019,10 @@ case of misconfigured tools.
 By default, it's set to 0, which will disable the feature.
      */
     maxToolRoundtrips?: number;
+    /**
+     * Optional telemetry configuration (experimental).
+     */
+    experimental_telemetry?: TelemetrySettings;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.
@@ -1109,7 +1132,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, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1123,6 +1146,10 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
+     * Optional telemetry configuration (experimental).
+     */
+    experimental_telemetry?: TelemetrySettings;
+    /**
 Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
      */
@@ -1221,13 +1248,15 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
          */
         headers?: Record<string, string>;
     };
-    constructor({ stream, warnings, rawResponse, onFinish, }: {
+    constructor({ stream, warnings, rawResponse, onFinish, rootSpan, doStreamSpan, }: {
         stream: ReadableStream<TextStreamPart<TOOLS>>;
         warnings: CallWarning[] | undefined;
         rawResponse?: {
             headers?: Record<string, string>;
         };
         onFinish?: Parameters<typeof streamText>[0]['onFinish'];
+        rootSpan: Span;
+        doStreamSpan: Span;
     });
     /**
   Split out a new stream from the original stream.