@ai-sdk/provider 4.0.0-beta.9 → 4.0.0-canary.16

package/src/shared/v4/shared-v4-file-data.ts

@@ -0,0 +1,49 @@
+import type { SharedV4ProviderReference } from './shared-v4-provider-reference';
+
+/**
+ * File data variant containing raw bytes (`Uint8Array`) or a base64-encoded
+ * string.
+ */
+export interface SharedV4FileDataData {
+  type: 'data';
+  data: Uint8Array | string;
+}
+
+/**
+ * File data variant containing a URL that points to the file.
+ */
+export interface SharedV4FileDataUrl {
+  type: 'url';
+  url: URL;
+}
+
+/**
+ * File data variant containing a provider reference (`{ [provider]: id }`).
+ */
+export interface SharedV4FileDataReference {
+  type: 'reference';
+  reference: SharedV4ProviderReference;
+}
+
+/**
+ * File data variant containing inline text content (e.g. an inline text
+ * document).
+ */
+export interface SharedV4FileDataText {
+  type: 'text';
+  text: string;
+}
+
+/**
+ * File data as a tagged discriminated union:
+ *
+ * - `{ type: 'data', data }`: raw bytes (`Uint8Array`) or base64-encoded string.
+ * - `{ type: 'url', url }`: a URL that points to the file.
+ * - `{ type: 'reference', reference }`: a provider reference (`{ [provider]: id }`).
+ * - `{ type: 'text', text }`: inline text content (e.g. an inline text document).
+ */
+export type SharedV4FileData =
+  | SharedV4FileDataData
+  | SharedV4FileDataUrl
+  | SharedV4FileDataReference
+  | SharedV4FileDataText;

package/src/shared/v4/shared-v4-provider-metadata.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../json-value/json-value';
+import type { JSONObject } from '../../json-value/json-value';
 
 /**
  * Additional provider-specific metadata.

package/src/shared/v4/shared-v4-provider-options.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../json-value/json-value';
+import type { JSONObject } from '../../json-value/json-value';
 
 /**
  * Additional provider-specific options.

package/src/shared/v4/shared-v4-provider-reference.ts

@@ -11,5 +11,12 @@
  *   "anthropic": "file-xyz789"
  * }
  * ```
+ *
+ * The `type?: never` constraint excludes any object that has a `type`
+ * property, so a `SharedV4ProviderReference` cannot be confused with a
+ * tagged file-data shape (e.g. `{ type: 'data', data }` or
+ * `{ type: 'reference', reference }`) when both appear in the same union.
  */
-export type SharedV4ProviderReference = Record<string, string>;
+export type SharedV4ProviderReference = Record<string, string> & {
+  type?: never;
+};

package/src/skills/v4/index.ts

@@ -1,6 +1,6 @@
+export type { SkillsV4 } from './skills-v4';
 export type {
-  SkillsV4,
   SkillsV4File,
-  SkillsV4UploadParams,
-  SkillsV4UploadResult,
-} from './skills-v4';
+  SkillsV4UploadSkillCallOptions,
+} from './skills-v4-upload-skill-call-options';
+export type { SkillsV4UploadSkillResult } from './skills-v4-upload-skill-result';

package/src/skills/v4/skills-v4-upload-skill-call-options.ts

@@ -0,0 +1,37 @@
+import type {
+  SharedV4FileDataData,
+  SharedV4FileDataText,
+} from '../../shared/v4/shared-v4-file-data';
+import type { SharedV4ProviderOptions } from '../../shared/v4/shared-v4-provider-options';
+
+export interface SkillsV4File {
+  /**
+   * The path of the file relative to the skill root.
+   */
+  path: string;
+
+  /**
+   * The file data.
+   *
+   * - `{ type: 'data', data }`: raw bytes (`Uint8Array`) or a base64-encoded string.
+   * - `{ type: 'text', text }`: inline text (UTF-8).
+   */
+  data: SharedV4FileDataData | SharedV4FileDataText;
+}
+
+export interface SkillsV4UploadSkillCallOptions {
+  /**
+   * The files that make up the skill.
+   */
+  files: SkillsV4File[];
+
+  /**
+   * Optional human-readable title for the skill.
+   */
+  displayTitle?: string;
+
+  /**
+   * Additional provider-specific options.
+   */
+  providerOptions?: SharedV4ProviderOptions;
+}

package/src/skills/v4/skills-v4-upload-skill-result.ts

