@ai-sdk/xai 4.0.0-beta.3 → 4.0.0-beta.31

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { z } from 'zod/v4';
-import { ProviderV3, LanguageModelV3, ImageModelV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { FetchFunction } from '@ai-sdk/provider-utils';
+import { InferSchema, FetchFunction } from '@ai-sdk/provider-utils';
+import { ProviderV4, LanguageModelV4, ImageModelV4, Experimental_VideoModelV4, FilesV4 } from '@ai-sdk/provider';
 
-type XaiChatModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | 'grok-code-fast-1' | 'grok-4' | 'grok-4-0709' | 'grok-4-latest' | 'grok-3' | 'grok-3-latest' | 'grok-3-mini' | 'grok-3-mini-latest' | 'grok-2-vision-1212' | 'grok-2-vision' | 'grok-2-vision-latest' | 'grok-2-image-1212' | 'grok-2-image' | 'grok-2-image-latest' | (string & {});
+type XaiChatModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | 'grok-4.20-0309-non-reasoning' | 'grok-4.20-0309-reasoning' | 'grok-4.20-multi-agent-0309' | 'grok-code-fast-1' | 'grok-4' | 'grok-4-0709' | 'grok-4-latest' | 'grok-3' | 'grok-3-latest' | 'grok-3-mini' | 'grok-3-mini-latest' | (string & {});
 declare const xaiLanguageModelChatOptions: z.ZodObject<{
     reasoningEffort: z.ZodOptional<z.ZodEnum<{
         low: "low";
@@ -58,7 +58,7 @@ declare const xaiErrorDataSchema: z.ZodObject<{
 }, z.core.$strip>;
 type XaiErrorData = z.infer<typeof xaiErrorDataSchema>;
 
-type XaiResponsesModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | (string & {});
+type XaiResponsesModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | 'grok-4.20-0309-non-reasoning' | 'grok-4.20-0309-reasoning' | 'grok-4.20-multi-agent-0309' | (string & {});
 /**
  * @see https://docs.x.ai/docs/api-reference#create-new-response
  */
@@ -68,6 +68,11 @@ declare const xaiLanguageModelResponsesOptions: z.ZodObject<{
         high: "high";
         medium: "medium";
     }>>;
+    reasoningSummary: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        concise: "concise";
+        detailed: "detailed";
+    }>>;
     logprobs: z.ZodOptional<z.ZodBoolean>;
     topLogprobs: z.ZodOptional<z.ZodNumber>;
     store: z.ZodOptional<z.ZodBoolean>;
@@ -86,29 +91,105 @@ declare const xaiImageModelOptions: z.ZodObject<{
         "1k": "1k";
         "2k": "2k";
     }>>;
+    quality: z.ZodOptional<z.ZodEnum<{
+        low: "low";
+        high: "high";
+        medium: "medium";
+    }>>;
+    user: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;
 
 type XaiVideoModelId = 'grok-imagine-video' | (string & {});
 
-type XaiVideoModelOptions = {
+declare const resolutionSchema: z.ZodEnum<{
+    "480p": "480p";
+    "720p": "720p";
+}>;
+type XaiVideoResolution = z.infer<typeof resolutionSchema>;
+interface XaiVideoSharedOptions {
     pollIntervalMs?: number | null;
     pollTimeoutMs?: number | null;
-    resolution?: '480p' | '720p' | null;
-    videoUrl?: string | null;
-    [key: string]: unknown;
-};
+    resolution?: XaiVideoResolution | null;
+}
+interface XaiVideoEditModeOptions extends XaiVideoSharedOptions {
+    /**
+     * Select edit-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'edit-video';
+    /** Source video URL to edit. */
+    videoUrl: string;
+}
+interface XaiVideoExtendModeOptions extends XaiVideoSharedOptions {
+    /**
+     * Select extend-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'extend-video';
+    /** Source video URL to extend from its last frame. */
+    videoUrl: string;
+}
+interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Select reference-to-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'reference-to-video';
+    /** Reference image URLs (1-7) for R2V generation. */
+    referenceImageUrls: string[];
+}
+interface XaiVideoGenerationOptions extends XaiVideoSharedOptions {
+    mode?: undefined;
+    videoUrl?: undefined;
+    referenceImageUrls?: undefined;
+}
+interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Legacy backward-compatible shape: omitting `mode` while providing
+     * `videoUrl` behaves like edit-video.
+     */
+    mode?: undefined;
+    videoUrl: string;
+}
+interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Legacy backward-compatible shape: omitting `mode` while providing
+     * `referenceImageUrls` behaves like reference-to-video.
+     */
+    mode?: undefined;
+    referenceImageUrls: string[];
+}
+/**
+ * Provider options for xAI video generation.
+ *
+ * Use the `mode` option to select the operation:
+ *
+ * - `'edit-video'`         + `videoUrl`           -- video editing   (`POST /v1/videos/edits`)
+ * - `'extend-video'`       + `videoUrl`           -- video extension (`POST /v1/videos/extensions`)
+ * - `'reference-to-video'` + `referenceImageUrls` -- R2V generation  (`POST /v1/videos/generations`)
+ * - no `mode`                                     -- standard generation from text prompts or image input
+ *
+ * Runtime remains backward compatible with legacy auto-detected provider
+ * options, but the public TypeScript type is intentionally explicit so editors
+ * can suggest valid modes and flag invalid field combinations.
+ */
+type XaiVideoModelOptions = XaiVideoGenerationOptions | XaiVideoEditModeOptions | XaiVideoExtendModeOptions | XaiVideoReferenceToVideoOptions | XaiLegacyEditVideoOptions | XaiLegacyReferenceToVideoOptions;
+
+declare const xaiFilesOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    [x: string]: unknown;
+    teamId?: string | undefined;
+    filePath?: string | undefined;
+}>;
+type XaiFilesOptions = InferSchema<typeof xaiFilesOptionsSchema>;
 
