@ai-sdk/workflow 1.0.0-canary.42 → 1.0.0-canary.44

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @ai-sdk/workflow
 
+## 1.0.0-canary.44
+
+### Patch Changes
+
+- Updated dependencies [d848405]
+  - @ai-sdk/provider-utils@5.0.0-canary.37
+  - ai@7.0.0-canary.128
+
+## 1.0.0-canary.43
+
+### Patch Changes
+
+- d775a57: feat: introduce Instructions type
+- 39dad72: feat(workflow): add stable telemetry integration support to `WorkflowAgent` and remove legacy telemetry options.
+- Updated dependencies [e95e38d]
+- Updated dependencies [016e877]
+- Updated dependencies [ca99fea]
+- Updated dependencies [ca39020]
+- Updated dependencies [d775a57]
+- Updated dependencies [538c12b]
+  - ai@7.0.0-canary.127
+  - @ai-sdk/provider-utils@5.0.0-canary.36
+
 ## 1.0.0-canary.42
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4CallOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
 import { Context, HasRequiredKey, InferToolSetContext } from '@ai-sdk/provider-utils';
-import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, GenerateTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+import { ToolSet, LanguageModel, Instructions, ToolChoice, TelemetryOptions as TelemetryOptions$1, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, GenerateTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -58,41 +58,7 @@ type WorkflowAgentToolsContextParameter<TTools extends ToolSet> = HasRequiredKey
 } : {
     toolsContext?: never;
 };
-/**
- * Telemetry settings for observability.
- */
-interface TelemetryOptions {
-    /**
-     * Enable or disable telemetry. Defaults to true.
-     */
-    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, string | number | boolean | Array<string | number | boolean> | null | undefined>;
-    /**
-     * Enable or disable input recording. Enabled by default.
-     *
-     * You might want to disable input recording to avoid recording sensitive
-     * information, to reduce data transfers, or to increase performance.
-     */
-    recordInputs?: boolean;
-    /**
-     * Enable or disable output recording. Enabled by default.
-     *
-     * You might want to disable output recording to avoid recording sensitive
-     * information, to reduce data transfers, or to increase performance.
-     */
-    recordOutputs?: boolean;
-    /**
-     * Custom tracer for the telemetry.
-     */
-    tracer?: unknown;
-}
+type TelemetryOptions<TRuntimeContext extends Context = Context, TTools extends ToolSet = ToolSet> = TelemetryOptions$1<TRuntimeContext, TTools>;
 /**
  * A transformation that is applied to the stream.
  */
@@ -270,13 +236,9 @@ type PrepareStepCallback<TTools extends ToolSet = ToolSet, TRuntimeContext exten
 interface PrepareCallOptions<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context> extends Partial<GenerationSettings> {
     model: LanguageModel;
     tools: TTools;
-    instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
+    instructions?: Instructions;
     toolChoice?: ToolChoice<TTools>;
-    telemetry?: TelemetryOptions;
-    /**
-     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
-     */
-    experimental_telemetry?: TelemetryOptions;
+    telemetry?: TelemetryOptions<TRuntimeContext, TTools>;
     /**
      * Runtime context that flows through the agent loop.
      * Treat as immutable; return a new `runtimeContext` to update it for the call.
@@ -324,7 +286,7 @@ type WorkflowAgentOptions<TTools extends ToolSet = ToolSet, TRuntimeContext exte
      * Agent instructions. Can be a string, a SystemModelMessage, or an array of SystemModelMessages.
      * Supports provider-specific options (e.g., caching) when using the SystemModelMessage form.
      */
-    instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
+    instructions?: Instructions;
     /**
      * Optional system prompt to guide the agent's behavior.
      * @deprecated Use `instructions` instead.
@@ -337,13 +299,7 @@ type WorkflowAgentOptions<TTools extends ToolSet = ToolSet, TRuntimeContext exte
     /**
      * Optional telemetry configuration.
      */
-    telemetry?: TelemetryOptions;
-    /**
-     * Optional telemetry configuration.
-     *
-     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
-     */
-    experimental_telemetry?: TelemetryOptions;
+    telemetry?: TelemetryOptions<TRuntimeContext, TTools>;
     /**
      * Default runtime context for every stream call on this agent.
      *
@@ -639,13 +595,7 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, TRuntimeContex
     /**
      * Optional telemetry configuration.
      */
-    telemetry?: TelemetryOptions;
-    /**
-     * Optional telemetry configuration.
-     *
-     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
-     */
-    experimental_telemetry?: TelemetryOptions;
+    telemetry?: TelemetryOptions<TRuntimeContext, TTools>;
     /**
      * Runtime context that flows through the agent loop.
      *