@ai-sdk/cartesia 0.0.1 → 3.0.2

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# @ai-sdk/cartesia
+
+## 3.0.2
+
+### Patch Changes
+
+- Updated dependencies [4be62c1]
+- Updated dependencies [7805e4a]
+- Updated dependencies [cd12954]
+  - @ai-sdk/provider-utils@5.0.9
+
+## 3.0.1
+
+### Patch Changes
+
+- Updated dependencies [e193290]
+  - @ai-sdk/provider-utils@5.0.8
+
+## 3.0.0
+
+### Major Changes
+
+- 8f89c25: Add the Cartesia provider with Sonic 3.5 speech generation, Ink-Whisper batch transcription, and Ink 2 realtime transcription support.

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,47 @@
+# AI SDK - Cartesia Provider
+
+The **[Cartesia provider](https://ai-sdk.dev/providers/ai-sdk-providers/cartesia)** for the [AI SDK](https://ai-sdk.dev/docs)
+contains Sonic 3.5 speech generation, Ink-Whisper batch transcription, and Ink 2 realtime transcription support.
+
+> **Deploying to Vercel?** With Vercel's AI Gateway you can access Cartesia (and hundreds of models from other providers) — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
+
+## Setup
+
+The Cartesia provider is available in the `@ai-sdk/cartesia` module. You can install it with
+
+```bash
+npm i @ai-sdk/cartesia
+```
+
+## Skill for Coding Agents
+
+If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:
+
+```shell
+npx skills add vercel/ai
+```
+
+## Provider Instance
+
+You can import the default provider instance `cartesia` from `@ai-sdk/cartesia`:
+
+```ts
+import { cartesia } from '@ai-sdk/cartesia';
+```
+
+## Example
+
+```ts
+import { cartesia } from '@ai-sdk/cartesia';
+import { generateSpeech } from 'ai';
+
+const { audio } = await generateSpeech({
+  model: cartesia.speech('sonic-3.5'),
+  text: 'Hello from the Vercel AI SDK!',
+  voice: 'a0e99841-438c-4a64-b679-ae501e7d6091',
+});
+```
+
+## Documentation
+
+Please check out the **[Cartesia provider documentation](https://ai-sdk.dev/providers/ai-sdk-providers/cartesia)** for more information.

package/dist/index.d.ts

@@ -0,0 +1,185 @@
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { SpeechModelV4, ProviderV4, TranscriptionModelV4, Experimental_RealtimeFactoryV4, Experimental_RealtimeModelV4, Experimental_RealtimeModelV4ClientSecretOptions, Experimental_RealtimeModelV4ClientSecretResult, Experimental_RealtimeModelV4ServerEvent, Experimental_RealtimeModelV4ClientEvent, Experimental_RealtimeModelV4SessionConfig } from '@ai-sdk/provider';
+import { FetchFunction, WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+type CartesiaTranscriptionModelId = 'ink-whisper' | (string & {});
+
+type CartesiaConfig = {
+    provider: string;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    headers?: () => Record<string, string | undefined>;
+    fetch?: FetchFunction;
+    generateId?: () => string;
+};
+
+type CartesiaSpeechModelId = 'sonic-3.5' | 'sonic-3' | 'sonic-2' | 'sonic-turbo' | 'sonic-latest' | (string & {});
+type CartesiaSpeechVoiceId = string;
+
+interface CartesiaSpeechModelConfig extends CartesiaConfig {
+    _internal?: {
+        currentDate?: () => Date;
+    };
+}
+declare class CartesiaSpeechModel implements SpeechModelV4 {
+    readonly modelId: CartesiaSpeechModelId;
+    private readonly config;
+    readonly specificationVersion = "v4";
+    get provider(): string;
+    static [WORKFLOW_SERIALIZE](model: CartesiaSpeechModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: CartesiaSpeechModelId;
+        config: CartesiaSpeechModelConfig;
+    }): CartesiaSpeechModel;
+    constructor(modelId: CartesiaSpeechModelId, config: CartesiaSpeechModelConfig);
+    private getArgs;
+    doGenerate(options: Parameters<SpeechModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<SpeechModelV4['doGenerate']>>>;
+}
+
+interface CartesiaProvider extends ProviderV4 {
+    (modelId: CartesiaSpeechModelId, settings?: {}): {
+        speech: CartesiaSpeechModel;
+    };
+    /**
+     * Creates a model for transcription.
+     */
+    transcription(modelId: CartesiaTranscriptionModelId): TranscriptionModelV4;
+    /**
+     * Creates a model for speech generation.
+     */
+    speech(modelId: CartesiaSpeechModelId): SpeechModelV4;
+    /**
+     * Creates a realtime Ink speech-to-text model.
+     */
+    experimental_realtime: Experimental_RealtimeFactoryV4;
+    /**
+     * @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel(modelId: string): never;
+}
+interface CartesiaProviderSettings {
+    /**
+     * API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+     * The Cartesia API version to use (sent via the `Cartesia-Version` header).
+     */
+    version?: string;
+    /**
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch implementation. You can use it as a middleware to intercept requests,
+     * or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+}
+/**
+ * Create a Cartesia provider instance.
+ */
+declare function createCartesia(options?: CartesiaProviderSettings): CartesiaProvider;
+/**
+ * Default Cartesia provider instance.
+ */
+declare const cartesia: CartesiaProvider;
+
+interface CartesiaTranscriptionModelConfig extends CartesiaConfig {
+    _internal?: {
+        currentDate?: () => Date;
+    };
+}
+declare class CartesiaTranscriptionModel implements TranscriptionModelV4 {
+    readonly modelId: CartesiaTranscriptionModelId;
+    private readonly config;
+    readonly specificationVersion = "v4";
+    get provider(): string;
+    static [WORKFLOW_SERIALIZE](model: CartesiaTranscriptionModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: CartesiaTranscriptionModelId;
+        config: CartesiaTranscriptionModelConfig;
+    }): CartesiaTranscriptionModel;
+    constructor(modelId: CartesiaTranscriptionModelId, config: CartesiaTranscriptionModelConfig);
+    private getArgs;
+    doGenerate(options: Parameters<TranscriptionModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<TranscriptionModelV4['doGenerate']>>>;
+}
+
+type CartesiaRealtimeModelId = 'ink-2' | (string & {});
+type CartesiaRealtimeModelOptions = Record<string, never>;
+
+type CartesiaRealtimeModelConfig = {
+    provider: string;
+    baseURL: string;
+    version: string;
+    headers: () => Record<string, string | undefined>;
+    fetch?: FetchFunction;
+    _internal?: {
+        currentDate?: () => Date;
+    };
+};
+/**
+ * Realtime Ink model using Cartesia's STT WebSocket APIs.
+ */
+declare class CartesiaRealtimeModel implements Experimental_RealtimeModelV4 {
+    readonly specificationVersion: "v4";
+    readonly provider: string;
+    readonly modelId: CartesiaRealtimeModelId;
+    private readonly config;
+    private manualTranscript;
+    private sessionCreated;
+    private useTurnDetection;
+    constructor(modelId: CartesiaRealtimeModelId, config: CartesiaRealtimeModelConfig);
+    doCreateClientSecret(options: Experimental_RealtimeModelV4ClientSecretOptions): Promise<Experimental_RealtimeModelV4ClientSecretResult>;
+    getWebSocketConfig(options: {
+        token: string;
+        url: string;
+    }): {
+        url: string;
+    };
+    parseServerEvent(raw: unknown): Experimental_RealtimeModelV4ServerEvent | Experimental_RealtimeModelV4ServerEvent[];
+    serializeClientEvent(event: Experimental_RealtimeModelV4ClientEvent): unknown;
+    buildSessionConfig(_config: Experimental_RealtimeModelV4SessionConfig): null;
+    private finishManualTranscript;
+    private withSessionCreated;
+}
+
+declare const cartesiaSpeechModelOptionsSchema: z.ZodObject<{
+    container: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        raw: "raw";
+        wav: "wav";
+        mp3: "mp3";
+    }>>>;
+    encoding: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        pcm_f32le: "pcm_f32le";
+        pcm_s16le: "pcm_s16le";
+        pcm_mulaw: "pcm_mulaw";
+        pcm_alaw: "pcm_alaw";
+    }>>>;
+    sampleRate: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodLiteral<8000>, z.ZodLiteral<16000>, z.ZodLiteral<22050>, z.ZodLiteral<24000>, z.ZodLiteral<44100>, z.ZodLiteral<48000>]>>>;
+    bitRate: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodLiteral<32000>, z.ZodLiteral<64000>, z.ZodLiteral<96000>, z.ZodLiteral<128000>, z.ZodLiteral<192000>]>>>;
+    speed: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+type CartesiaSpeechModelOptions = z.infer<typeof cartesiaSpeechModelOptionsSchema>;
+
+declare const cartesiaTranscriptionModelOptionsSchema: z.ZodObject<{
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timestampGranularities: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
+        word: "word";
+    }>>>>;
+}, z.core.$strip>;
+type CartesiaTranscriptionModelOptions = z.infer<typeof cartesiaTranscriptionModelOptionsSchema>;
+
+declare const VERSION: string;
+
+export { type CartesiaProvider, type CartesiaProviderSettings, CartesiaRealtimeModel, type CartesiaRealtimeModelId, type CartesiaRealtimeModelOptions, CartesiaSpeechModel, type CartesiaSpeechModelId, type CartesiaSpeechModelOptions, type CartesiaSpeechVoiceId, CartesiaTranscriptionModel, type CartesiaTranscriptionModelId, type CartesiaTranscriptionModelOptions, VERSION, cartesia, createCartesia };