@ai-sdk/provider 4.0.10 → 4.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider",
-  "version": "4.0.10",
+  "version": "4.0.12",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,

package/src/batch/v4/batch-v4-request.ts

@@ -0,0 +1,15 @@
+/**
+ * Fields shared by every request in a batch.
+ */
+export type BatchV4RequestBase<ModelId extends string = string> = {
+  /**
+   * Application-provided identifier used to correlate the request with its
+   * result.
+   */
+  readonly id: string;
+
+  /**
+   * Provider-specific model ID for this request.
+   */
+  readonly modelId: ModelId;
+};

package/src/batch/v4/batch-v4.ts

@@ -3,6 +3,32 @@ import type {
   SharedV4ProviderOptions,
   SharedV4Warning,
 } from '../../shared';
+import type { LanguageModelV4GenerateResult } from '../../language-model/v4/language-model-v4-generate-result';
+import type { TextBatchV4Request } from './text-batch-v4-request';
+
+/**
+ * Model IDs accepted by each batch modality.
+ *
+ * Additional modality-specific model ID types can be added to this mapping.
+ */
+export type BatchV4ModelIds = {
+  readonly text: string;
+};
+
+type BatchV4CallOptions = {
+  readonly providerOptions?: SharedV4ProviderOptions;
+  readonly abortSignal?: AbortSignal;
+  readonly headers?: Record<string, string | undefined>;
+};
+
+type BatchV4StartCallOptions = BatchV4CallOptions & {
+  /**
+   * URL the provider notifies when the batch reaches a terminal state.
+   * Providers that do not support completion webhooks should return an
+   * unsupported warning.
+   */
+  readonly webhookUrl?: string;
+};
 
 /**
  * Serializable error information for a batch or batch item.
@@ -32,21 +58,19 @@ export type BatchV4Status = {
   readonly providerMetadata?: SharedV4ProviderMetadata;
 };
 
+export type BatchV4Request<ModelIds extends BatchV4ModelIds = BatchV4ModelIds> =
+  TextBatchV4Request<ModelIds['text']>;
+
 /**
- * Options for starting a batch.
+ * Options for starting a batch of requests discriminated by modality.
+ *
+ * Additional modality-specific request variants can be added to
+ * `BatchV4Request`.
  */
