@ai-sdk/gateway 4.0.63 → 4.0.64

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/gateway
 
+## 4.0.64
+
+### Patch Changes
+
+- 591d25b: feat: add batch completion webhooks. `experimental_startTextBatch` accepts a `webhookUrl`, and the gateway provider registers it through the batch `callbackUrl` contract and exports typed async-job metadata. Direct Anthropic and OpenAI batch providers return an unsupported warning when the option is provided.
+- Updated dependencies [591d25b]
+  - @ai-sdk/provider@4.0.8
+  - @ai-sdk/provider-utils@5.0.30
+
 ## 4.0.63
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV4, ProviderV4, Experimental_BatchLanguageModelV4, 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, JSONValue, 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';
 
@@ -1058,6 +1058,30 @@ interface GatewayProviderSettings {
 declare function createGateway(options?: GatewayProviderSettings): GatewayProvider;
 declare const gateway: GatewayProvider;
 
+/**
+ * Metadata for an asynchronous AI Gateway job.
+ */
+type GatewayAsyncJobMetadata = {
+    readonly jobId: string;
+    readonly status: string;
+    /**
+     * Secret for verifying customer webhook deliveries. This is sensitive,
+     * start-response-only metadata and must not be logged or forwarded.
+     */
+    readonly webhookSigningSecret?: string;
+    readonly [key: string]: JSONValue | undefined;
+};
+/**
+ * Shape of the inner `providerMetadata.gateway` object returned by AI Gateway
+ * operations.
+ *
+ * Additional fields may be added without a package update.
+ */
+type GatewayProviderMetadata = {
+    readonly asyncJob?: GatewayAsyncJobMetadata;
+    readonly [key: string]: JSONValue | undefined;
+};
+
 type GatewayProviderOptions = {
     /**
      * Service-owned options may be added by the Gateway without requiring an SDK
@@ -1319,4 +1343,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, 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 };
+export { GATEWAY_AUTH_SUBPROTOCOL_PREFIX, GATEWAY_REALTIME_SUBPROTOCOL, GATEWAY_TEAM_SUBPROTOCOL_PREFIX, GATEWAY_TRANSCRIPTION_SUBPROTOCOL, type GatewayAsyncJobMetadata, 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 GatewayProviderMetadata, 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 };

package/dist/index.js

@@ -1232,7 +1232,8 @@ var GatewayBatchLanguageModel = class _GatewayBatchLanguageModel extends Gateway
     requests,
     providerOptions,
     headers,
-    abortSignal
+    abortSignal,
+    webhookUrl
   }) {
     var _a12;
     const resolvedHeaders = this.config.headers ? await resolve5(this.config.headers) : void 0;
@@ -1249,6 +1250,7 @@ var GatewayBatchLanguageModel = class _GatewayBatchLanguageModel extends Gateway
           idempotencyKey != null ? { "idempotency-key": idempotencyKey } : void 0
         ),
         body: {
+          ...webhookUrl != null && { callbackUrl: webhookUrl },
           modelId: this.modelId,
           requests: requests.map((request) => ({
             id: request.id,
@@ -3465,7 +3467,7 @@ async function getVercelRequestId() {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.63" : "0.0.0-test";
+var VERSION = true ? "4.0.64" : "0.0.0-test";
 
 // src/gateway-provider.ts
 var AI_GATEWAY_PROTOCOL_VERSION = "0.0.1";