feat (provider/xai): Support structured output for latest models.

.changeset/tall-moles-roll.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/xai': patch
+---
+
+feat (provider/xai): Support structured output for latest models.

examples/ai-core/src/generate-object/xai.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
 
 async function main() {
   const result = await generateObject({
-    model: xai('grok-beta'),
+    model: xai('grok-2-1212'),
     schema: z.object({
       recipe: z.object({
         name: z.string(),

examples/ai-core/src/generate-text/xai-structured-output.ts

@@ -0,0 +1,28 @@
+import 'dotenv/config';
+import { generateText, Output } from 'ai';
+import { xai } from '@ai-sdk/xai';
+import { z } from 'zod';
+
+async function main() {
+  const { experimental_output } = await generateText({
+    model: xai('grok-2-1212'),
+    experimental_output: Output.object({
+      schema: z.object({
+        name: z.string(),
+        age: z.number().nullable().describe('Age of the person.'),
+        contact: z.object({
+          type: z.literal('email'),
+          value: z.string(),
+        }),
+        occupation: z.object({
+          type: z.literal('employed'),
+          company: z.string(),
+          position: z.string(),
+        }),
+      }),
+    }),
+    prompt: 'Generate an example person for testing.',
+  });
+}
+
+main().catch(console.error);

examples/ai-core/src/generate-text/xai-tool-call.ts

@@ -6,7 +6,7 @@ import { weatherTool } from '../tools/weather-tool';
 
 async function main() {
   const result = await generateText({
-    model: xai('grok-beta'),
+    model: xai('grok-2-1212'),
     maxTokens: 512,
     tools: {
       weather: weatherTool,

examples/ai-core/src/generate-text/xai.ts

@@ -1,10 +1,10 @@
+import 'dotenv/config';
 import { xai } from '@ai-sdk/xai';
 import { generateText } from 'ai';
-import 'dotenv/config';
 
 async function main() {
   const result = await generateText({
-    model: xai('grok-beta'),
+    model: xai('grok-2-1212'),
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 

examples/ai-core/src/stream-object/xai.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
 
 async function main() {
   const result = streamObject({
-    model: xai('grok-beta'),
+    model: xai('grok-2-1212'),
     schema: z.object({
       characters: z.array(
         z.object({

examples/ai-core/src/stream-text/xai-chatbot.ts

@@ -18,7 +18,7 @@ async function main() {
     messages.push({ role: 'user', content: userInput });
 
     const result = streamText({
-      model: xai('grok-beta'),
+      model: xai('grok-2-1212'),
       tools: {
         weather: tool({
           description: 'Get the weather in a location',

examples/ai-core/src/stream-text/xai-image.ts

@@ -5,7 +5,7 @@ import fs from 'node:fs';
 
 async function main() {
   const result = streamText({
-    model: xai('grok-vision-beta'),
+    model: xai('grok-2-vision-1212'),
     messages: [
       {
         role: 'user',

examples/ai-core/src/stream-text/xai-tool-call.ts

@@ -9,7 +9,7 @@ async function main() {
   let toolResponseAvailable = false;
 
   const result = streamText({
-    model: xai('grok-beta'),
+    model: xai('grok-2-1212'),
     maxTokens: 512,
     tools: {
       weather: weatherTool,

examples/ai-core/src/stream-text/xai.ts

@@ -4,7 +4,7 @@ import 'dotenv/config';
 
 async function main() {
   const result = streamText({
-    model: xai('grok-beta'),
+    model: xai('grok-2-1212'),
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 

packages/xai/src/xai-chat-settings.ts

@@ -9,3 +9,7 @@ export type XaiChatModelId =
   | (string & {});
 
 export interface XaiChatSettings extends OpenAICompatibleChatSettings {}
+
+export function supportsStructuredOutputs(modelId: XaiChatModelId) {
+  return ['grok-2-1212', 'grok-2-vision-1212'].includes(modelId);
+}

packages/xai/src/xai-provider.ts

@@ -9,7 +9,11 @@ import {
   loadApiKey,
   withoutTrailingSlash,
 } from '@ai-sdk/provider-utils';
-import { XaiChatModelId, XaiChatSettings } from './xai-chat-settings';
+import {
+  XaiChatModelId,
+  XaiChatSettings,
+  supportsStructuredOutputs,
+} from './xai-chat-settings';
 import { z } from 'zod';
 import { ProviderErrorStructure } from '@ai-sdk/openai-compatible';
 
@@ -89,13 +93,15 @@ export function createXai(options: XaiProviderSettings = {}): XaiProvider {
     modelId: XaiChatModelId,
     settings: XaiChatSettings = {},
   ) => {
+    const structuredOutputs = supportsStructuredOutputs(modelId);
     return new OpenAICompatibleChatLanguageModel(modelId, settings, {
       provider: 'xai.chat',
       url: ({ path }) => `${baseURL}${path}`,
       headers: getHeaders,
       fetch: options.fetch,
-      defaultObjectGenerationMode: 'tool',
+      defaultObjectGenerationMode: structuredOutputs ? 'json' : 'tool',
       errorStructure: xaiErrorStructure,
+      supportsStructuredOutputs: structuredOutputs,
     });
   };