@ai-sdk/gateway 4.0.56 → 4.0.57

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/gateway
 
+## 4.0.57
+
+### Patch Changes
+
+- 936719b: add experimental batch API support (startTextBatch/getBatchStatus/getBatchResults) via the AI Gateway batch routes
+
 ## 4.0.56
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV4, ProviderV4, EmbeddingModelV4, ImageModelV4, Experimental_VideoModelV4, RerankingModelV4, SpeechModelV4, TranscriptionModelV4, Experimental_RealtimeFactoryV4, TypeValidationError } from '@ai-sdk/provider';
+import { LanguageModelV4, ProviderV4, Experimental_BatchLanguageModelV4, EmbeddingModelV4, ImageModelV4, Experimental_VideoModelV4, RerankingModelV4, SpeechModelV4, TranscriptionModelV4, Experimental_RealtimeFactoryV4, TypeValidationError } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction, WebSocketConstructor, InferSchema } from '@ai-sdk/provider-utils';
 
@@ -664,15 +664,15 @@ declare const gatewayTools: {
 };
 
 interface GatewayProvider extends ProviderV4 {
-    (modelId: GatewayModelId): LanguageModelV4;
+    (modelId: GatewayModelId): Experimental_BatchLanguageModelV4;
     /**
      * Creates a model for text generation.
      */
-    chat(modelId: GatewayModelId): LanguageModelV4;
+    chat(modelId: GatewayModelId): Experimental_BatchLanguageModelV4;
     /**
      * Creates a model for text generation.
      */
-    languageModel(modelId: GatewayModelId): LanguageModelV4;
+    languageModel(modelId: GatewayModelId): Experimental_BatchLanguageModelV4;
     /**
      * Returns available providers and models for use with the remote provider.
      */
@@ -843,6 +843,11 @@ type GatewayProviderOptions = {
      * Currently supports `'implicit-caching'` and `'vision'` (image input).
      */
     has?: Array<'implicit-caching' | 'vision'>;
+    /**
+     * Idempotency key for `experimental_startTextBatch`: retries with the same
+     * key replay the original batch instead of creating a duplicate.
+     */
+    idempotencyKey?: string;
     /** Array of model slugs specifying fallback models to use in order. */
     models?: string[];
     /** Array of provider slugs that are the only ones allowed to be used. */
@@ -867,9 +872,9 @@ type GatewayProviderOptions = {
     zeroDataRetention?: boolean;
 };
 
-declare const symbol$8: unique symbol;
+declare const symbol$9: unique symbol;
 declare abstract class GatewayError extends Error {
-    private readonly [symbol$8];
+    private readonly [symbol$9];
     abstract readonly name: string;
     abstract readonly type: string;
     readonly statusCode: number;
@@ -903,12 +908,12 @@ declare const gatewayErrorResponseSchema: _ai_sdk_provider_utils.LazySchema<{
 }>;
 type GatewayErrorResponse = InferSchema<typeof gatewayErrorResponseSchema>;
 
-declare const symbol$7: unique symbol;
+declare const symbol$8: unique symbol;
 /**
  * Authentication failed - invalid API key or OIDC token
  */
 declare class GatewayAuthenticationError extends GatewayError {
-    private readonly [symbol$7];
+    private readonly [symbol$8];
     readonly name = "GatewayAuthenticationError";
     readonly type = "authentication_error";
     constructor({ message, statusCode, cause, generationId, }?: {
@@ -931,14 +936,14 @@ declare class GatewayAuthenticationError extends GatewayError {
     }): GatewayAuthenticationError;
 }
 
-declare const symbol$6: unique symbol;
+declare const symbol$7: unique symbol;
 /**
  * The request could not be fulfilled because a dependency it relied on was not
  * available on the credentials or provider used to serve it (HTTP 424). Not
  * retryable — the caller must change the request.
  */
 declare class GatewayFailedDependencyError extends GatewayError {
-    private readonly [symbol$6];
+    private readonly [symbol$7];
     readonly name = "GatewayFailedDependencyError";
     readonly type = "failed_dependency";
     constructor({ message, statusCode, cause, generationId, }?: {
@@ -950,13 +955,13 @@ declare class GatewayFailedDependencyError extends GatewayError {
     static isInstance(error: unknown): error is GatewayFailedDependencyError;
 }
 
-declare const symbol$5: unique symbol;
+declare const symbol$6: unique symbol;
 /**
  * Forbidden - the request was rejected by policy (e.g. a routing rule),
  * not an authentication failure.
  */
 declare class GatewayForbiddenError extends GatewayError {
-    private readonly [symbol$5];
+    private readonly [symbol$6];
     readonly name = "GatewayForbiddenError";
     readonly type = "forbidden";
     readonly ruleId?: string;
@@ -970,12 +975,12 @@ declare class GatewayForbiddenError extends GatewayError {
     static isInstance(error: unknown): error is GatewayForbiddenError;
 }
 
-declare const symbol$4: unique symbol;
+declare const symbol$5: unique symbol;
 /**
  * Internal server error from the Gateway
  */
 declare class GatewayInternalServerError extends GatewayError {
-    private readonly [symbol$4];
+    private readonly [symbol$5];
     readonly name = "GatewayInternalServerError";
     readonly type = "internal_server_error";
     constructor({ message, statusCode, cause, generationId, }?: {
@@ -987,12 +992,12 @@ declare class GatewayInternalServerError extends GatewayError {
     static isInstance(error: unknown): error is GatewayInternalServerError;
 }
 
-declare const symbol$3: unique symbol;
+declare const symbol$4: unique symbol;
 /**
  * Invalid request - missing headers, malformed data, etc.
  */
 declare class GatewayInvalidRequestError extends GatewayError {
-    private readonly [symbol$3];
+    private readonly [symbol$4];
     readonly name = "GatewayInvalidRequestError";
     readonly type = "invalid_request_error";
     constructor({ message, statusCode, cause, generationId, }?: {
@@ -1004,12 +1009,12 @@ declare class GatewayInvalidRequestError extends GatewayError {
     static isInstance(error: unknown): error is GatewayInvalidRequestError;
 }
 
-declare const symbol$2: unique symbol;
+declare const symbol$3: unique symbol;
 /**
  * Model not found or not available
  */
 declare class GatewayModelNotFoundError extends GatewayError {
-    private readonly [symbol$2];
+    private readonly [symbol$3];
     readonly name = "GatewayModelNotFoundError";
     readonly type = "model_not_found";
     readonly modelId?: string;
@@ -1023,6 +1028,25 @@ declare class GatewayModelNotFoundError extends GatewayError {
     static isInstance(error: unknown): error is GatewayModelNotFoundError;
 }
 
+declare const symbol$2: unique symbol;
+/**
+ * Not found - the requested Gateway resource does not exist or is not
+ * visible to the caller (e.g. an unknown async batch/video job id).
+ * Distinct from `GatewayModelNotFoundError`, which is model-specific.
+ */
+declare class GatewayNotFoundError extends GatewayError {
+    private readonly [symbol$2];
+    readonly name = "GatewayNotFoundError";
+    readonly type = "not_found";
+    constructor({ message, statusCode, cause, generationId, }?: {
+        message?: string;
+        statusCode?: number;
+        cause?: unknown;
+        generationId?: string;
+    });
+    static isInstance(error: unknown): error is GatewayNotFoundError;
+}
+
 declare const symbol$1: unique symbol;
 /**
  * Rate limit exceeded.
@@ -1063,4 +1087,4 @@ declare class GatewayResponseError extends GatewayError {
 
 declare const VERSION: string;
 
-export { GATEWAY_AUTH_SUBPROTOCOL_PREFIX, GATEWAY_REALTIME_SUBPROTOCOL, GATEWAY_TEAM_SUBPROTOCOL_PREFIX, GATEWAY_TRANSCRIPTION_SUBPROTOCOL, GatewayAuthenticationError, type GatewayCreditsResponse, type GatewayEmbeddingModelId, GatewayError, type GatewayErrorResponse, GatewayFailedDependencyError, GatewayForbiddenError, type GatewayGenerationInfo, type GatewayGenerationInfoParams, type GatewayImageModelId, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, type GatewayRealtimeModelId, type GatewayRerankingModelId, GatewayResponseError, type GatewaySpeechModelId, type GatewaySpendReportParams, type GatewaySpendReportResponse, type GatewaySpendReportRow, type GatewayTranscriptionModelId, type GatewayVideoModelId, VERSION, createGateway, createGateway as createGatewayProvider, gateway, getGatewayRealtimeAuthToken, getGatewayRealtimeProtocols, getGatewayRealtimeTeamIdOrSlug, getGatewayTranscriptionProtocols };
+export { GATEWAY_AUTH_SUBPROTOCOL_PREFIX, GATEWAY_REALTIME_SUBPROTOCOL, GATEWAY_TEAM_SUBPROTOCOL_PREFIX, GATEWAY_TRANSCRIPTION_SUBPROTOCOL, GatewayAuthenticationError, type GatewayCreditsResponse, type GatewayEmbeddingModelId, GatewayError, type GatewayErrorResponse, GatewayFailedDependencyError, GatewayForbiddenError, type GatewayGenerationInfo, type GatewayGenerationInfoParams, type GatewayImageModelId, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, GatewayNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, type GatewayRealtimeModelId, type GatewayRerankingModelId, GatewayResponseError, type GatewaySpeechModelId, type GatewaySpendReportParams, type GatewaySpendReportResponse, type GatewaySpendReportRow, type GatewayTranscriptionModelId, type GatewayVideoModelId, VERSION, createGateway, createGateway as createGatewayProvider, gateway, getGatewayRealtimeAuthToken, getGatewayRealtimeProtocols, getGatewayRealtimeTeamIdOrSlug, getGatewayTranscriptionProtocols };