@@ -0,0 +1,40 @@
+import type { SharedV4ProviderMetadata } from '../../shared/v4/shared-v4-provider-metadata';
+import type { SharedV4ProviderReference } from '../../shared/v4/shared-v4-provider-reference';
+import type { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
+
+export interface SkillsV4UploadSkillResult {
+  /**
+   * A provider reference mapping provider names to provider-specific skill identifiers.
+   */
+  providerReference: SharedV4ProviderReference;
+
+  /**
+   * Optional human-readable title for the uploaded skill.
+   */
+  displayTitle?: string;
+
+  /**
+   * Optional name of the uploaded skill.
+   */
+  name?: string;
+
+  /**
+   * Optional description of what the uploaded skill does.
+   */
+  description?: string;
+
+  /**
+   * Optional latest version identifier of the uploaded skill.
+   */
+  latestVersion?: string;
+
+  /**
+   * Additional provider-specific metadata.
+   */
+  providerMetadata?: SharedV4ProviderMetadata;
+
+  /**
+   * Warnings for the call, e.g. unsupported settings.
+   */
+  warnings: SharedV4Warning[];
+}

package/src/skills/v4/skills-v4.ts

@@ -1,73 +1,5 @@
-import { SharedV4ProviderOptions } from '../../shared/v4/shared-v4-provider-options';
-import { SharedV4ProviderMetadata } from '../../shared/v4/shared-v4-provider-metadata';
-import { SharedV4ProviderReference } from '../../shared/v4/shared-v4-provider-reference';
-import { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
-
-export interface SkillsV4File {
-  /**
-   * The path of the file relative to the skill root.
-   */
-  path: string;
-
-  /**
-   * The content of the file, either as a base64 string or binary data.
-   */
-  content: string | Uint8Array;
-}
-
-export interface SkillsV4UploadParams {
-  /**
-   * The files that make up the skill.
-   */
-  files: SkillsV4File[];
-
-  /**
-   * Optional human-readable title for the skill.
-   */
-  displayTitle?: string;
-
-  /**
-   * Additional provider-specific options.
-   */
-  providerOptions?: SharedV4ProviderOptions;
-}
-
-export interface SkillsV4UploadResult {
-  /**
-   * A provider reference mapping provider names to provider-specific skill identifiers.
-   */
-  providerReference: SharedV4ProviderReference;
-
-  /**
-   * Optional human-readable title for the uploaded skill.
-   */
-  displayTitle?: string;
-
-  /**
-   * Optional name of the uploaded skill.
-   */
-  name?: string;
-
-  /**
-   * Optional description of what the uploaded skill does.
-   */
-  description?: string;
-
-  /**
-   * Optional latest version identifier of the uploaded skill.
-   */
-  latestVersion?: string;
-
-  /**
-   * Additional provider-specific metadata.
-   */
-  providerMetadata?: SharedV4ProviderMetadata;
-
-  /**
-   * Warnings for the call, e.g. unsupported settings.
-   */
-  warnings: SharedV4Warning[];
-}
+import type { SkillsV4UploadSkillCallOptions } from './skills-v4-upload-skill-call-options';
+import type { SkillsV4UploadSkillResult } from './skills-v4-upload-skill-result';
 
 /**
  * Skills specification version 4.
@@ -90,5 +22,7 @@ export interface SkillsV4 {
   /**
    * Uploads a new skill from the given files.
    */
-  uploadSkill(params: SkillsV4UploadParams): PromiseLike<SkillsV4UploadResult>;
+  uploadSkill(
+    params: SkillsV4UploadSkillCallOptions,
+  ): PromiseLike<SkillsV4UploadSkillResult>;
 }

package/src/speech-model/v2/speech-model-v2-call-options.ts

@@ -1,4 +1,4 @@
-import { JSONValue } from '../../json-value/json-value';
+import type { JSONValue } from '../../json-value/json-value';
 
 type SpeechModelV2ProviderOptions = Record<string, Record<string, JSONValue>>;
 

package/src/speech-model/v2/speech-model-v2-call-warning.ts

@@ -1,4 +1,4 @@
-import { SpeechModelV2CallOptions } from './speech-model-v2-call-options';
+import type { SpeechModelV2CallOptions } from './speech-model-v2-call-options';
 
 /**
  * Warning from the model provider for this call. The call will proceed, but e.g.

package/src/speech-model/v2/speech-model-v2.ts

@@ -1,7 +1,7 @@
-import { JSONValue } from '../../json-value';
-import { SharedV2Headers } from '../../shared';
-import { SpeechModelV2CallOptions } from './speech-model-v2-call-options';
-import { SpeechModelV2CallWarning } from './speech-model-v2-call-warning';
+import type { JSONValue } from '../../json-value';
+import type { SharedV2Headers } from '../../shared';
+import type { SpeechModelV2CallOptions } from './speech-model-v2-call-options';
+import type { SpeechModelV2CallWarning } from './speech-model-v2-call-warning';
 
 /**
  * Speech model specification version 2.

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

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../json-value/json-value';
+import type { JSONObject } from '../../json-value/json-value';
 
 type SpeechModelV3ProviderOptions = Record<string, JSONObject>;
 

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

@@ -1,7 +1,7 @@
-import { JSONObject } from '../../json-value';
-import { SharedV2Headers } from '../../shared';
-import { SharedV3Warning } from '../../shared/v3/shared-v3-warning';
-import { SpeechModelV3CallOptions } from './speech-model-v3-call-options';
+import type { JSONObject } from '../../json-value';
+import type { SharedV2Headers } from '../../shared';
+import type { SharedV3Warning } from '../../shared/v3/shared-v3-warning';
+import type { SpeechModelV3CallOptions } from './speech-model-v3-call-options';
 
 /**
  * Speech model specification version 3.

package/src/speech-model/v4/index.ts

@@ -1,2 +1,3 @@
 export type { SpeechModelV4 } from './speech-model-v4';
 export type { SpeechModelV4CallOptions } from './speech-model-v4-call-options';
+export type { SpeechModelV4Result } from './speech-model-v4-result';

package/src/speech-model/v4/speech-model-v4-call-options.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../json-value/json-value';
+import type { JSONObject } from '../../json-value/json-value';
 
 type SpeechModelV4ProviderOptions = Record<string, JSONObject>;
 

package/src/speech-model/v4/speech-model-v4-result.ts

@@ -0,0 +1,64 @@
+import type { JSONObject } from '../../json-value';
+import type { SharedV2Headers } from '../../shared';
+import type { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
+
+/**
+ * The result of a speech model doGenerate call.
+ */
+export type SpeechModelV4Result = {
+  /**
+   * Generated audio as an ArrayBuffer.
+   * The audio should be returned without any unnecessary conversion.
+   * If the API returns base64 encoded strings, the audio should be returned
+   * as base64 encoded strings. If the API returns binary data, the audio
+   * should be returned as binary data.
+   */
+  audio: string | Uint8Array;
+
+  /**
+   * Warnings for the call, e.g. unsupported settings.
+   */
+  warnings: Array<SharedV4Warning>;
+
+  /**
+   * Optional request information for telemetry and debugging purposes.
+   */
+  request?: {
+    /**
+     * Response body (available only for providers that use HTTP requests).
+     */
+    body?: unknown;
+  };
+
+  /**
+   * 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?: SharedV2Headers;
+
+    /**
+     * Response body.
+     */
+    body?: unknown;
+  };
+
+  /**
+   * 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.
+   */
+  providerMetadata?: Record<string, JSONObject>;
+};

package/src/speech-model/v4/speech-model-v4.ts

@@ -1,7 +1,5 @@
-import { JSONObject } from '../../json-value';
-import { SharedV2Headers } from '../../shared';
-import { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
-import { SpeechModelV4CallOptions } from './speech-model-v4-call-options';
+import type { SpeechModelV4CallOptions } from './speech-model-v4-call-options';
+import type { SpeechModelV4Result } from './speech-model-v4-result';
 
 /**
  * Speech model specification version 3.
@@ -29,61 +27,7 @@ export type SpeechModelV4 = {
   /**
    * Generates speech audio from text.
    */
-  doGenerate(options: SpeechModelV4CallOptions): PromiseLike<{
-    /**
-     * Generated audio as an ArrayBuffer.
-     * The audio should be returned without any unnecessary conversion.
-     * If the API returns base64 encoded strings, the audio should be returned
-     * as base64 encoded strings. If the API returns binary data, the audio
-     * should be returned as binary data.
-     */
-    audio: string | Uint8Array;
-
-    /**
-     * Warnings for the call, e.g. unsupported settings.
-     */
-    warnings: Array<SharedV4Warning>;
-
-    /**
-     * Optional request information for telemetry and debugging purposes.
-     */
-    request?: {
-      /**
-       * Response body (available only for providers that use HTTP requests).
-       */
-      body?: unknown;
-    };
-
-    /**
-     * 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?: SharedV2Headers;
-
-      /**
-       * Response body.
-       */
-      body?: unknown;
-    };
-
-    /**
-     * 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.
-     */
-    providerMetadata?: Record<string, JSONObject>;
-  }>;
+  doGenerate(
+    options: SpeechModelV4CallOptions,
+  ): PromiseLike<SpeechModelV4Result>;
 };