-type XaiImageModelId = 'grok-2-image' | 'grok-2-image-1212' | 'grok-imagine-image' | 'grok-imagine-image-pro' | (string & {});
+type XaiImageModelId = 'grok-imagine-image' | 'grok-imagine-image-pro' | (string & {});
 
 declare const codeExecutionToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
     output: string;
     error?: string | undefined;
-}, object>;
+}, object, {}>;
 declare const codeExecution: (args?: Parameters<typeof codeExecutionToolFactory>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
     output: string;
     error?: string | undefined;
-}>;
+}, {}>;
 
 declare const mcpServerToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     name: string;
@@ -121,32 +202,32 @@ declare const mcpServerToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWi
     allowedTools?: string[];
     headers?: Record<string, string>;
     authorization?: string;
-}>;
+}, {}>;
 declare const mcpServer: (args: Parameters<typeof mcpServerToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
     name: string;
     arguments: string;
     result: unknown;
-}>;
+}, {}>;
 
 declare const viewImageToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
     description: string;
     objects?: string[] | undefined;
-}, object>;
+}, object, {}>;
 declare const viewImage: (args?: Parameters<typeof viewImageToolFactory>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
     description: string;
     objects?: string[] | undefined;
-}>;
+}, {}>;
 
 declare const viewXVideoToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
     description: string;
     transcript?: string | undefined;
     duration?: number | undefined;
-}, object>;
+}, object, {}>;
 declare const viewXVideo: (args?: Parameters<typeof viewXVideoToolFactory>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
     description: string;
     transcript?: string | undefined;
     duration?: number | undefined;
-}>;
+}, {}>;
 
 declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     query: string;
@@ -159,7 +240,7 @@ declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWi
     allowedDomains?: string[];
     excludedDomains?: string[];
     enableImageUnderstanding?: boolean;
-}>;
+}, {}>;
 declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
     query: string;
     sources: Array<{
@@ -167,7 +248,7 @@ declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) =>
         url: string;
         snippet: string;
     }>;
-}>;
+}, {}>;
 
 declare const xSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     query: string;
@@ -184,7 +265,7 @@ declare const xSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWith
     toDate?: string;
     enableImageUnderstanding?: boolean;
     enableVideoUnderstanding?: boolean;
-}>;
+}, {}>;
 declare const xSearch: (args?: Parameters<typeof xSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
     query: string;
     posts: Array<{
@@ -193,16 +274,16 @@ declare const xSearch: (args?: Parameters<typeof xSearchToolFactory>[0]) => _ai_
         url: string;
         likes: number;
     }>;
-}>;
+}, {}>;
 
 declare const xaiTools: {
     codeExecution: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
         output: string;
         error?: string | undefined;
-    }, object>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
+    }, object, {}>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
         output: string;
         error?: string | undefined;
-    }>;
+    }, {}>;
     fileSearch: (args: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         queries: string[];
         results: null | {
@@ -214,7 +295,7 @@ declare const xaiTools: {
     }, {
         vectorStoreIds: string[];
         maxNumResults?: number;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         queries: string[];
         results: null | {
             fileId: string;
@@ -222,7 +303,7 @@ declare const xaiTools: {
             score: number;
             text: string;
         }[];
-    }>;
+    }, {}>;
     mcpServer: (args: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         name: string;
         arguments: string;
@@ -234,27 +315,27 @@ declare const xaiTools: {
         allowedTools?: string[];
         headers?: Record<string, string>;
         authorization?: string;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         name: string;
         arguments: string;
         result: unknown;
-    }>;
+    }, {}>;
     viewImage: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
         description: string;
         objects?: string[] | undefined;
-    }, object>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
+    }, object, {}>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
         description: string;
         objects?: string[] | undefined;
-    }>;
+    }, {}>;
     viewXVideo: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
         description: string;
         transcript?: string | undefined;
         duration?: number | undefined;
-    }, object>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
+    }, object, {}>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
         description: string;
         transcript?: string | undefined;
         duration?: number | undefined;
-    }>;
+    }, {}>;
     webSearch: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         query: string;
         sources: Array<{
@@ -266,14 +347,14 @@ declare const xaiTools: {
         allowedDomains?: string[];
         excludedDomains?: string[];
         enableImageUnderstanding?: boolean;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         query: string;
         sources: Array<{
             title: string;
             url: string;
             snippet: string;
         }>;
-    }>;
+    }, {}>;
     xSearch: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         query: string;
         posts: Array<{
@@ -289,7 +370,7 @@ declare const xaiTools: {
         toDate?: string;
         enableImageUnderstanding?: boolean;
         enableVideoUnderstanding?: boolean;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         query: string;
         posts: Array<{
             author: string;
@@ -297,42 +378,43 @@ declare const xaiTools: {
             url: string;
             likes: number;
         }>;
-    }>;
+    }, {}>;
 };
 
-interface XaiProvider extends ProviderV3 {
-    /**
-     * Creates an Xai chat model for text generation.
-     */
-    (modelId: XaiChatModelId): LanguageModelV3;
+interface XaiProvider extends ProviderV4 {
+    (modelId: XaiResponsesModelId): LanguageModelV4;
     /**
      * Creates an Xai language model for text generation.
      */
-    languageModel(modelId: XaiChatModelId): LanguageModelV3;
+    languageModel(modelId: XaiResponsesModelId): LanguageModelV4;
     /**
      * Creates an Xai chat model for text generation.
      */
-    chat: (modelId: XaiChatModelId) => LanguageModelV3;
+    chat: (modelId: XaiChatModelId) => LanguageModelV4;
     /**
-     * Creates an Xai responses model for agentic tool calling.
+     * Creates an Xai responses model for text generation.
      */
-    responses: (modelId: XaiResponsesModelId) => LanguageModelV3;
+    responses: (modelId: XaiResponsesModelId) => LanguageModelV4;
     /**
      * Creates an Xai image model for image generation.
      */
-    image(modelId: XaiImageModelId): ImageModelV3;
+    image(modelId: XaiImageModelId): ImageModelV4;
     /**
      * Creates an Xai image model for image generation.
      */
-    imageModel(modelId: XaiImageModelId): ImageModelV3;
+    imageModel(modelId: XaiImageModelId): ImageModelV4;
     /**
      * Creates an Xai video model for video generation.
      */
-    video(modelId: XaiVideoModelId): Experimental_VideoModelV3;
+    video(modelId: XaiVideoModelId): Experimental_VideoModelV4;
     /**
      * Creates an Xai video model for video generation.
      */
-    videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV3;
+    videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV4;
+    /**
+     * Returns the xAI files interface for uploading files.
+     */
+    files(): FilesV4;
     /**
      * Server-side agentic tools for use with the responses API.
      */
@@ -366,4 +448,4 @@ declare const xai: XaiProvider;
 
 declare const VERSION: string;
 
-export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };
+export { VERSION, type XaiErrorData, type XaiFilesOptions, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };