ai 6.0.0-beta.99 → 6.0.0

package/dist/internal/index.d.mts

@@ -1,6 +1,6 @@
-import { ModelMessage, Tool } from '@ai-sdk/provider-utils';
+import { SystemModelMessage, ModelMessage, Tool } from '@ai-sdk/provider-utils';
 export { convertAsyncIteratorToReadableStream } from '@ai-sdk/provider-utils';
-import { LanguageModelV3Prompt, LanguageModelV3FunctionTool, LanguageModelV3ProviderDefinedTool, LanguageModelV3ToolChoice } from '@ai-sdk/provider';
+import { LanguageModelV3Prompt, LanguageModelV3Usage, JSONObject, LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, LanguageModelV3ToolChoice } from '@ai-sdk/provider';
 
 /**
  * Experimental. Can change in patch versions without warning.
@@ -35,7 +35,7 @@ type Prompt = {
     /**
   System message to include in the prompt. Can be used with `prompt` or `messages`.
      */
-    system?: string;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
 } & ({
     /**
 A prompt. It can be either a text prompt or a list of messages.
@@ -68,7 +68,7 @@ type StandardizedPrompt = {
     /**
      * System message.
      */
-    system?: string;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
     /**
      * Messages.
      */
@@ -153,6 +153,39 @@ type CallSettings = {
     headers?: Record<string, string | undefined>;
 };
 
+declare global {
+    /**
+     * Global interface that can be augmented by third-party packages to register custom model IDs.
+     *
+     * You can register model IDs in two ways:
+     *
+     * 1. Register baesd on Model IDs from a provider package:
+     * @example
+     * ```typescript
+     * import { openai } from '@ai-sdk/openai';
+     * type OpenAIResponsesModelId = Parameters<typeof openai>[0];
+     *
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     openai: OpenAIResponsesModelId;
+     *   }
+     * }
+     * ```
+     *
+     * 2. Register individual model IDs directly as keys:
+     * @example
+     * ```typescript
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     'my-provider:my-model': any;
+     *     'my-provider:another-model': any;
+     *   }
+     * }
+     * ```
+     */
+    interface RegisteredProviderModels {
+    }
+}
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -166,6 +199,70 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
     toolName: Extract<keyof TOOLS, string>;
 };
 
+/**
+ * Represents the number of tokens used in a prompt and completion.
+ */
+type LanguageModelUsage = {
+    /**
+     * The total number of input (prompt) tokens used.
+     */
+    inputTokens: number | undefined;
+    /**
+     * Detailed information about the input tokens.
+     */
+    inputTokenDetails: {
+        /**
+         * The number of non-cached input (prompt) tokens used.
+         */
+        noCacheTokens: number | undefined;
+        /**
+         * The number of cached input (prompt) tokens read.
+         */
+        cacheReadTokens: number | undefined;
+        /**
+         * The number of cached input (prompt) tokens written.
+         */
+        cacheWriteTokens: number | undefined;
+    };
+    /**
+     * The number of total output (completion) tokens used.
+     */
+    outputTokens: number | undefined;
+    /**
+     * Detailed information about the output tokens.
+     */
+    outputTokenDetails: {
+        /**
+         * The number of text tokens used.
+         */
+        textTokens: number | undefined;
+        /**
+         * The number of reasoning tokens used.
+         */
+        reasoningTokens: number | undefined;
+    };
+    /**
+     * The total number of tokens used.
+     */
+    totalTokens: number | undefined;
+    /**
+     * @deprecated Use outputTokenDetails.reasoning instead.
+     */
+    reasoningTokens?: number | undefined;
+    /**
+     * @deprecated Use inputTokenDetails.cacheRead instead.
+     */
+    cachedInputTokens?: number | undefined;
+    /**
+     * Raw usage information from the provider.
+     *
+     * This is the usage information in the shape that the provider returns.
+     * It can include additional information that is not part of the standard usage information.
+     */
+    raw?: JSONObject;
+};
+declare function asLanguageModelUsage(usage: LanguageModelV3Usage): LanguageModelUsage;
+
 type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta' | 'needsApproval'>>;
 
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
@@ -173,7 +270,7 @@ declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolC
     toolChoice: ToolChoice<TOOLS> | undefined;
     activeTools: Array<keyof TOOLS> | undefined;
 }): Promise<{
-    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool> | undefined;
+    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool> | undefined;
     toolChoice: LanguageModelV3ToolChoice | undefined;
 }>;
 