package/src/transcription-model/v2/transcription-model-v2-call-options.ts

@@ -1,4 +1,4 @@
-import { JSONValue } from '../../json-value/json-value';
+import type { JSONValue } from '../../json-value/json-value';
 
 type TranscriptionModelV2ProviderOptions = Record<
   string,

package/src/transcription-model/v2/transcription-model-v2-call-warning.ts

@@ -1,4 +1,4 @@
-import { TranscriptionModelV2CallOptions } from './transcription-model-v2-call-options';
+import type { TranscriptionModelV2CallOptions } from './transcription-model-v2-call-options';
 
 /**
  * Warning from the model provider for this call. The call will proceed, but e.g.

package/src/transcription-model/v2/transcription-model-v2.ts

@@ -1,7 +1,7 @@
-import { JSONValue } from '../../json-value';
-import { SharedV2Headers } from '../../shared';
-import { TranscriptionModelV2CallOptions } from './transcription-model-v2-call-options';
-import { TranscriptionModelV2CallWarning } from './transcription-model-v2-call-warning';
+import type { JSONValue } from '../../json-value';
+import type { SharedV2Headers } from '../../shared';
+import type { TranscriptionModelV2CallOptions } from './transcription-model-v2-call-options';
+import type { TranscriptionModelV2CallWarning } from './transcription-model-v2-call-warning';
 
 /**
  * Transcription model specification version 2.

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

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../json-value/json-value';
+import type { JSONObject } from '../../json-value/json-value';
 
 type TranscriptionModelV3ProviderOptions = Record<string, JSONObject>;
 

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

@@ -1,7 +1,7 @@
-import { JSONObject } from '../../json-value';
-import { SharedV3Headers } from '../../shared';
-import { SharedV3Warning } from '../../shared/v3/shared-v3-warning';
-import { TranscriptionModelV3CallOptions } from './transcription-model-v3-call-options';
+import type { JSONObject } from '../../json-value';
+import type { SharedV3Headers } from '../../shared';
+import type { SharedV3Warning } from '../../shared/v3/shared-v3-warning';
+import type { TranscriptionModelV3CallOptions } from './transcription-model-v3-call-options';
 
 /**
  * Transcription model specification version 3.

package/src/transcription-model/v4/index.ts

@@ -1,2 +1,3 @@
 export type { TranscriptionModelV4 } from './transcription-model-v4';
 export type { TranscriptionModelV4CallOptions } from './transcription-model-v4-call-options';
+export type { TranscriptionModelV4Result } from './transcription-model-v4-result';

package/src/transcription-model/v4/transcription-model-v4-call-options.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../json-value/json-value';
+import type { JSONObject } from '../../json-value/json-value';
 
 type TranscriptionModelV4ProviderOptions = Record<string, JSONObject>;
 

package/src/transcription-model/v4/transcription-model-v4-result.ts

@@ -0,0 +1,92 @@
+import type { JSONObject } from '../../json-value';
+import type { SharedV4Headers } from '../../shared';
+import type { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
+
+/**
+ * The result of a transcription model doGenerate call.
+ */
+export type TranscriptionModelV4Result = {
+  /**
+   * The complete transcribed text from the audio.
+   */
+  text: string;
+
+  /**
+   * Array of transcript segments with timing information.
+   * Each segment represents a portion of the transcribed text with start and end times.
+   */
+  segments: Array<{
+    /**
+     * The text content of this segment.
+     */
+    text: string;
+    /**
+     * The start time of this segment in seconds.
+     */
+    startSecond: number;
+    /**
+     * The end time of this segment in seconds.
+     */
+    endSecond: number;
+  }>;
+
+  /**
+   * The detected language of the audio content, as an ISO-639-1 code (e.g., 'en' for English).
+   * May be undefined if the language couldn't be detected.
+   */
+  language: string | undefined;
+
+  /**
+   * The total duration of the audio file in seconds.
+   * May be undefined if the duration couldn't be determined.
+   */
+  durationInSeconds: number | undefined;
+
+  /**
+   * Warnings for the call, e.g. unsupported settings.
+   */
+  warnings: Array<SharedV4Warning>;
+
+  /**
+   * Optional request information for telemetry and debugging purposes.
+   */
+  request?: {
+    /**
+     * Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+     * Non-HTTP(s) providers should not set this.
+     */
+    body?: string;
+  };
+
+  /**
+   * 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?: SharedV4Headers;
+
+    /**
+     * Response body.
+     */
+    body?: unknown;
+  };
+
+  /**
+   * 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.
+   */
+  providerMetadata?: Record<string, JSONObject>;
+};