@ai-sdk/xai 4.0.55 → 4.0.57

package/docs/01-xai.mdx

@@ -625,65 +625,16 @@ The following provider options are available:
   tools with client-side function tools in the same request.
 </Note>
 
-## Text Batches
+## Batch
 
 <Note type="warning">
-  Text batch support is experimental and the API may change in patch releases.
+  Batch support is experimental and the API may change in patch releases.
 </Note>
 
-The xAI provider supports asynchronous text generation through the
-[Batch API](https://docs.x.ai/developers/advanced-api-usage/batch-api). Use the
-experimental text batch APIs to start a batch, poll its status, and stream its
-results:
-
-```ts
-import { xai } from '@ai-sdk/xai';
-import {
-  experimental_getBatchResults as getBatchResults,
-  experimental_getBatchStatus as getBatchStatus,
-  experimental_startBatch as startBatch,
-} from 'ai';
-import { setTimeout } from 'node:timers/promises';
-
-const model = 'grok-4.3';
-
-const batch = await startBatch({
-  provider: xai,
-  requests: [
-    {
-      id: 'capital-france',
-      type: 'text',
-      model,
-      prompt: 'What is the capital of France?',
-    },
-    {
-      id: 'capital-germany',
-      type: 'text',
-      model: 'grok-4.20-non-reasoning',
-      prompt: 'What is the capital of Germany?',
-    },
-  ],
-});
-
-let status = batch.status;
-while (status === 'pending') {
-  await setTimeout(60_000);
-  ({ status } = await getBatchStatus({ provider: xai, batch }));
-}
-
-for await (const item of getBatchResults({ provider: xai, batch })) {
-  if (item.status === 'succeeded') {
-    console.log(item.id, item.text);
-  } else {
-    console.error(item.id, item.error);
-  }
-}
-```
-
-`startBatch` returns a serializable batch reference. Persist this reference
-to check the batch status or retrieve its results from another process. Results
-can arrive in a different order from the input requests, so match each result by
-its `id`.
+The xAI provider supports asynchronous text generation through the [Batch
+API](https://docs.x.ai/developers/advanced-api-usage/batch-api). Pass the xAI
+provider to the AI SDK's [Batch](/docs/ai-sdk-core/batch) API
+for the complete workflow, including polling, persistence, and result handling.
 
 Each request specifies its `type` and `model`. xAI supports using different
 text models within the same batch.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/xai",
-  "version": "4.0.55",
+  "version": "4.0.57",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -29,8 +29,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.11",
-    "@ai-sdk/provider-utils": "5.0.37"
+    "@ai-sdk/provider": "4.0.13",
+    "@ai-sdk/provider-utils": "5.0.39"
   },
   "devDependencies": {
     "@ai-sdk/test-server": "2.0.1",

package/src/xai-batch.ts

@@ -1,8 +1,11 @@
 import {
   InvalidArgumentError,
   type Experimental_BatchV4 as BatchV4,
+  type Experimental_BatchV4CancelResult as BatchV4CancelResult,
   type Experimental_BatchV4Error as BatchV4Error,
   type Experimental_BatchV4ItemResult as BatchV4ItemResult,
+  type Experimental_BatchV4ListOptions as BatchV4ListOptions,
+  type Experimental_BatchV4ListResult as BatchV4ListResult,
   type Experimental_BatchV4OperationOptions as BatchV4OperationOptions,
   type Experimental_BatchV4StartResult as BatchV4StartResult,
   type Experimental_BatchV4Status as BatchV4Status,
@@ -80,26 +83,27 @@ type XaiBatchResponseConversion =
   | { success: true; result: LanguageModelV4GenerateResult }
   | { success: false; error: BatchV4Error };
 
+const xaiBatchResponseZodSchema = () =>
+  z.object({
+    batch_id: z.string(),
+    name: z.string().nullish(),
+    create_time: z.string().nullish(),
+    expire_time: z.string().nullish(),
+    cancel_time: z.string().nullish(),
+    cancel_by_xai_message: z.string().nullish(),
+    state: z
+      .object({
+        num_requests: z.number().nullish(),
+        num_pending: z.number().nullish(),
+        num_success: z.number().nullish(),
+        num_error: z.number().nullish(),
+        num_cancelled: z.number().nullish(),
+      })
+      .nullish(),
+  });
+
 const xaiBatchResponseSchema = lazySchema(() =>
-  zodSchema(
-    z.object({
-      batch_id: z.string(),
-      name: z.string().nullish(),
-      create_time: z.string().nullish(),
-      expire_time: z.string().nullish(),
-      cancel_time: z.string().nullish(),
-      cancel_by_xai_message: z.string().nullish(),
-      state: z
-        .object({
-          num_requests: z.number().nullish(),
-          num_pending: z.number().nullish(),
-          num_success: z.number().nullish(),
-          num_error: z.number().nullish(),
-          num_cancelled: z.number().nullish(),
-        })
-        .nullish(),
-    }),
-  ),
+  zodSchema(xaiBatchResponseZodSchema()),
 );
 
 type XaiBatchResponse = InferSchema<typeof xaiBatchResponseSchema>;
@@ -135,6 +139,15 @@ const xaiBatchResultsPageSchema = lazySchema(() =>
   ),
 );
 
+const xaiBatchListResponseSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      batches: z.array(xaiBatchResponseZodSchema()),
+      pagination_token: z.string().nullish(),
+    }),
+  ),
+);
+
 export class XaiBatch implements BatchV4<XaiBatchModelIds> {
   readonly specificationVersion = 'v4' as const;
   readonly provider: string;
@@ -262,6 +275,58 @@ export class XaiBatch implements BatchV4<XaiBatchModelIds> {
     return convertXaiBatchStatus(await this.retrieveBatch(options));
   }
 
+  async doCancelBatch(
+    options: BatchV4OperationOptions,
+  ): Promise<BatchV4CancelResult> {
+    await postJsonToApi({
+      url: this.getUrl(
+        `/batches/${encodeURIComponent(options.batchId)}:cancel`,
+      ),
+      headers: combineHeaders(this.options.config.headers?.(), options.headers),
+      body: {},
+      failedResponseHandler: xaiFailedResponseHandler,
+      successfulResponseHandler: createJsonResponseHandler(
+        xaiBatchResponseSchema,
+      ),
+      abortSignal: options.abortSignal,
+      fetch: this.options.config.fetch,
+    });
+
+    return {};
+  }
+
+  async doListBatches(options: BatchV4ListOptions): Promise<BatchV4ListResult> {
+    const url = new URL(this.getUrl('/batches'));
+    if (options.limit != null) {
+      url.searchParams.set('limit', String(options.limit));
+    }
+    if (options.cursor != null) {
+      url.searchParams.set('pagination_token', options.cursor);
+    }
+
+    const { value: page } = await getFromApi({
+      url: url.toString(),
+      headers: combineHeaders(this.options.config.headers?.(), options.headers),
+      failedResponseHandler: xaiFailedResponseHandler,
+      successfulResponseHandler: createJsonResponseHandler(
+        xaiBatchListResponseSchema,
+      ),
+      abortSignal: options.abortSignal,
+      fetch: this.options.config.fetch,
+      validateUrl: false,
+    });
+
+    return {
+      batches: page.batches.map(batch => ({
+        batchId: batch.batch_id,
+        ...convertXaiBatchStatus(batch),
+      })),
+      ...(page.pagination_token != null
+        ? { nextCursor: page.pagination_token }
+        : {}),
+    };
+  }
+
   async doGetBatchResults(
     options: BatchV4OperationOptions,
   ): Promise<ReadableStream<BatchV4ItemResult>> {