-export type BatchV4StartOptions<REQUEST> = {
-  readonly requests: ReadonlyArray<REQUEST>;
-  readonly providerOptions?: SharedV4ProviderOptions;
-  readonly abortSignal?: AbortSignal;
-  readonly headers?: Record<string, string | undefined>;
-
-  /**
-   * URL the provider notifies when the batch reaches a terminal state.
-   * Providers that do not support completion webhooks should return an
-   * unsupported warning.
-   */
-  readonly webhookUrl?: string;
+export type BatchV4StartOptions<
+  ModelIds extends BatchV4ModelIds = BatchV4ModelIds,
+> = BatchV4StartCallOptions & {
+  readonly requests: ReadonlyArray<BatchV4Request<ModelIds>>;
 };
 
 /**
@@ -65,15 +89,40 @@ export type BatchV4StartResult = BatchV4Status & {
  */
 export type BatchV4OperationOptions = {
   readonly batchId: string;
-  readonly providerOptions?: SharedV4ProviderOptions;
-  readonly abortSignal?: AbortSignal;
-  readonly headers?: Record<string, string | undefined>;
+} & BatchV4CallOptions;
+
+/**
+ * Result of requesting cancellation of a batch.
+ */
+export type BatchV4CancelResult = {
+  readonly providerMetadata?: SharedV4ProviderMetadata;
+};
+
+/**
+ * Options for listing batches.
+ */
+export type BatchV4ListOptions = BatchV4CallOptions & {
+  readonly limit?: number;
+  readonly cursor?: string;
+};
+
+/**
+ * A batch returned by a list operation.
+ */
+export type BatchV4ListItem = BatchV4Status & {
+  readonly batchId: string;
 };
 
 /**
- * A complete terminal result for one request in a batch.
+ * Result of listing batches.
  */
-export type BatchV4ItemResult<RESULT> =
+export type BatchV4ListResult = {
+  readonly batches: Array<BatchV4ListItem>;
+  readonly nextCursor?: string;
+  readonly providerMetadata?: SharedV4ProviderMetadata;
+};
+
+type BatchV4ItemResultBase<RESULT> =
   | {
       readonly id: string;
       readonly status: 'succeeded';
@@ -93,19 +142,56 @@ export type BatchV4ItemResult<RESULT> =
     };
 
 /**
- * Experimental structural capability for models that support durable batch
- * processing.
+ * A complete terminal result for one request in a text batch.
+ */
+export type TextBatchV4ItemResult = {
+  readonly type: 'text';
+} & BatchV4ItemResultBase<LanguageModelV4GenerateResult>;
+
+/**
+ * A complete terminal result for one request in a batch, discriminated by
+ * modality.
+ *
+ * Additional modality-specific item results can be added to this union.
+ */
+export type BatchV4ItemResult = TextBatchV4ItemResult;
+
+/**
+ * Specification for a batch interface that implements batch interface version 4.
  */
-export type BatchModelV4<REQUEST, RESULT> = {
-  experimental_doStartBatch(
-    options: BatchV4StartOptions<REQUEST>,
+export type BatchV4<ModelIds extends BatchV4ModelIds = BatchV4ModelIds> = {
+  /**
+   * The batch interface must specify which batch interface version it implements.
+   */
+  readonly specificationVersion: 'v4';
+
+  /**
+   * Provider ID.
+   */
+  readonly provider: string;
+
+  /**
+   * Supported URL patterns by media type for requests in this batch interface.
+   */
+  readonly supportedUrls:
+    | PromiseLike<Record<string, RegExp[]>>
+    | Record<string, RegExp[]>;
+
+  doStartBatch(
+    options: BatchV4StartOptions<ModelIds>,
   ): PromiseLike<BatchV4StartResult>;
 
-  experimental_doGetBatchStatus(
+  doGetBatchStatus(
     options: BatchV4OperationOptions,
   ): PromiseLike<BatchV4Status>;
 
-  experimental_doGetBatchResults(
+  doGetBatchResults(
+    options: BatchV4OperationOptions,
+  ): PromiseLike<ReadableStream<BatchV4ItemResult>>;
+
+  doCancelBatch?(
     options: BatchV4OperationOptions,
-  ): PromiseLike<ReadableStream<BatchV4ItemResult<RESULT>>>;
+  ): PromiseLike<BatchV4CancelResult>;
+
+  doListBatches?(options: BatchV4ListOptions): PromiseLike<BatchV4ListResult>;
 };

package/src/batch/v4/index.ts

@@ -1,9 +1,18 @@
 export type {
-  BatchModelV4 as Experimental_BatchModelV4,
+  BatchV4 as Experimental_BatchV4,
+  BatchV4CancelResult as Experimental_BatchV4CancelResult,
   BatchV4Error as Experimental_BatchV4Error,
   BatchV4ItemResult as Experimental_BatchV4ItemResult,
+  BatchV4ListItem as Experimental_BatchV4ListItem,
+  BatchV4ListOptions as Experimental_BatchV4ListOptions,
+  BatchV4ListResult as Experimental_BatchV4ListResult,
+  BatchV4ModelIds as Experimental_BatchV4ModelIds,
   BatchV4OperationOptions as Experimental_BatchV4OperationOptions,
+  BatchV4Request as Experimental_BatchV4Request,
   BatchV4StartOptions as Experimental_BatchV4StartOptions,
   BatchV4StartResult as Experimental_BatchV4StartResult,
   BatchV4Status as Experimental_BatchV4Status,
+  TextBatchV4ItemResult as Experimental_TextBatchV4ItemResult,
 } from './batch-v4';
+export type { BatchV4RequestBase as Experimental_BatchV4RequestBase } from './batch-v4-request';
+export type { TextBatchV4Request as Experimental_TextBatchV4Request } from './text-batch-v4-request';

package/src/batch/v4/text-batch-v4-request.ts

@@ -0,0 +1,27 @@
+import type { LanguageModelV4CallOptions } from '../../language-model/v4/language-model-v4-call-options';
+import type { BatchV4RequestBase } from './batch-v4-request';
+
+/**
+ * A normalized text generation request within a batch.
+ */
+export type TextBatchV4Request<ModelId extends string = string> =
+  BatchV4RequestBase<ModelId> & {
+    readonly type: 'text';
+    readonly options: Pick<
+      LanguageModelV4CallOptions,
+      | 'prompt'
+      | 'maxOutputTokens'
+      | 'temperature'
+      | 'stopSequences'
+      | 'topP'
+      | 'topK'
+      | 'presencePenalty'
+      | 'frequencyPenalty'
+      | 'seed'
+      | 'reasoning'
+      | 'responseFormat'
+      | 'toolChoice'
+      | 'tools'
+      | 'providerOptions'
+    >;
+  };

package/src/image-model/v4/image-model-v4-result.ts

@@ -22,6 +22,12 @@ export type ImageModelV4Result = {
    */
   images: Array<string> | Array<Uint8Array>;
 
+  /**
+   * Whether an unsuccessful result, such as an empty image result, can be
+   * retried. When omitted, the result is unclassified.
+   */
+  isRetryable?: boolean;
+
   /**
    * Warnings for the call, e.g. unsupported features.
    */

package/src/language-model/v4/index.ts

@@ -20,7 +20,3 @@ export * from './language-model-v4-tool-call';
 export * from './language-model-v4-tool-choice';
 export * from './language-model-v4-tool-result';
 export * from './language-model-v4-usage';
-export type {
-  BatchLanguageModelV4 as Experimental_BatchLanguageModelV4,
-  LanguageModelV4BatchRequest as Experimental_LanguageModelV4BatchRequest,
-} from './language-model-v4-batch';

package/src/language-model/v4/language-model-v4-batch.ts

@@ -1,42 +0,0 @@
-import type { BatchModelV4 } from '../../batch/v4/batch-v4';
-import type { LanguageModelV4 } from './language-model-v4';
-import type { LanguageModelV4CallOptions } from './language-model-v4-call-options';
-import type { LanguageModelV4GenerateResult } from './language-model-v4-generate-result';
-
-/**
- * A normalized language model call within a batch.
- */
-export type LanguageModelV4BatchRequest = {
-  /**
-   * Application-provided identifier used to correlate the request with its
-   * result.
-   */
-  readonly id: string;
-
-  /**
-   * Normalized text-generation options for the request.
-   */
-  readonly options: Pick<
-    LanguageModelV4CallOptions,
-    | 'prompt'
-    | 'maxOutputTokens'
-    | 'temperature'
-    | 'stopSequences'
-    | 'topP'
-    | 'topK'
-    | 'presencePenalty'
-    | 'frequencyPenalty'
-    | 'seed'
-    | 'reasoning'
-    | 'responseFormat'
-    | 'toolChoice'
-    | 'tools'
-    | 'providerOptions'
-  >;
-};
-
-/**
- * Language model V4 with durable batch-processing support.
- */
-export type BatchLanguageModelV4 = LanguageModelV4 &
-  BatchModelV4<LanguageModelV4BatchRequest, LanguageModelV4GenerateResult>;