@@ -195,4 +292,4 @@ declare function prepareRetries({ maxRetries, abortSignal, }: {
     retry: RetryFunction;
 };
 
-export { convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { asLanguageModelUsage, convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };

package/dist/internal/index.d.ts

@@ -1,6 +1,6 @@
-import { ModelMessage, Tool } from '@ai-sdk/provider-utils';
+import { SystemModelMessage, ModelMessage, Tool } from '@ai-sdk/provider-utils';
 export { convertAsyncIteratorToReadableStream } from '@ai-sdk/provider-utils';
-import { LanguageModelV3Prompt, LanguageModelV3FunctionTool, LanguageModelV3ProviderDefinedTool, LanguageModelV3ToolChoice } from '@ai-sdk/provider';
+import { LanguageModelV3Prompt, LanguageModelV3Usage, JSONObject, LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, LanguageModelV3ToolChoice } from '@ai-sdk/provider';
 
 /**
  * Experimental. Can change in patch versions without warning.
@@ -35,7 +35,7 @@ type Prompt = {
     /**
   System message to include in the prompt. Can be used with `prompt` or `messages`.
      */
-    system?: string;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
 } & ({
     /**
 A prompt. It can be either a text prompt or a list of messages.
@@ -68,7 +68,7 @@ type StandardizedPrompt = {
     /**
      * System message.
      */
-    system?: string;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
     /**
      * Messages.
      */
@@ -153,6 +153,39 @@ type CallSettings = {
     headers?: Record<string, string | undefined>;
 };
 
+declare global {
+    /**
+     * Global interface that can be augmented by third-party packages to register custom model IDs.
+     *
+     * You can register model IDs in two ways:
+     *
+     * 1. Register baesd on Model IDs from a provider package:
+     * @example
+     * ```typescript
+     * import { openai } from '@ai-sdk/openai';
+     * type OpenAIResponsesModelId = Parameters<typeof openai>[0];
+     *
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     openai: OpenAIResponsesModelId;
+     *   }
+     * }
+     * ```
+     *
+     * 2. Register individual model IDs directly as keys:
+     * @example
+     * ```typescript
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     'my-provider:my-model': any;
+     *     'my-provider:another-model': any;
+     *   }
+     * }
+     * ```
+     */
+    interface RegisteredProviderModels {
+    }
+}
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -166,6 +199,70 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
     toolName: Extract<keyof TOOLS, string>;
 };
 
+/**
+ * Represents the number of tokens used in a prompt and completion.
+ */
+type LanguageModelUsage = {
+    /**
+     * The total number of input (prompt) tokens used.
+     */
+    inputTokens: number | undefined;
+    /**
+     * Detailed information about the input tokens.
+     */
+    inputTokenDetails: {
+        /**
+         * The number of non-cached input (prompt) tokens used.
+         */
+        noCacheTokens: number | undefined;
+        /**
+         * The number of cached input (prompt) tokens read.
+         */
+        cacheReadTokens: number | undefined;
+        /**
+         * The number of cached input (prompt) tokens written.
+         */
+        cacheWriteTokens: number | undefined;
+    };
+    /**
+     * The number of total output (completion) tokens used.
+     */
+    outputTokens: number | undefined;
+    /**
+     * Detailed information about the output tokens.
+     */
+    outputTokenDetails: {
+        /**
+         * The number of text tokens used.
+         */
+        textTokens: number | undefined;
+        /**
+         * The number of reasoning tokens used.
+         */
+        reasoningTokens: number | undefined;
+    };
+    /**
+     * The total number of tokens used.
+     */
+    totalTokens: number | undefined;
+    /**
+     * @deprecated Use outputTokenDetails.reasoning instead.
+     */
+    reasoningTokens?: number | undefined;
+    /**
+     * @deprecated Use inputTokenDetails.cacheRead instead.
+     */
+    cachedInputTokens?: number | undefined;
+    /**
+     * Raw usage information from the provider.
+     *
+     * This is the usage information in the shape that the provider returns.
+     * It can include additional information that is not part of the standard usage information.
+     */
+    raw?: JSONObject;
+};
+declare function asLanguageModelUsage(usage: LanguageModelV3Usage): LanguageModelUsage;
+
 type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta' | 'needsApproval'>>;
 
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
@@ -173,7 +270,7 @@ declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolC
     toolChoice: ToolChoice<TOOLS> | undefined;
     activeTools: Array<keyof TOOLS> | undefined;
 }): Promise<{
-    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool> | undefined;
+    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool> | undefined;
     toolChoice: LanguageModelV3ToolChoice | undefined;
 }>;
 
@@ -195,4 +292,4 @@ declare function prepareRetries({ maxRetries, abortSignal, }: {
     retry: RetryFunction;
 };
 
-export { convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { asLanguageModelUsage, convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };