@ai-sdk/provider 3.0.5 → 3.0.7

package/src/video-model/v3/video-model-v3-call-options.ts

@@ -0,0 +1,81 @@
+import { SharedV3ProviderOptions } from '../../shared';
+import { VideoModelV3File } from './video-model-v3-file';
+
+export type VideoModelV3CallOptions = {
+  /**
+   * Text prompt for the video generation.
+   */
+  prompt: string | undefined;
+
+  /**
+   * Number of videos to generate. Default: 1.
+   * Most video models only support n=1 due to computational cost.
+   */
+  n: number;
+
+  /**
+   * Aspect ratio of the videos to generate.
+   * Must have the format `{width}:{height}`.
+   * `undefined` will use the provider's default aspect ratio.
+   * Common values: '16:9', '9:16', '1:1', '21:9', '4:3'
+   */
+  aspectRatio: `${number}:${number}` | undefined;
+
+  /**
+   * Resolution of the video to generate.
+   * Format: `{width}x{height}` (e.g., '1280x720', '1920x1080')
+   * `undefined` will use the provider's default resolution.
+   */
+  resolution: `${number}x${number}` | undefined;
+
+  /**
+   * Duration of the video in seconds.
+   * `undefined` will use the provider's default duration.
+   * Typically 3-10 seconds for most models.
+   */
+  duration: number | undefined;
+
+  /**
+   * Frames per second (FPS) for the video.
+   * `undefined` will use the provider's default FPS.
+   * Common values: 24, 30, 60
+   */
+  fps: number | undefined;
+
+  /**
+   * Seed for deterministic video generation.
+   * `undefined` will use a random seed.
+   */
+  seed: number | undefined;
+
+  /**
+   * Input image for image-to-video generation.
+   * The image serves as the starting frame that the model will animate.
+   */
+  image: VideoModelV3File | undefined;
+
+  /**
+   * Additional provider-specific options that are passed through to the provider
+   * as body parameters.
+   *
+   * Example:
+   * {
+   *   "fal": {
+   *     "loop": true,
+   *     "motionStrength": 0.8
+   *   }
+   * }
+   */
+  providerOptions: SharedV3ProviderOptions;
+
+  /**
+   * Abort signal for cancelling the operation.
+   */
+  abortSignal?: AbortSignal;
+
+  /**
+   * Additional HTTP headers to be sent with the request.
+   * Only applicable for HTTP-based providers.
+   */
+  headers?: Record<string, string | undefined>;
+};

package/src/video-model/v3/video-model-v3-file.ts

@@ -0,0 +1,40 @@
+import { SharedV3ProviderMetadata } from '../../shared';
+
+/**
+ * A video or image file that can be used for video editing or image-to-video generation.
+ * Supports both image inputs (for image-to-video) and video inputs (for editing).
+ */
+export type VideoModelV3File =
+  | {
+      type: 'file';
+
+      /**
+       * The IANA media type of the file.
+       * Video types: 'video/mp4', 'video/webm', 'video/quicktime'
+       * Image types: 'image/png', 'image/jpeg', 'image/webp'
+       */
+      mediaType: string;
+
+      /**
+       * File data as base64 encoded string or binary data.
+       */
+      data: string | Uint8Array;
+
+      /**
+       * Optional provider-specific metadata for the file part.
+       */
+      providerOptions?: SharedV3ProviderMetadata;
+    }
+  | {
+      type: 'url';
+
+      /**
+       * The URL of the video or image file.
+       */
+      url: string;
+
+      /**
+       * Optional provider-specific metadata for the file part.
+       */
+      providerOptions?: SharedV3ProviderMetadata;
+    };

package/src/video-model/v3/video-model-v3.ts

@@ -0,0 +1,132 @@
+import type { VideoModelV3CallOptions } from './video-model-v3-call-options';
+import type { SharedV3ProviderMetadata } from '../../shared/v3/shared-v3-provider-metadata';
+import type { SharedV3Warning } from '../../shared/v3/shared-v3-warning';
+
+type GetMaxVideosPerCallFunction = (options: {
+  modelId: string;
+}) => PromiseLike<number | undefined> | number | undefined;
+
+/**
+ * Generated video data. Can be a URL, base64-encoded string, or binary data.
+ */
+export type VideoModelV3VideoData =
+  | {
+      /**
+       * Video available as a URL (most common for video providers).
+       */
+      type: 'url';
+      url: string;
+      mediaType: string;
+    }
+  | {
+      /**
+       * Video as base64-encoded string.
+       */
+      type: 'base64';
+      data: string;
+      mediaType: string;
+    }
+  | {
+      /**
+       * Video as binary data.
+       */
+      type: 'binary';
+      data: Uint8Array;
+      mediaType: string;
+    };
+
+/**
+ * Video generation model specification version 3.
+ */
+export type VideoModelV3 = {
+  /**
+   * The video model must specify which video model interface
+   * version it implements. This will allow us to evolve the video
+   * model interface and retain backwards compatibility. The different
+   * implementation versions can be handled as a discriminated union
+   * on our side.
+   */
+  readonly specificationVersion: 'v3';
+
+  /**
+   * Name of the provider for logging purposes.
+   */
+  readonly provider: string;
+
+  /**
+   * Provider-specific model ID for logging purposes.
+   */
+  readonly modelId: string;
+
+  /**
+   * Limit of how many videos can be generated in a single API call.
+   * Can be set to a number for a fixed limit, to undefined to use
+   * the global limit, or a function that returns a number or undefined,
+   * optionally as a promise.
+   *
+   * Most video models only support generating 1 video at a time due to
+   * computational cost. Default is typically 1.
+   */
+  readonly maxVideosPerCall: number | undefined | GetMaxVideosPerCallFunction;
+
+  /**
+   * Generates an array of videos.
+   */
+  doGenerate(options: VideoModelV3CallOptions): PromiseLike<{
+    /**
+     * Generated videos as URLs, base64 strings, or binary data.
+     *
+     * Most providers return URLs to video files (MP4, WebM) due to large file sizes.
+     * Use the discriminated union to indicate the type of video data being returned.
+     */
+    videos: Array<VideoModelV3VideoData>;
+
+    /**
+     * Warnings for the call, e.g. unsupported features.
+     */
+    warnings: Array<SharedV3Warning>;
+
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * from the provider to the AI SDK and enable provider-specific
+     * results that can be fully encapsulated in the provider.
+     *
+     * The outer record is keyed by the provider name, and the inner
+     * record is provider-specific metadata.
+     *
+     * ```ts
+     * {
+     *   "fal": {
+     *     "videos": [{
+     *       "duration": 5.0,
+     *       "fps": 24,
+     *       "width": 1280,
+     *       "height": 720
+     *     }]
+     *   }
+     * }
+     * ```
+     */
+    providerMetadata?: SharedV3ProviderMetadata;
+
+    /**
+     * Response information for telemetry and debugging purposes.
+     */
+    response: {
+      /**
+       * Timestamp for the start of the generated response.
+       */
+      timestamp: Date;
+
+      /**
+       * The ID of the response model that was used to generate the response.
+       */
+      modelId: string;
+
+      /**
+       * Response headers.
+       */
+      headers: Record<string, string> | undefined;
+    };
+  }>;
+};