@mastra/mcp-docs-server 1.1.7 → 1.1.8

package/.docs/reference/vectors/turbopuffer.md

@@ -4,49 +4,49 @@ The TurbopufferVector class provides vector search using [Turbopuffer](https://t
 
 ## Constructor Options
 
-**apiKey:** (`string`): The API key to authenticate with Turbopuffer
+**apiKey** (`string`): The API key to authenticate with Turbopuffer
 
-**baseUrl?:** (`string`): The base URL for the Turbopuffer API (Default: `https://api.turbopuffer.com`)
+**baseUrl** (`string`): The base URL for the Turbopuffer API (Default: `https://api.turbopuffer.com`)
 
-**connectTimeout?:** (`number`): The timeout to establish a connection, in ms. Only applicable in Node and Deno. (Default: `10000`)
+**connectTimeout** (`number`): The timeout to establish a connection, in ms. Only applicable in Node and Deno. (Default: `10000`)
 
-**connectionIdleTimeout?:** (`number`): The socket idle timeout, in ms. Only applicable in Node and Deno. (Default: `60000`)
+**connectionIdleTimeout** (`number`): The socket idle timeout, in ms. Only applicable in Node and Deno. (Default: `60000`)
 
-**warmConnections?:** (`number`): The number of connections to open initially when creating a new client. (Default: `0`)
+**warmConnections** (`number`): The number of connections to open initially when creating a new client. (Default: `0`)
 
-**compression?:** (`boolean`): Whether to compress requests and accept compressed responses. (Default: `true`)
+**compression** (`boolean`): Whether to compress requests and accept compressed responses. (Default: `true`)
 
-**schemaConfigForIndex?:** (`function`): A callback function that takes an index name and returns a config object for that index. This allows you to define explicit schemas per index.
+**schemaConfigForIndex** (`function`): A callback function that takes an index name and returns a config object for that index. This allows you to define explicit schemas per index.
 
 ## Methods
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
 ### upsert()
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Query vector to find similar vectors
+**queryVector** (`number[]`): Query vector to find similar vectors
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters for the query
+**filter** (`Record<string, any>`): Metadata filters for the query
 
-**includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 
 ### listIndexes()
 
@@ -54,7 +54,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -68,35 +68,35 @@ interface IndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
 ### deleteVector()
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector to delete
+**id** (`string`): ID of the vector to delete
 
 ### deleteVectors()
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ## Response Types
 

package/.docs/reference/vectors/upstash.md

@@ -4,9 +4,9 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
 
 ## Constructor Options
 
-**url:** (`string`): Upstash Vector database URL
+**url** (`string`): Upstash Vector database URL
 
-**token:** (`string`): Upstash Vector API token
+**token** (`string`): Upstash Vector API token
 
 ## Methods
 
@@ -14,41 +14,41 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
 
 Note: This method is a no-op for Upstash as indexes are created automatically.
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
 ### upsert()
 
-**indexName:** (`string`): Name of the index to upsert into
+**indexName** (`string`): Name of the index to upsert into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**sparseVectors?:** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.
+**sparseVectors** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Query vector to find similar vectors
+**queryVector** (`number[]`): Query vector to find similar vectors
 
-**sparseVector?:** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
+**sparseVector** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters for the query
+**filter** (`Record<string, any>`): Metadata filters for the query
 
-**includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 
-**fusionAlgorithm?:** (`FusionAlgorithm`): Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)
+**fusionAlgorithm** (`FusionAlgorithm`): Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)
 
-**queryMode?:** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
+**queryMode** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
 
 ### listIndexes()
 
@@ -56,7 +56,7 @@ Returns an array of index names (namespaces) as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -70,15 +70,15 @@ interface IndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index (namespace) to delete
+**indexName** (`string`): Name of the index (namespace) to delete
 
 ### updateVector()
 
-**indexName:** (`string`): Name of the index to update
+**indexName** (`string`): Name of the index to update
 
-**id:** (`string`): ID of the item to update
+**id** (`string`): ID of the item to update
 
-**update:** (`object`): Update object containing vector, sparse vector, and/or metadata
+**update** (`object`): Update object containing vector, sparse vector, and/or metadata
 
 The `update` object can have the following properties:
 
@@ -88,9 +88,9 @@ The `update` object can have the following properties:
 
 ### deleteVector()
 
-**indexName:** (`string`): Name of the index from which to delete the item
+**indexName** (`string`): Name of the index from which to delete the item
 
-**id:** (`string`): ID of the item to delete
+**id** (`string`): ID of the item to delete
 
 Attempts to delete an item by its ID from the specified index. Logs an error message if the deletion fails.
 

package/.docs/reference/vectors/vectorize.md

@@ -4,41 +4,41 @@ The CloudflareVector class provides vector search using [Cloudflare Vectorize](h
 
 ## Constructor Options
 
-**accountId:** (`string`): Cloudflare account ID
+**accountId** (`string`): Cloudflare account ID
 
-**apiToken:** (`string`): Cloudflare API token with Vectorize permissions
+**apiToken** (`string`): Cloudflare API token with Vectorize permissions
 
 ## Methods
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (dotproduct maps to dot-product) (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (dotproduct maps to dot-product) (Default: `cosine`)
 
 ### upsert()
 
-**indexName:** (`string`): Name of the index to upsert into
+**indexName** (`string`): Name of the index to upsert into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Query vector to find similar vectors
+**queryVector** (`number[]`): Query vector to find similar vectors
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters for the query
+**filter** (`Record<string, any>`): Metadata filters for the query
 
-**includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 
 ### listIndexes()
 
@@ -46,7 +46,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -60,49 +60,49 @@ interface IndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### createMetadataIndex()
 
 Creates an index on a metadata field to enable filtering.
 
-**indexName:** (`string`): Name of the index containing the metadata field
+**indexName** (`string`): Name of the index containing the metadata field
 
-**propertyName:** (`string`): Name of the metadata field to index
+**propertyName** (`string`): Name of the metadata field to index
 
-**indexType:** (`'string' | 'number' | 'boolean'`): Type of the metadata field
+**indexType** (`'string' | 'number' | 'boolean'`): Type of the metadata field
 
 ### deleteMetadataIndex()
 
 Removes an index from a metadata field.
 
-**indexName:** (`string`): Name of the index containing the metadata field
+**indexName** (`string`): Name of the index containing the metadata field
 
-**propertyName:** (`string`): Name of the metadata field to remove indexing from
+**propertyName** (`string`): Name of the metadata field to remove indexing from
 
 ### listMetadataIndexes()
 
 Lists all metadata field indexes for an index.
 
-**indexName:** (`string`): Name of the index to list metadata indexes for
+**indexName** (`string`): Name of the index to list metadata indexes for
 
 ### updateVector()
 
 Updates a vector or metadata for a specific ID within an index.
 
-**indexName:** (`string`): Name of the index containing the ID to update
+**indexName** (`string`): Name of the index containing the ID to update
 
-**id:** (`string`): Unique identifier of the vector or metadata to update
+**id** (`string`): Unique identifier of the vector or metadata to update
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
 ### deleteVector()
 
 Deletes a vector and its associated metadata for a specific ID within an index.
 
-**indexName:** (`string`): Name of the index containing the ID to delete
+**indexName** (`string`): Name of the index containing the ID to delete
 
-**id:** (`string`): Unique identifier of the vector and metadata to delete
+**id** (`string`): Unique identifier of the vector and metadata to delete
 
 ## Response Types
 

package/.docs/reference/voice/azure.md

@@ -37,23 +37,27 @@ const text = await voice.listen(audioStream)
 
 ### Constructor Options
 
-**speechModel?:** (`AzureSpeechConfig`): Configuration for text-to-speech synthesis.
+**speechModel** (`AzureSpeechConfig`): Configuration for text-to-speech synthesis.
 
-**listeningModel?:** (`AzureSpeechConfig`): Configuration for speech-to-text recognition.
+**speechModel.apiKey** (`string`): Azure Speech Services API key (NOT Azure OpenAI key). Falls back to AZURE\_API\_KEY environment variable.
 
-**speaker?:** (`string`): Default voice ID for speech synthesis.
+**speechModel.region** (`string`): Azure region (e.g., 'eastus', 'westeurope'). Falls back to AZURE\_REGION environment variable.
 
-### AzureSpeechConfig
+**speechModel.voiceName** (`string`): Voice ID for speech synthesis (e.g., 'en-US-AriaNeural', 'en-US-JennyNeural'). Only used in speechModel. See voice list below.
 
-Configuration object for speech synthesis (`speechModel`) and recognition (`listeningModel`).
+**speechModel.language** (`string`): Recognition language code (e.g., 'en-US', 'fr-FR'). Only used in listeningModel.
 
-**apiKey?:** (`string`): Azure Speech Services API key (NOT Azure OpenAI key). Falls back to AZURE\_API\_KEY environment variable.
+**listeningModel** (`AzureSpeechConfig`): Configuration for speech-to-text recognition.
 
-**region?:** (`string`): Azure region (e.g., 'eastus', 'westeurope'). Falls back to AZURE\_REGION environment variable.
+**listeningModel.apiKey** (`string`): Azure Speech Services API key (NOT Azure OpenAI key). Falls back to AZURE\_API\_KEY environment variable.
 
-**voiceName?:** (`string`): Voice ID for speech synthesis (e.g., 'en-US-AriaNeural', 'en-US-JennyNeural'). Only used in speechModel. See voice list below.
+**listeningModel.region** (`string`): Azure region (e.g., 'eastus', 'westeurope'). Falls back to AZURE\_REGION environment variable.
 
-**language?:** (`string`): Recognition language code (e.g., 'en-US', 'fr-FR'). Only used in listeningModel.
+**listeningModel.voiceName** (`string`): Voice ID for speech synthesis (e.g., 'en-US-AriaNeural', 'en-US-JennyNeural'). Only used in speechModel. See voice list below.
+
+**listeningModel.language** (`string`): Recognition language code (e.g., 'en-US', 'fr-FR'). Only used in listeningModel.
+
+**speaker** (`string`): Default voice ID for speech synthesis.
 
 ## Methods
 
@@ -61,9 +65,9 @@ Configuration object for speech synthesis (`speechModel`) and recognition (`list
 
 Converts text to speech using Azure's neural text-to-speech service.
 
-**input:** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
+**input** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
 
-**options.speaker?:** (`string`): Voice ID to use for speech synthesis (e.g., 'en-US-JennyNeural'). Overrides the default voice. (Default: `Constructor's speaker value`)
+**options.speaker** (`string`): Voice ID to use for speech synthesis (e.g., 'en-US-JennyNeural'). Overrides the default voice. (Default: `Constructor's speaker value`)
 
 Returns: `Promise<NodeJS.ReadableStream>` - Audio stream in WAV format
 
@@ -71,7 +75,7 @@ Returns: `Promise<NodeJS.ReadableStream>` - Audio stream in WAV format
 
 Transcribes audio using Azure's speech-to-text service.
 
-**audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe. Must be in WAV format.
+**audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe. Must be in WAV format.
 
 Returns: `Promise<string>` - The recognized text from the audio
 
@@ -81,11 +85,11 @@ Returns: `Promise<string>` - The recognized text from the audio
 
 Returns an array of available voice options (200+ voices), where each node contains:
 
-**voiceId:** (`string`): Unique identifier for the voice (e.g., 'en-US-JennyNeural', 'fr-FR-DeniseNeural')
+**voiceId** (`string`): Unique identifier for the voice (e.g., 'en-US-JennyNeural', 'fr-FR-DeniseNeural')
 
-**language:** (`string`): Language code extracted from voice ID (e.g., 'en', 'fr')
+**language** (`string`): Language code extracted from voice ID (e.g., 'en', 'fr')
 
-**region:** (`string`): Region code extracted from voice ID (e.g., 'US', 'GB', 'FR')
+**region** (`string`): Region code extracted from voice ID (e.g., 'US', 'GB', 'FR')
 
 Returns: `Promise<Array<{ voiceId: string; language: string; region: string; }>>`
 

package/.docs/reference/voice/cloudflare.md

@@ -31,17 +31,15 @@ console.log(speakers)
 
 ### Constructor Options
 
-**speechModel?:** (`CloudflareSpeechConfig`): Configuration for text-to-speech synthesis.
+**speechModel** (`CloudflareSpeechConfig`): Configuration for text-to-speech synthesis.
 
-**speaker?:** (`string`): Default voice ID for speech synthesis. (Default: `'en-US-1'`)
+**speechModel.name** (`string`): Model name to use for TTS.
 
-### CloudflareSpeechConfig
+**speechModel.apiKey** (`string`): Cloudflare API token with Workers AI access. Falls back to CLOUDFLARE\_API\_TOKEN environment variable.
 
-**name?:** (`string`): Model name to use for TTS. (Default: `'@cf/meta/m2m100-1.2b'`)
+**speechModel.accountId** (`string`): Cloudflare account ID. Falls back to CLOUDFLARE\_ACCOUNT\_ID environment variable.
 
-**apiKey?:** (`string`): Cloudflare API token with Workers AI access. Falls back to CLOUDFLARE\_API\_TOKEN environment variable.
-
-**accountId?:** (`string`): Cloudflare account ID. Falls back to CLOUDFLARE\_ACCOUNT\_ID environment variable.
+**speaker** (`string`): Default voice ID for speech synthesis. (Default: `'en-US-1'`)
 
 ## Methods
 
@@ -49,11 +47,11 @@ console.log(speakers)
 
 Converts text to speech using Cloudflare's text-to-speech service.
 
-**input:** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
+**input** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
 
-**options.speaker?:** (`string`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
+**options.speaker** (`string`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
 
-**options.format?:** (`string`): Output audio format. (Default: `'mp3'`)
+**options.format** (`string`): Output audio format. (Default: `'mp3'`)
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -61,9 +59,9 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Returns an array of available voice options, where each node contains:
 
-**voiceId:** (`string`): Unique identifier for the voice (e.g., 'en-US-1')
+**voiceId** (`string`): Unique identifier for the voice (e.g., 'en-US-1')
 
-**language:** (`string`): Language code of the voice (e.g., 'en-US')
+**language** (`string`): Language code of the voice (e.g., 'en-US')
 
 ## Notes
 

package/.docs/reference/voice/composite-voice.md

@@ -6,13 +6,13 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
 
 ## Constructor Parameters
 
-**config:** (`object`): Configuration object for the composite voice service
+**config** (`object`): Configuration object for the composite voice service
 
-**config.input?:** (`MastraVoice | TranscriptionModel`): Voice provider or AI SDK transcription model to use for speech-to-text operations. AI SDK models are automatically wrapped.
+**config.input** (`MastraVoice | TranscriptionModel`): Voice provider or AI SDK transcription model to use for speech-to-text operations. AI SDK models are automatically wrapped.
 
-**config.output?:** (`MastraVoice | SpeechModel`): Voice provider or AI SDK speech model to use for text-to-speech operations. AI SDK models are automatically wrapped.
+**config.output** (`MastraVoice | SpeechModel`): Voice provider or AI SDK speech model to use for text-to-speech operations. AI SDK models are automatically wrapped.
 
-**config.realtime?:** (`MastraVoice`): Voice provider to use for real-time speech-to-speech operations
+**config.realtime** (`MastraVoice`): Voice provider to use for real-time speech-to-speech operations
 
 ## Methods
 
@@ -20,9 +20,9 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
 
 Converts text to speech using the configured speaking provider.
 
-**input:** (`string | NodeJS.ReadableStream`): Text to convert to speech
+**input** (`string | NodeJS.ReadableStream`): Text to convert to speech
 
-**options?:** (`object`): Provider-specific options passed to the speaking provider
+**options** (`object`): Provider-specific options passed to the speaking provider
 
 Notes:
 
@@ -34,9 +34,9 @@ Notes:
 
 Converts speech to text using the configured listening provider.
 
-**audioStream:** (`NodeJS.ReadableStream`): Audio stream to convert to text
+**audioStream** (`NodeJS.ReadableStream`): Audio stream to convert to text
 
-**options?:** (`object`): Provider-specific options passed to the listening provider
+**options** (`object`): Provider-specific options passed to the listening provider
 
 Notes:
 
@@ -48,9 +48,9 @@ Notes:
 
 Returns a list of available voices from the speaking provider, where each node contains:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**key?:** (`value`): Additional voice properties that vary by provider (e.g., name, language)
+**key** (`value`): Additional voice properties that vary by provider (e.g., name, language)
 
 Notes:
 

package/.docs/reference/voice/deepgram.md

@@ -32,21 +32,27 @@ const transcript = await voice.listen(audioStream)
 
 ## Constructor Parameters
 
-**speechModel?:** (`DeepgramVoiceConfig`): Configuration for text-to-speech functionality. (Default: `{ name: 'aura' }`)
+**speechModel** (`DeepgramVoiceConfig`): Configuration for text-to-speech functionality. (Default: `{ name: 'aura' }`)
 
-**listeningModel?:** (`DeepgramVoiceConfig`): Configuration for speech-to-text functionality. (Default: `{ name: 'nova' }`)
+**speechModel.name** (`DeepgramModel`): The Deepgram model to use
 
-**speaker?:** (`DeepgramVoiceId`): Default voice to use for text-to-speech (Default: `'asteria-en'`)
+**speechModel.apiKey** (`string`): Deepgram API key. Falls back to DEEPGRAM\_API\_KEY environment variable
 
-### DeepgramVoiceConfig
+**speechModel.properties** (`Record<string, any>`): Additional properties to pass to the Deepgram API
 
-**name?:** (`DeepgramModel`): The Deepgram model to use
+**speechModel.language** (`string`): Language code for the model
 
-**apiKey?:** (`string`): Deepgram API key. Falls back to DEEPGRAM\_API\_KEY environment variable
+**listeningModel** (`DeepgramVoiceConfig`): Configuration for speech-to-text functionality. (Default: `{ name: 'nova' }`)
 
-**properties?:** (`Record<string, any>`): Additional properties to pass to the Deepgram API
+**listeningModel.name** (`DeepgramModel`): The Deepgram model to use
 
-**language?:** (`string`): Language code for the model
+**listeningModel.apiKey** (`string`): Deepgram API key. Falls back to DEEPGRAM\_API\_KEY environment variable
+
+**listeningModel.properties** (`Record<string, any>`): Additional properties to pass to the Deepgram API
+
+**listeningModel.language** (`string`): Language code for the model
+
+**speaker** (`DeepgramVoiceId`): Default voice to use for text-to-speech (Default: `'asteria-en'`)
 
 ## Methods
 
@@ -54,11 +60,11 @@ const transcript = await voice.listen(audioStream)
 
 Converts text to speech using the configured speech model and voice.
 
-**input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
+**input** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
 
-**options?:** (`object`): Additional options for speech synthesis
+**options** (`object`): Additional options for speech synthesis
 
-**options.speaker?:** (`string`): Override the default speaker for this request
+**options.speaker** (`string`): Override the default speaker for this request
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -66,9 +72,9 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Converts speech to text using the configured listening model.
 
-**audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe
+**audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe
 
-**options?:** (`object`): Additional options to pass to the Deepgram API
+**options** (`object`): Additional options to pass to the Deepgram API
 
 Returns: `Promise<string>`
 
@@ -76,4 +82,4 @@ Returns: `Promise<string>`
 
 Returns a list of available voice options.
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice