ai 6.0.32 → 6.0.34

package/src/types/language-model.ts

@@ -0,0 +1,104 @@
+import { GatewayModelId } from '@ai-sdk/gateway';
+import {
+  LanguageModelV2,
+  LanguageModelV3,
+  SharedV3Warning,
+  LanguageModelV3Source,
+} from '@ai-sdk/provider';
+
+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 based 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 {}
+}
+
+/**
+ * Global provider model ID type that defaults to GatewayModelId but can be augmented
+ * by third-party packages via declaration merging.
+ */
+export type GlobalProviderModelId = [keyof RegisteredProviderModels] extends [
+  never,
+]
+  ? GatewayModelId
+  :
+      | keyof RegisteredProviderModels
+      | RegisteredProviderModels[keyof RegisteredProviderModels];
+
+/**
+Language model that is used by the AI SDK.
+*/
+export type LanguageModel =
+  | GlobalProviderModelId
+  | LanguageModelV3
+  | LanguageModelV2;
+
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+export type FinishReason =
+  | 'stop'
+  | 'length'
+  | 'content-filter'
+  | 'tool-calls'
+  | 'error'
+  | 'other';
+
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+export type CallWarning = SharedV3Warning;
+
+/**
+A source that has been used as input to generate the response.
+*/
+export type Source = LanguageModelV3Source;
+
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
+ */
+export type ToolChoice<TOOLS extends Record<string, unknown>> =
+  | 'auto'
+  | 'none'
+  | 'required'
+  | { type: 'tool'; toolName: Extract<keyof TOOLS, string> };

package/src/types/provider-metadata.ts

@@ -0,0 +1,16 @@
+import { SharedV3ProviderMetadata } from '@ai-sdk/provider';
+import { z } from 'zod/v4';
+import { jsonValueSchema } from './json-value';
+
+/**
+Additional provider-specific metadata that is returned from the provider.
+
+This is needed to enable provider-specific functionality that can be
+fully encapsulated in the provider.
+ */
+export type ProviderMetadata = SharedV3ProviderMetadata;
+
+export const providerMetadataSchema: z.ZodType<ProviderMetadata> = z.record(
+  z.string(),
+  z.record(z.string(), jsonValueSchema.optional()),
+);

package/src/types/provider.ts

@@ -0,0 +1,55 @@
+import { EmbeddingModel } from './embedding-model';
+import { LanguageModel } from './language-model';
+import { ImageModel } from './image-model';
+import { RerankingModel } from './reranking-model';
+
+/**
+ * Provider for language, text embedding, and image models.
+ */
+export type Provider = {
+  /**
+  Returns the language model with the given id.
+  The model id is then passed to the provider function to get the model.
+
+  @param {string} id - The id of the model to return.
+
+  @returns {LanguageModel} The language model associated with the id
+
+  @throws {NoSuchModelError} If no such model exists.
+     */
+  languageModel(modelId: string): LanguageModel;
+
+  /**
+  Returns the text embedding model with the given id.
+  The model id is then passed to the provider function to get the model.
+
+  @param {string} id - The id of the model to return.
+
+  @returns {LanguageModel} The language model associated with the id
+
+  @throws {NoSuchModelError} If no such model exists.
+     */
+  embeddingModel(modelId: string): EmbeddingModel;
+
+  /**
+  Returns the image model with the given id.
+  The model id is then passed to the provider function to get the model.
+
+  @param {string} id - The id of the model to return.
+
+  @returns {ImageModel} The image model associated with the id
+  */
+  imageModel(modelId: string): ImageModel;
+
+  /**
+   Returns the reranking model with the given id.
+   The model id is then passed to the provider function to get the model.
+
+  @param {string} id - The id of the model to return.
+
+  @return {RerankingModel<VALUE>} The reranking model associated with the id
+
+  @throws {NoSuchModelError} If no such model exists.
+   */
+  rerankingModel(modelId: string): RerankingModel;
+};

package/src/types/reranking-model.ts

@@ -0,0 +1,6 @@
+import { RerankingModelV3 } from '@ai-sdk/provider';
+
+/**
+ * Reranking model that is used by the AI SDK.
+ */
+export type RerankingModel = RerankingModelV3;

package/src/types/speech-model-response-metadata.ts

@@ -0,0 +1,21 @@
+export type SpeechModelResponseMetadata = {
+  /**
+Timestamp for the start of the generated response.
+   */
+  timestamp: Date;
+
+  /**
+The ID of the response model that was used to generate the response.
+   */
+  modelId: string;
+
+  /**
+Response headers.
+   */
+  headers?: Record<string, string>;
+
+  /**
+Response body.
+   */
+  body?: unknown;
+};

package/src/types/speech-model.ts

@@ -0,0 +1,6 @@
+import { SpeechModelV2, SpeechModelV3 } from '@ai-sdk/provider';
+
+/**
+Speech model that is used by the AI SDK.
+  */
+export type SpeechModel = string | SpeechModelV3 | SpeechModelV2;

package/src/types/transcription-model-response-metadata.ts

@@ -0,0 +1,16 @@
+export type TranscriptionModelResponseMetadata = {
+  /**
+Timestamp for the start of the generated response.
+   */
+  timestamp: Date;
+
+  /**
+The ID of the response model that was used to generate the response.
+   */
+  modelId: string;
+
+  /**
+Response headers.
+   */
+  headers?: Record<string, string>;
+};

package/src/types/transcription-model.ts

@@ -0,0 +1,9 @@
+import { TranscriptionModelV2, TranscriptionModelV3 } from '@ai-sdk/provider';
+
+/**
+Transcription model that is used by the AI SDK.
+  */
+export type TranscriptionModel =
+  | string
+  | TranscriptionModelV3
+  | TranscriptionModelV2;

package/src/types/usage.ts

@@ -0,0 +1,200 @@
+import {
+  ImageModelV3Usage,
+  JSONObject,
+  LanguageModelV3Usage,
+} from '@ai-sdk/provider';
+
+/**
+ * Represents the number of tokens used in a prompt and completion.
+ */
+export 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;
+};
+
+/**
+Represents the number of tokens used in an embedding.
+ */
+// TODO replace with EmbeddingModelV3Usage
+export type EmbeddingModelUsage = {
+  /**
+The number of tokens used in the embedding.
+   */
+  tokens: number;
+};
+
+export function asLanguageModelUsage(
+  usage: LanguageModelV3Usage,
+): LanguageModelUsage {
+  return {
+    inputTokens: usage.inputTokens.total,
+    inputTokenDetails: {
+      noCacheTokens: usage.inputTokens.noCache,
+      cacheReadTokens: usage.inputTokens.cacheRead,
+      cacheWriteTokens: usage.inputTokens.cacheWrite,
+    },
+    outputTokens: usage.outputTokens.total,
+    outputTokenDetails: {
+      textTokens: usage.outputTokens.text,
+      reasoningTokens: usage.outputTokens.reasoning,
+    },
+    totalTokens: addTokenCounts(
+      usage.inputTokens.total,
+      usage.outputTokens.total,
+    ),
+    raw: usage.raw,
+    reasoningTokens: usage.outputTokens.reasoning,
+    cachedInputTokens: usage.inputTokens.cacheRead,
+  };
+}
+
+export function createNullLanguageModelUsage(): LanguageModelUsage {
+  return {
+    inputTokens: undefined,
+    inputTokenDetails: {
+      noCacheTokens: undefined,
+      cacheReadTokens: undefined,
+      cacheWriteTokens: undefined,
+    },
+    outputTokens: undefined,
+    outputTokenDetails: {
+      textTokens: undefined,
+      reasoningTokens: undefined,
+    },
+    totalTokens: undefined,
+    raw: undefined,
+  };
+}
+
+export function addLanguageModelUsage(
+  usage1: LanguageModelUsage,
+  usage2: LanguageModelUsage,
+): LanguageModelUsage {
+  return {
+    inputTokens: addTokenCounts(usage1.inputTokens, usage2.inputTokens),
+    inputTokenDetails: {
+      noCacheTokens: addTokenCounts(
+        usage1.inputTokenDetails?.noCacheTokens,
+        usage2.inputTokenDetails?.noCacheTokens,
+      ),
+      cacheReadTokens: addTokenCounts(
+        usage1.inputTokenDetails?.cacheReadTokens,
+        usage2.inputTokenDetails?.cacheReadTokens,
+      ),
+      cacheWriteTokens: addTokenCounts(
+        usage1.inputTokenDetails?.cacheWriteTokens,
+        usage2.inputTokenDetails?.cacheWriteTokens,
+      ),
+    },
+    outputTokens: addTokenCounts(usage1.outputTokens, usage2.outputTokens),
+    outputTokenDetails: {
+      textTokens: addTokenCounts(
+        usage1.outputTokenDetails?.textTokens,
+        usage2.outputTokenDetails?.textTokens,
+      ),
+      reasoningTokens: addTokenCounts(
+        usage1.outputTokenDetails?.reasoningTokens,
+        usage2.outputTokenDetails?.reasoningTokens,
+      ),
+    },
+    totalTokens: addTokenCounts(usage1.totalTokens, usage2.totalTokens),
+    reasoningTokens: addTokenCounts(
+      usage1.reasoningTokens,
+      usage2.reasoningTokens,
+    ),
+    cachedInputTokens: addTokenCounts(
+      usage1.cachedInputTokens,
+      usage2.cachedInputTokens,
+    ),
+  };
+}
+
+function addTokenCounts(
+  tokenCount1: number | undefined,
+  tokenCount2: number | undefined,
+): number | undefined {
+  return tokenCount1 == null && tokenCount2 == null
+    ? undefined
+    : (tokenCount1 ?? 0) + (tokenCount2 ?? 0);
+}
+
+/**
+Usage information for an image model call.
+ */
+export type ImageModelUsage = ImageModelV3Usage;
+
+export function addImageModelUsage(
+  usage1: ImageModelUsage,
+  usage2: ImageModelUsage,
+): ImageModelUsage {
+  return {
+    inputTokens: addTokenCounts(usage1.inputTokens, usage2.inputTokens),
+    outputTokens: addTokenCounts(usage1.outputTokens, usage2.outputTokens),
+    totalTokens: addTokenCounts(usage1.totalTokens, usage2.totalTokens),
+  };
+}

package/src/types/warning.ts

@@ -0,0 +1,7 @@
+import { SharedV3Warning } from '@ai-sdk/provider';
+
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+  */
+export type Warning = SharedV3Warning;