@tanstack/ai-groq 0.4.16 → 0.5.0

package/src/audio/tts-provider-options.ts

@@ -0,0 +1,48 @@
+/**
+ * Groq TTS voice options for English models
+ */
+export type GroqTTSEnglishVoice =
+  | 'autumn'
+  | 'diana'
+  | 'hannah'
+  | 'austin'
+  | 'daniel'
+  | 'troy'
+
+/**
+ * Groq TTS voice options for Arabic models
+ */
+export type GroqTTSArabicVoice = 'fahad' | 'sultan' | 'lulwa' | 'noura'
+
+/**
+ * Union of all Groq TTS voice options
+ */
+export type GroqTTSVoice = GroqTTSEnglishVoice | GroqTTSArabicVoice
+
+/**
+ * Groq TTS output format options.
+ */
+export type GroqTTSFormat = 'flac' | 'mp3' | 'mulaw' | 'ogg' | 'wav'
+
+/**
+ * Groq TTS sample rate options
+ */
+export type GroqTTSSampleRate =
+  | 8000
+  | 16000
+  | 22050
+  | 24000
+  | 32000
+  | 44100
+  | 48000
+
+/**
+ * Provider-specific options for Groq TTS.
+ * These options are passed via `modelOptions` when calling `generateSpeech`.
+ */
+export interface GroqTTSProviderOptions {
+  /**
+   * The sample rate of the generated audio in Hz.
+   */
+  sample_rate?: GroqTTSSampleRate
+}

package/src/index.ts

@@ -2,7 +2,7 @@
  * @module @tanstack/ai-groq
  *
  * Groq provider adapter for TanStack AI.
- * Provides tree-shakeable adapters for Groq's Chat Completions API.
+ * Provides tree-shakeable adapters for Groq's Chat Completions API and TTS API.
  */
 
 // Text (Chat) adapter
@@ -14,16 +14,48 @@ export {
   type GroqTextProviderOptions,
 } from './adapters/text'
 
+// Transcription adapter
+export {
+  GroqTranscriptionAdapter,
+  createGroqTranscription,
+  groqTranscription,
+  type GroqTranscriptionConfig,
+} from './adapters/transcription'
+export type { GroqTranscriptionProviderOptions } from './audio/transcription-provider-options'
+
+// TTS adapter - for text-to-speech
+export {
+  GroqTTSAdapter,
+  createGroqSpeech,
+  groqSpeech,
+  type GroqTTSConfig,
+} from './adapters/tts'
+export type {
+  GroqTTSProviderOptions,
+  GroqTTSVoice,
+  GroqTTSEnglishVoice,
+  GroqTTSArabicVoice,
+  GroqTTSFormat,
+  GroqTTSSampleRate,
+} from './audio/tts-provider-options'
+
 // Types
 export type {
   GroqChatModelProviderOptionsByName,
+  GroqTTSModelProviderOptionsByName,
   GroqChatModelToolCapabilitiesByName,
   GroqModelInputModalitiesByName,
   ResolveProviderOptions,
   ResolveInputModalities,
   GroqChatModels,
+  GroqTranscriptionModel,
+  GroqTTSModel,
+} from './model-meta'
+export {
+  GROQ_CHAT_MODELS,
+  GROQ_TRANSCRIPTION_MODELS,
+  GROQ_TTS_MODELS,
 } from './model-meta'
-export { GROQ_CHAT_MODELS } from './model-meta'
 export type {
   GroqTextMetadata,
   GroqImageMetadata,

package/src/model-meta.ts

@@ -1,4 +1,5 @@
 import type { GroqTextProviderOptions } from './text/text-provider-options'
+import type { GroqTTSProviderOptions } from './audio/tts-provider-options'
 
 /**
  * Internal metadata structure describing a Groq model's capabilities and pricing.
@@ -385,14 +386,23 @@ export type GroqChatModelToolCapabilitiesByName = {
   [QWEN3_32B.name]: typeof QWEN3_32B.supports.tools
 }
 
+/**
+ * Type-only map from Groq TTS model name to its provider options type.
+ */
+export type GroqTTSModelProviderOptionsByName = {
+  [K in GroqTTSModel]: GroqTTSProviderOptions
+}
+
 /**
  * Resolves the provider options type for a specific Groq model.
- * Falls back to generic GroqTextProviderOptions for unknown models.
+ * Checks TTS models first, then chat models, then falls back to generic options.
  */
 export type ResolveProviderOptions<TModel extends string> =
-  TModel extends keyof GroqChatModelProviderOptionsByName
-    ? GroqChatModelProviderOptionsByName[TModel]
-    : GroqTextProviderOptions
+  TModel extends GroqTTSModel
+    ? GroqTTSProviderOptions
+    : TModel extends keyof GroqChatModelProviderOptionsByName
+      ? GroqChatModelProviderOptionsByName[TModel]
+      : GroqTextProviderOptions
 
 /**
  * Resolve input modalities for a specific model.
@@ -402,3 +412,63 @@ export type ResolveInputModalities<TModel extends string> =
   TModel extends keyof GroqModelInputModalitiesByName
     ? GroqModelInputModalitiesByName[TModel]
     : readonly ['text']
+
+/**
+ * All supported Groq transcription model identifiers.
+ */
+export const GROQ_TRANSCRIPTION_MODELS = [
+  'whisper-large-v3-turbo',
+  'whisper-large-v3',
+] as const
+
+/**
+ * Union type of all supported Groq transcription model names.
+ */
+export type GroqTranscriptionModel = (typeof GROQ_TRANSCRIPTION_MODELS)[number]
+
+// ============================================================================
+// TTS Models
+// ============================================================================
+
+const ORPHEUS_V1_ENGLISH = {
+  name: 'canopylabs/orpheus-v1-english',
+  pricing: {
+    input: {
+      normal: 22,
+    },
+  },
+  supports: {
+    input: ['text'],
+    output: ['audio'],
+    endpoints: ['tts'],
+    features: [],
+  },
+} as const satisfies ModelMeta<GroqTTSProviderOptions>
+
+const ORPHEUS_ARABIC_SAUDI = {
+  name: 'canopylabs/orpheus-arabic-saudi',
+  pricing: {
+    input: {
+      normal: 40,
+    },
+  },
+  supports: {
+    input: ['text'],
+    output: ['audio'],
+    endpoints: ['tts'],
+    features: [],
+  },
+} as const satisfies ModelMeta<GroqTTSProviderOptions>
+
+/**
+ * All supported Groq TTS model identifiers.
+ */
+export const GROQ_TTS_MODELS = [
+  ORPHEUS_V1_ENGLISH.name,
+  ORPHEUS_ARABIC_SAUDI.name,
+] as const
+
+/**
+ * Union type of all supported Groq TTS model names.
+ */
+export type GroqTTSModel = (typeof GROQ_TTS_MODELS)[number]