@ai-sdk/xai 3.0.52 → 3.0.53

package/docs/01-xai.mdx

@@ -104,6 +104,8 @@ xAI chat models support additional provider options that are not part of
 the [standard call settings](/docs/ai-sdk-core/settings). You can pass them in the `providerOptions` argument:
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const model = xai('grok-3-mini');
 
 await generateText({
@@ -111,7 +113,7 @@ await generateText({
   providerOptions: {
     xai: {
       reasoningEffort: 'high',
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 ```
@@ -342,7 +344,7 @@ const { text } = await generateText({
 The file search tool enables searching through documents stored in xAI vector stores (collections):
 
 ```ts
-import { xai } from '@ai-sdk/xai';
+import { xai, type XaiLanguageModelResponsesOptions } from '@ai-sdk/xai';
 import { streamText } from 'ai';
 
 const result = streamText({
@@ -357,7 +359,7 @@ const result = streamText({
   providerOptions: {
     xai: {
       include: ['file_search_call.results'],
-    },
+    } satisfies XaiLanguageModelResponsesOptions,
   },
 });
 ```
@@ -423,7 +425,7 @@ for await (const part of fullStream) {
 The Responses API supports the following provider options:
 
 ```ts
-import { xai } from '@ai-sdk/xai';
+import { xai, type XaiLanguageModelResponsesOptions } from '@ai-sdk/xai';
 import { generateText } from 'ai';
 
 const result = await generateText({
@@ -431,7 +433,7 @@ const result = await generateText({
   providerOptions: {
     xai: {
       reasoningEffort: 'high',
-    },
+    } satisfies XaiLanguageModelResponsesOptions,
   },
   // ...
 });
@@ -469,7 +471,7 @@ xAI models support Live Search functionality, allowing them to query real-time d
 To enable search, specify `searchParameters` with a search mode:
 
 ```ts
-import { xai } from '@ai-sdk/xai';
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
 import { generateText } from 'ai';
 
 const { text, sources } = await generateText({
@@ -482,7 +484,7 @@ const { text, sources } = await generateText({
         returnCitations: true,
         maxSearchResults: 5,
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 
@@ -529,6 +531,8 @@ You can specify different types of data sources for search:
 #### Web Search
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const result = await generateText({
   model: xai('grok-3-latest'),
   prompt: 'Best ski resorts in Switzerland',
@@ -545,7 +549,7 @@ const result = await generateText({
           },
         ],
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 ```
@@ -560,6 +564,8 @@ const result = await generateText({
 #### X (Twitter) Search
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const result = await generateText({
   model: xai('grok-3-latest'),
   prompt: 'Latest updates on Grok AI',
@@ -577,7 +583,7 @@ const result = await generateText({
           },
         ],
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 ```
@@ -592,6 +598,8 @@ const result = await generateText({
 #### News Search
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const result = await generateText({
   model: xai('grok-3-latest'),
   prompt: 'Recent tech industry news',
@@ -608,7 +616,7 @@ const result = await generateText({
           },
         ],
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 ```
@@ -622,6 +630,8 @@ const result = await generateText({
 #### RSS Feed Search
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const result = await generateText({
   model: xai('grok-3-latest'),
   prompt: 'Latest status updates',
@@ -636,7 +646,7 @@ const result = await generateText({
           },
         ],
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 ```
@@ -650,6 +660,8 @@ const result = await generateText({
 You can combine multiple data sources in a single search:
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const result = await generateText({
   model: xai('grok-3-latest'),
   prompt: 'Comprehensive overview of recent AI breakthroughs',
@@ -674,7 +686,7 @@ const result = await generateText({
           },
         ],
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 ```
@@ -684,6 +696,8 @@ const result = await generateText({
 When search is enabled with `returnCitations: true`, the response includes sources that were used to generate the answer:
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
+
 const { text, sources } = await generateText({
   model: xai('grok-3-latest'),
   prompt: 'What are the latest developments in AI?',
@@ -693,7 +707,7 @@ const { text, sources } = await generateText({
         mode: 'auto',
         returnCitations: true,
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 
@@ -710,6 +724,7 @@ for (const source of sources) {
 Live Search works with streaming responses. Citations are included when the stream completes:
 
 ```ts
+import { xai, type XaiLanguageModelChatOptions } from '@ai-sdk/xai';
 import { streamText } from 'ai';
 
 const result = streamText({
@@ -721,7 +736,7 @@ const result = streamText({
         mode: 'auto',
         returnCitations: true,
       },
-    },
+    } satisfies XaiLanguageModelChatOptions,
   },
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/xai",
-  "version": "3.0.52",
+  "version": "3.0.53",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -29,9 +29,9 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai-compatible": "2.0.28",
     "@ai-sdk/provider": "3.0.8",
-    "@ai-sdk/provider-utils": "4.0.14"
+    "@ai-sdk/provider-utils": "4.0.14",
+    "@ai-sdk/openai-compatible": "2.0.29"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/index.ts

@@ -1,7 +1,19 @@
-export type { XaiProviderOptions } from './xai-chat-options';
+export type {
+  XaiLanguageModelChatOptions,
+  /** @deprecated Use `XaiLanguageModelChatOptions` instead. */
+  XaiLanguageModelChatOptions as XaiProviderOptions,
+} from './xai-chat-options';
 export type { XaiErrorData } from './xai-error';
-export type { XaiImageProviderOptions } from './xai-image-options';
-export type { XaiResponsesProviderOptions } from './responses/xai-responses-options';
+export type {
+  XaiLanguageModelResponsesOptions,
+  /** @deprecated Use `XaiLanguageModelResponsesOptions` instead. */
+  XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions,
+} from './responses/xai-responses-options';
+export type {
+  XaiImageModelOptions,
+  /** @deprecated Use `XaiImageModelOptions` instead. */
+  XaiImageModelOptions as XaiImageProviderOptions,
+} from './xai-image-options';
 export { createXai, xai } from './xai-provider';
 export type { XaiProvider, XaiProviderSettings } from './xai-provider';
 export {

package/src/responses/xai-responses-language-model.ts

@@ -31,7 +31,7 @@ import {
 } from './xai-responses-api';
 import {
   XaiResponsesModelId,
-  xaiResponsesProviderOptions,
+  xaiLanguageModelResponsesOptions,
 } from './xai-responses-options';
 import { prepareResponsesTools } from './xai-responses-prepare-tools';
 
@@ -81,7 +81,7 @@ export class XaiResponsesLanguageModel implements LanguageModelV3 {
       (await parseProviderOptions({
         provider: 'xai',
         providerOptions,
-        schema: xaiResponsesProviderOptions,
+        schema: xaiLanguageModelResponsesOptions,
       })) ?? {};
 
     if (stopSequences != null) {

package/src/responses/xai-responses-options.ts

@@ -11,7 +11,7 @@ export type XaiResponsesModelId =
 /**
  * @see https://docs.x.ai/docs/api-reference#create-new-response
  */
-export const xaiResponsesProviderOptions = z.object({
+export const xaiLanguageModelResponsesOptions = z.object({
   /**
    * Constrains how hard a reasoning model thinks before responding.
    * Possible values are `low` (uses fewer reasoning tokens), `medium` and `high` (uses more reasoning tokens).
@@ -33,6 +33,6 @@ export const xaiResponsesProviderOptions = z.object({
   include: z.array(z.enum(['file_search_call.results'])).nullish(),
 });
 
-export type XaiResponsesProviderOptions = z.infer<
-  typeof xaiResponsesProviderOptions
+export type XaiLanguageModelResponsesOptions = z.infer<
+  typeof xaiLanguageModelResponsesOptions
 >;

package/src/xai-chat-language-model.ts

@@ -26,7 +26,10 @@ import { convertToXaiChatMessages } from './convert-to-xai-chat-messages';
 import { convertXaiChatUsage } from './convert-xai-chat-usage';
 import { getResponseMetadata } from './get-response-metadata';
 import { mapXaiFinishReason } from './map-xai-finish-reason';
-import { XaiChatModelId, xaiProviderOptions } from './xai-chat-options';
+import {
+  XaiChatModelId,
+  xaiLanguageModelChatOptions,
+} from './xai-chat-options';
 import { xaiFailedResponseHandler } from './xai-error';
 import { prepareTools } from './xai-prepare-tools';
 
@@ -80,7 +83,7 @@ export class XaiChatLanguageModel implements LanguageModelV3 {
       (await parseProviderOptions({
         provider: 'xai',
         providerOptions,
-        schema: xaiProviderOptions,
+        schema: xaiLanguageModelChatOptions,
       })) ?? {};
 
     // check for unsupported parameters

package/src/xai-chat-options.ts

@@ -72,7 +72,7 @@ const searchSourceSchema = z.discriminatedUnion('type', [
 ]);
 
 // xai-specific provider options
-export const xaiProviderOptions = z.object({
+export const xaiLanguageModelChatOptions = z.object({
   reasoningEffort: z.enum(['low', 'high']).optional(),
 
   /**
@@ -127,4 +127,6 @@ export const xaiProviderOptions = z.object({
     .optional(),
 });
 
-export type XaiProviderOptions = z.infer<typeof xaiProviderOptions>;
+export type XaiLanguageModelChatOptions = z.infer<
+  typeof xaiLanguageModelChatOptions
+>;

package/src/xai-image-model.ts

@@ -12,7 +12,7 @@ import {
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import { xaiFailedResponseHandler } from './xai-error';
-import { xaiImageProviderOptions } from './xai-image-options';
+import { xaiImageModelOptions } from './xai-image-options';
 import { XaiImageModelId } from './xai-image-settings';
 
 interface XaiImageModelConfig {
@@ -80,7 +80,7 @@ export class XaiImageModel implements ImageModelV3 {
     const xaiOptions = await parseProviderOptions({
       provider: 'xai',
       providerOptions,
-      schema: xaiImageProviderOptions,
+      schema: xaiImageModelOptions,
     });
 
     const hasFiles = files != null && files.length > 0;

package/src/xai-image-options.ts

@@ -1,9 +1,9 @@
 import { z } from 'zod/v4';
 
-export const xaiImageProviderOptions = z.object({
+export const xaiImageModelOptions = z.object({
   aspect_ratio: z.string().optional(),
   output_format: z.string().optional(),
   sync_mode: z.boolean().optional(),
 });
 
-export type XaiImageProviderOptions = z.infer<typeof xaiImageProviderOptions>;
+export type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;