@mastra/mcp-docs-server 1.0.0-beta.2 → 1.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +9 -9
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +26 -26
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +163 -163
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +12 -12
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +26 -26
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +14 -14
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Flance.md +14 -14
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +12 -12
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +34 -34
- package/.docs/organized/changelogs/%40mastra%2Frag.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Freact.md +8 -8
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +14 -14
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +12 -12
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
- package/.docs/organized/changelogs/create-mastra.md +15 -15
- package/.docs/organized/changelogs/mastra.md +37 -37
- package/.docs/organized/code-examples/ai-elements.md +1 -1
- package/.docs/organized/code-examples/ai-sdk-useChat.md +1 -1
- package/.docs/organized/code-examples/ai-sdk-v5.md +1 -1
- package/.docs/organized/code-examples/assistant-ui.md +1 -1
- package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +1 -1
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +1 -1
- package/.docs/organized/code-examples/client-side-tools.md +1 -1
- package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
- package/.docs/organized/code-examples/fireworks-r1.md +1 -1
- package/.docs/organized/code-examples/heads-up-game.md +1 -1
- package/.docs/organized/code-examples/mcp-configuration.md +0 -3
- package/.docs/organized/code-examples/memory-per-resource-example.md +1 -1
- package/.docs/organized/code-examples/openapi-spec-writer.md +1 -1
- package/.docs/organized/code-examples/quick-start.md +1 -1
- package/.docs/organized/code-examples/stock-price-tool.md +1 -21
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +1 -1
- package/.docs/raw/agents/agent-memory.mdx +1 -1
- package/.docs/raw/agents/guardrails.mdx +1 -1
- package/.docs/raw/agents/human-in-the-loop-with-tools.mdx +90 -0
- package/.docs/raw/agents/networks.mdx +1 -1
- package/.docs/raw/agents/overview.mdx +8 -13
- package/.docs/raw/agents/using-tools.mdx +10 -9
- package/.docs/raw/auth/auth0.mdx +1 -1
- package/.docs/raw/auth/clerk.mdx +1 -1
- package/.docs/raw/auth/firebase.mdx +1 -1
- package/.docs/raw/auth/index.mdx +1 -1
- package/.docs/raw/auth/jwt.mdx +1 -1
- package/.docs/raw/auth/supabase.mdx +1 -1
- package/.docs/raw/auth/workos.mdx +1 -1
- package/.docs/raw/community/contributing-templates.mdx +1 -1
- package/.docs/raw/community/discord.mdx +2 -2
- package/.docs/raw/community/licensing.mdx +1 -1
- package/.docs/raw/deployment/{server-deployment.mdx → building-mastra.mdx} +4 -4
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +2 -2
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +3 -3
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +2 -2
- package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/cloudflare-deployer.mdx +1 -1
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +2 -2
- package/.docs/raw/deployment/cloud-providers/index.mdx +8 -4
- package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/netlify-deployer.mdx +1 -1
- package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/vercel-deployer.mdx +1 -1
- package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/dashboard.mdx +3 -3
- package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/observability.mdx +2 -2
- package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/overview.mdx +3 -3
- package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/setting-up.mdx +4 -4
- package/.docs/raw/deployment/monorepo.mdx +3 -3
- package/.docs/raw/deployment/overview.mdx +5 -5
- package/.docs/raw/deployment/web-framework.mdx +1 -1
- package/.docs/raw/evals/{off-the-shelf-scorers.mdx → built-in-scorers.mdx} +17 -15
- package/.docs/raw/evals/custom-scorers.mdx +1 -1
- package/.docs/raw/evals/overview.mdx +3 -3
- package/.docs/raw/evals/running-in-ci.mdx +2 -2
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +11 -128
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +71 -19
- package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +8 -29
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +91 -267
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -3
- package/.docs/raw/frameworks/servers/express.mdx +1 -1
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +1 -1
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +1 -1
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +1 -1
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +1 -1
- package/.docs/raw/getting-started/mcp-docs-server.mdx +6 -6
- package/.docs/raw/getting-started/project-structure.mdx +1 -1
- package/.docs/raw/getting-started/quickstart.mdx +27 -0
- package/.docs/raw/getting-started/studio.mdx +3 -3
- package/.docs/raw/getting-started/templates.mdx +1 -1
- package/.docs/raw/guides/guide/ai-recruiter.mdx +1 -1
- package/.docs/raw/guides/guide/chef-michel.mdx +1 -1
- package/.docs/raw/{getting-started/installation.mdx → guides/guide/manual-install.mdx} +6 -80
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +2 -2
- package/.docs/raw/guides/guide/research-assistant.mdx +2 -2
- package/.docs/raw/guides/guide/stock-agent.mdx +1 -1
- package/.docs/raw/guides/guide/web-search.mdx +1 -1
- package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +119 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +1 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +9 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +60 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +12 -0
- package/.docs/raw/guides/quickstarts/nextjs.mdx +18 -17
- package/.docs/raw/guides/quickstarts/standalone-server.mdx +86 -0
- package/.docs/raw/index.mdx +3 -3
- package/.docs/raw/logging.mdx +7 -7
- package/.docs/raw/mcp/overview.mdx +360 -0
- package/.docs/raw/mcp/publishing-mcp-server.mdx +139 -0
- package/.docs/raw/memory/conversation-history.mdx +1 -1
- package/.docs/raw/memory/memory-processors.mdx +1 -1
- package/.docs/raw/memory/overview.mdx +1 -1
- package/.docs/raw/memory/semantic-recall.mdx +1 -1
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +1 -4
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +1 -1
- package/.docs/raw/memory/storage/memory-with-pg.mdx +1 -4
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +1 -4
- package/.docs/raw/memory/threads-and-resources.mdx +1 -1
- package/.docs/raw/memory/working-memory.mdx +1 -1
- package/.docs/raw/observability/overview.mdx +2 -2
- package/.docs/raw/observability/tracing/exporters/arize.mdx +1 -1
- package/.docs/raw/observability/tracing/exporters/braintrust.mdx +1 -1
- package/.docs/raw/observability/tracing/exporters/cloud.mdx +2 -2
- package/.docs/raw/observability/tracing/exporters/default.mdx +1 -1
- package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -1
- package/.docs/raw/observability/tracing/exporters/langsmith.mdx +1 -1
- package/.docs/raw/observability/tracing/exporters/otel.mdx +1 -1
- package/.docs/raw/observability/tracing/overview.mdx +2 -2
- package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +2 -2
- package/.docs/raw/rag/overview.mdx +1 -1
- package/.docs/raw/rag/retrieval.mdx +1 -1
- package/.docs/raw/rag/vector-databases.mdx +1 -1
- package/.docs/raw/reference/agents/agent.mdx +1 -2
- package/.docs/raw/reference/agents/generate.mdx +1 -1
- package/.docs/raw/reference/agents/generateLegacy.mdx +1 -1
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +1 -1
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +1 -1
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +1 -1
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +1 -1
- package/.docs/raw/reference/agents/getLLM.mdx +1 -1
- package/.docs/raw/reference/agents/getMemory.mdx +1 -1
- package/.docs/raw/reference/agents/getModel.mdx +1 -1
- package/.docs/raw/reference/agents/getTools.mdx +69 -0
- package/.docs/raw/reference/agents/getVoice.mdx +1 -1
- package/.docs/raw/reference/agents/listAgents.mdx +1 -1
- package/.docs/raw/reference/agents/listScorers.mdx +1 -1
- package/.docs/raw/reference/agents/listTools.mdx +2 -2
- package/.docs/raw/reference/agents/listWorkflows.mdx +1 -1
- package/.docs/raw/reference/agents/network.mdx +1 -1
- package/.docs/raw/reference/auth/auth0.mdx +1 -1
- package/.docs/raw/reference/auth/clerk.mdx +1 -1
- package/.docs/raw/reference/auth/firebase.mdx +1 -1
- package/.docs/raw/reference/auth/jwt.mdx +1 -1
- package/.docs/raw/reference/auth/supabase.mdx +1 -1
- package/.docs/raw/reference/auth/workos.mdx +1 -1
- package/.docs/raw/reference/cli/create-mastra.mdx +1 -1
- package/.docs/raw/reference/cli/mastra.mdx +4 -4
- package/.docs/raw/reference/client-js/agents.mdx +1 -1
- package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
- package/.docs/raw/reference/client-js/logs.mdx +1 -1
- package/.docs/raw/reference/client-js/mastra-client.mdx +2 -2
- package/.docs/raw/reference/client-js/memory.mdx +1 -1
- package/.docs/raw/reference/client-js/observability.mdx +1 -1
- package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
- package/.docs/raw/reference/client-js/tools.mdx +1 -1
- package/.docs/raw/reference/client-js/vectors.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows.mdx +1 -1
- package/.docs/raw/reference/core/addGateway.mdx +59 -0
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +1 -1
- package/.docs/raw/reference/core/getGateway.mdx +59 -0
- package/.docs/raw/reference/core/getGatewayById.mdx +62 -0
- package/.docs/raw/reference/core/getLogger.mdx +1 -1
- package/.docs/raw/reference/core/getMCPServer.mdx +2 -2
- package/.docs/raw/reference/core/getMCPServerById.mdx +2 -2
- package/.docs/raw/reference/core/getScorer.mdx +1 -1
- package/.docs/raw/reference/core/getScorerById.mdx +1 -1
- package/.docs/raw/reference/core/getServer.mdx +2 -2
- package/.docs/raw/reference/core/getStorage.mdx +1 -1
- package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
- package/.docs/raw/reference/core/getVector.mdx +1 -1
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listGateways.mdx +53 -0
- package/.docs/raw/reference/core/listLogs.mdx +1 -1
- package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
- package/.docs/raw/reference/core/listMCPServers.mdx +2 -2
- package/.docs/raw/reference/core/listScorers.mdx +1 -1
- package/.docs/raw/reference/core/listVectors.mdx +1 -1
- package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
- package/.docs/raw/reference/core/mastra-class.mdx +9 -1
- package/.docs/raw/reference/core/mastra-model-gateway.mdx +241 -0
- package/.docs/raw/reference/core/setLogger.mdx +1 -1
- package/.docs/raw/reference/core/setStorage.mdx +1 -1
- package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
- package/.docs/raw/reference/deployer/cloudflare.mdx +1 -1
- package/.docs/raw/reference/deployer/deployer.mdx +1 -1
- package/.docs/raw/reference/deployer/netlify.mdx +1 -1
- package/.docs/raw/reference/deployer/vercel.mdx +1 -1
- package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
- package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
- package/.docs/raw/reference/evals/bias.mdx +1 -1
- package/.docs/raw/reference/evals/completeness.mdx +1 -1
- package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
- package/.docs/raw/reference/evals/context-precision.mdx +1 -1
- package/.docs/raw/reference/evals/context-relevance.mdx +1 -1
- package/.docs/raw/reference/evals/create-scorer.mdx +1 -1
- package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
- package/.docs/raw/reference/evals/hallucination.mdx +1 -1
- package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
- package/.docs/raw/reference/evals/mastra-scorer.mdx +1 -1
- package/.docs/raw/reference/evals/noise-sensitivity.mdx +1 -1
- package/.docs/raw/reference/evals/prompt-alignment.mdx +1 -1
- package/.docs/raw/reference/evals/run-evals.mdx +1 -1
- package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
- package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
- package/.docs/raw/reference/evals/tool-call-accuracy.mdx +1 -1
- package/.docs/raw/reference/evals/toxicity.mdx +1 -1
- package/.docs/raw/reference/logging/pino-logger.mdx +2 -2
- package/.docs/raw/reference/memory/createThread.mdx +1 -1
- package/.docs/raw/reference/memory/deleteMessages.mdx +1 -1
- package/.docs/raw/reference/memory/getThreadById.mdx +1 -1
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +1 -1
- package/.docs/raw/reference/memory/memory-class.mdx +1 -1
- package/.docs/raw/reference/memory/query.mdx +1 -1
- package/.docs/raw/reference/memory/recall.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/configuration.mdx +2 -2
- package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/instances.mdx +2 -2
- package/.docs/raw/reference/observability/tracing/interfaces.mdx +2 -2
- package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +1 -1
- package/.docs/raw/reference/observability/tracing/spans.mdx +2 -2
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
- package/.docs/raw/reference/processors/language-detector.mdx +1 -1
- package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
- package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
- package/.docs/raw/reference/rag/chunk.mdx +1 -1
- package/.docs/raw/reference/rag/database-config.mdx +1 -1
- package/.docs/raw/reference/rag/document.mdx +1 -1
- package/.docs/raw/reference/rag/embeddings.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +1 -1
- package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
- package/.docs/raw/reference/rag/metadata-filters.mdx +1 -1
- package/.docs/raw/reference/rag/rerank.mdx +1 -1
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
- package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +1 -1
- package/.docs/raw/reference/storage/mongodb.mdx +1 -1
- package/.docs/raw/reference/storage/mssql.mdx +1 -1
- package/.docs/raw/reference/storage/postgresql.mdx +1 -1
- package/.docs/raw/reference/storage/upstash.mdx +1 -1
- package/.docs/raw/reference/streaming/ChunkType.mdx +1 -1
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +1 -1
- package/.docs/raw/reference/streaming/agents/stream.mdx +1 -1
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/stream.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +1 -1
- package/.docs/raw/reference/templates/overview.mdx +1 -1
- package/.docs/raw/reference/tools/client.mdx +1 -1
- package/.docs/raw/reference/tools/create-tool.mdx +3 -4
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +1 -1
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +2 -2
- package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +6 -6
- package/.docs/raw/reference/tools/vector-query-tool.mdx +2 -2
- package/.docs/raw/reference/vectors/astra.mdx +1 -1
- package/.docs/raw/reference/vectors/chroma.mdx +1 -1
- package/.docs/raw/reference/vectors/couchbase.mdx +1 -1
- package/.docs/raw/reference/vectors/lance.mdx +1 -1
- package/.docs/raw/reference/vectors/libsql.mdx +1 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
- package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
- package/.docs/raw/reference/vectors/pg.mdx +1 -1
- package/.docs/raw/reference/vectors/pinecone.mdx +22 -2
- package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
- package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
- package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +1 -1
- package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
- package/.docs/raw/reference/voice/azure.mdx +96 -81
- package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
- package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
- package/.docs/raw/reference/voice/deepgram.mdx +1 -1
- package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
- package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
- package/.docs/raw/reference/voice/google.mdx +1 -1
- package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
- package/.docs/raw/reference/voice/murf.mdx +1 -1
- package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
- package/.docs/raw/reference/voice/openai.mdx +1 -1
- package/.docs/raw/reference/voice/playai.mdx +1 -1
- package/.docs/raw/reference/voice/sarvam.mdx +1 -1
- package/.docs/raw/reference/voice/speechify.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
- package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
- package/.docs/raw/reference/voice/voice.close.mdx +1 -1
- package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
- package/.docs/raw/reference/voice/voice.events.mdx +1 -1
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +1 -1
- package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
- package/.docs/raw/reference/voice/voice.off.mdx +1 -1
- package/.docs/raw/reference/voice/voice.on.mdx +1 -1
- package/.docs/raw/reference/voice/voice.send.mdx +1 -1
- package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/start.mdx +1 -1
- package/.docs/raw/reference/workflows/run.mdx +1 -1
- package/.docs/raw/reference/workflows/step.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow.mdx +2 -2
- package/.docs/raw/server-db/custom-api-routes.mdx +1 -1
- package/.docs/raw/server-db/mastra-client.mdx +2 -2
- package/.docs/raw/server-db/{production-server.mdx → mastra-server.mdx} +2 -2
- package/.docs/raw/server-db/middleware.mdx +31 -31
- package/.docs/raw/server-db/request-context.mdx +3 -3
- package/.docs/raw/server-db/storage.mdx +1 -1
- package/.docs/raw/streaming/events.mdx +1 -1
- package/.docs/raw/streaming/overview.mdx +1 -1
- package/.docs/raw/streaming/tool-streaming.mdx +1 -1
- package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
- package/.docs/raw/tools-mcp/advanced-usage.mdx +1 -1
- package/.docs/raw/tools-mcp/mcp-overview.mdx +1 -1
- package/.docs/raw/tools-mcp/overview.mdx +1 -1
- package/.docs/raw/voice/overview.mdx +1 -1
- package/.docs/raw/voice/speech-to-speech.mdx +1 -1
- package/.docs/raw/voice/speech-to-text.mdx +1 -1
- package/.docs/raw/voice/text-to-speech.mdx +1 -1
- package/.docs/raw/workflows/agents-and-tools.mdx +2 -4
- package/.docs/raw/workflows/control-flow.mdx +6 -1
- package/.docs/raw/workflows/error-handling.mdx +4 -4
- package/.docs/raw/workflows/human-in-the-loop.mdx +160 -213
- package/.docs/raw/workflows/inngest-workflow.mdx +1 -1
- package/.docs/raw/workflows/input-data-mapping.mdx +1 -1
- package/.docs/raw/workflows/overview.mdx +10 -2
- package/.docs/raw/workflows/snapshots.mdx +4 -3
- package/.docs/raw/workflows/suspend-and-resume.mdx +72 -224
- package/CHANGELOG.md +16 -0
- package/dist/stdio.js +11 -9
- package/package.json +10 -14
- package/.docs/raw/deployment/serverless-platforms/index.mdx +0 -58
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: createTool() | Tools & MCP
|
|
2
|
+
title: "Reference: createTool() | Tools & MCP"
|
|
3
3
|
description: Documentation for the `createTool()` function in Mastra, used to define custom tools for agents.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -151,7 +151,6 @@ The `createTool()` function returns a `Tool` object.
|
|
|
151
151
|
|
|
152
152
|
## Related
|
|
153
153
|
|
|
154
|
-
- [
|
|
154
|
+
- [MCP Overview](/docs/v1/mcp/overview)
|
|
155
155
|
- [Using Tools with Agents](/docs/v1/agents/using-tools)
|
|
156
|
-
- [
|
|
157
|
-
- [Advanced Tool Usage](/docs/v1/tools-mcp/advanced-usage)
|
|
156
|
+
- [Request Context](/docs/v1/server-db/request-context#accessing-values-with-tools)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: createDocumentChunkerTool() | Tools & MCP
|
|
2
|
+
title: "Reference: createDocumentChunkerTool() | Tools & MCP"
|
|
3
3
|
description: Documentation for the Document Chunker Tool in Mastra, which splits documents into smaller chunks for efficient processing and retrieval.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: createGraphRAGTool() | Tools & MCP
|
|
2
|
+
title: "Reference: createGraphRAGTool() | Tools & MCP"
|
|
3
3
|
description: Documentation for the Graph RAG Tool in Mastra, which enhances RAG by building a graph of semantic relationships between documents.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -254,7 +254,7 @@ const response = await agent.generate(
|
|
|
254
254
|
For more information on request context, please see:
|
|
255
255
|
|
|
256
256
|
- [Agent Request Context](/docs/v1/server-db/request-context)
|
|
257
|
-
- [
|
|
257
|
+
- [Request Context](/docs/v1/server-db/request-context#accessing-values-with-tools)
|
|
258
258
|
|
|
259
259
|
## Related
|
|
260
260
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: MCPServer | Tools & MCP
|
|
2
|
+
title: "Reference: MCPServer | Tools & MCP"
|
|
3
3
|
description: API Reference for MCPServer - A class for exposing Mastra tools and capabilities as a Model Context Protocol server.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -469,11 +469,11 @@ const server = new MCPServer({
|
|
|
469
469
|
|
|
470
470
|
serve(async (req) => {
|
|
471
471
|
const url = new URL(req.url);
|
|
472
|
-
|
|
472
|
+
|
|
473
473
|
if (url.pathname === "/mcp") {
|
|
474
474
|
// Convert Deno Request to Node.js-compatible format
|
|
475
475
|
const { req: nodeReq, res: nodeRes } = toReqRes(req);
|
|
476
|
-
|
|
476
|
+
|
|
477
477
|
await server.startHTTP({
|
|
478
478
|
url,
|
|
479
479
|
httpPath: "/mcp",
|
|
@@ -483,10 +483,10 @@ serve(async (req) => {
|
|
|
483
483
|
serverless: true, // ← Enable stateless mode for serverless
|
|
484
484
|
},
|
|
485
485
|
});
|
|
486
|
-
|
|
486
|
+
|
|
487
487
|
return toFetchResponse(nodeRes);
|
|
488
488
|
}
|
|
489
|
-
|
|
489
|
+
|
|
490
490
|
return new Response("Not found", { status: 404 });
|
|
491
491
|
});
|
|
492
492
|
```
|
|
@@ -967,7 +967,7 @@ await serverWithPrompts.prompts.notifyListChanged();
|
|
|
967
967
|
|
|
968
968
|
## Examples
|
|
969
969
|
|
|
970
|
-
For practical examples of setting up and deploying an MCPServer, see the [
|
|
970
|
+
For practical examples of setting up and deploying an MCPServer, see the [Publishing an MCP Server guide](/docs/v1/mcp/publishing-mcp-server).
|
|
971
971
|
|
|
972
972
|
The example at the beginning of this page also demonstrates how to instantiate `MCPServer` with both tools and agents.
|
|
973
973
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: createVectorQueryTool() | Tools & MCP
|
|
2
|
+
title: "Reference: createVectorQueryTool() | Tools & MCP"
|
|
3
3
|
description: Documentation for the Vector Query Tool in Mastra, which facilitates semantic search over vector stores with filtering and reranking capabilities.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -568,7 +568,7 @@ const response = await agent.generate(
|
|
|
568
568
|
For more information on request context, please see:
|
|
569
569
|
|
|
570
570
|
- [Agent Request Context](/docs/v1/server-db/request-context)
|
|
571
|
-
- [
|
|
571
|
+
- [Request Context](/docs/v1/server-db/request-context#accessing-values-with-tools)
|
|
572
572
|
|
|
573
573
|
## Usage Without a Mastra Server
|
|
574
574
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Lance Vector Store | Vectors
|
|
2
|
+
title: "Reference: Lance Vector Store | Vectors"
|
|
3
3
|
description: "Documentation for the LanceVectorStore class in Mastra, which provides vector search using LanceDB, an embedded vector database based on the Lance columnar format."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: MongoDB Vector Store | Vectors
|
|
2
|
+
title: "Reference: MongoDB Vector Store | Vectors"
|
|
3
3
|
description: Documentation for the MongoDBVector class in Mastra, which provides vector search using MongoDB Atlas and Atlas Vector Search.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Pinecone Vector Store | Vectors
|
|
2
|
+
title: "Reference: Pinecone Vector Store | Vectors"
|
|
3
3
|
description: Documentation for the PineconeVector class in Mastra, which provides an interface to Pinecone's vector database.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -12,6 +12,11 @@ It provides real-time vector search, with features like hybrid search, metadata
|
|
|
12
12
|
|
|
13
13
|
<PropertiesTable
|
|
14
14
|
content={[
|
|
15
|
+
{
|
|
16
|
+
name: "id",
|
|
17
|
+
type: "string",
|
|
18
|
+
description: "Unique identifier for this vector store instance",
|
|
19
|
+
},
|
|
15
20
|
{
|
|
16
21
|
name: "apiKey",
|
|
17
22
|
type: "string",
|
|
@@ -20,7 +25,22 @@ It provides real-time vector search, with features like hybrid search, metadata
|
|
|
20
25
|
{
|
|
21
26
|
name: "environment",
|
|
22
27
|
type: "string",
|
|
23
|
-
|
|
28
|
+
isOptional: true,
|
|
29
|
+
description: "Pinecone environment controller host URL",
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
name: "cloud",
|
|
33
|
+
type: "'aws' | 'gcp' | 'azure'",
|
|
34
|
+
isOptional: true,
|
|
35
|
+
defaultValue: "aws",
|
|
36
|
+
description: "Cloud provider for Pinecone serverless",
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
name: "region",
|
|
40
|
+
type: "string",
|
|
41
|
+
isOptional: true,
|
|
42
|
+
defaultValue: "us-east-1",
|
|
43
|
+
description: "Region for Pinecone serverless",
|
|
24
44
|
},
|
|
25
45
|
]}
|
|
26
46
|
/>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Turbopuffer Vector Store | Vectors
|
|
2
|
+
title: "Reference: Turbopuffer Vector Store | Vectors"
|
|
3
3
|
description: Documentation for integrating Turbopuffer with Mastra, a high-performance vector database for efficient similarity search.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Azure | Voice
|
|
2
|
+
title: "Reference: Azure | Voice"
|
|
3
3
|
description: "Documentation for the AzureVoice class, providing text-to-speech and speech-to-text capabilities using Azure Cognitive Services."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -8,6 +8,8 @@ description: "Documentation for the AzureVoice class, providing text-to-speech a
|
|
|
8
8
|
The AzureVoice class in Mastra provides text-to-speech and speech-to-text capabilities using Microsoft Azure Cognitive Services.
|
|
9
9
|
|
|
10
10
|
## Usage Example
|
|
11
|
+
This requires Azure Speech Services credentials that can be provided through environment variables or directly in the configuration:
|
|
12
|
+
|
|
11
13
|
|
|
12
14
|
```typescript
|
|
13
15
|
import { AzureVoice } from "@mastra/voice-azure";
|
|
@@ -15,29 +17,25 @@ import { AzureVoice } from "@mastra/voice-azure";
|
|
|
15
17
|
// Initialize with configuration
|
|
16
18
|
const voice = new AzureVoice({
|
|
17
19
|
speechModel: {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
apiKey: "your-azure-speech-api-key", // Or use AZURE_API_KEY env var
|
|
21
|
+
region: "eastus", // Or use AZURE_REGION env var
|
|
22
|
+
voiceName: "en-US-AriaNeural", // Optional: specific voice for TTS
|
|
21
23
|
},
|
|
22
24
|
listeningModel: {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
25
|
+
apiKey: "your-azure-speech-api-key", // Or use AZURE_API_KEY env var
|
|
26
|
+
region: "eastus", // Or use AZURE_REGION env var
|
|
27
|
+
language: "en-US", // Optional: recognition language for STT
|
|
26
28
|
},
|
|
27
|
-
speaker: "en-US-JennyNeural", //
|
|
29
|
+
speaker: "en-US-JennyNeural", // Optional: default voice
|
|
28
30
|
});
|
|
29
31
|
|
|
30
32
|
// Convert text to speech
|
|
31
33
|
const audioStream = await voice.speak("Hello, how can I help you?", {
|
|
32
|
-
speaker: "en-US-GuyNeural", //
|
|
33
|
-
style: "cheerful", // Voice style
|
|
34
|
+
speaker: "en-US-GuyNeural", // Optional: override default voice
|
|
34
35
|
});
|
|
35
36
|
|
|
36
37
|
// Convert speech to text
|
|
37
|
-
const text = await voice.listen(audioStream
|
|
38
|
-
filetype: "wav",
|
|
39
|
-
language: "en-US",
|
|
40
|
-
});
|
|
38
|
+
const text = await voice.listen(audioStream);
|
|
41
39
|
```
|
|
42
40
|
|
|
43
41
|
## Configuration
|
|
@@ -69,26 +67,36 @@ const text = await voice.listen(audioStream, {
|
|
|
69
67
|
|
|
70
68
|
### AzureSpeechConfig
|
|
71
69
|
|
|
70
|
+
Configuration object for speech synthesis (`speechModel`) and recognition (`listeningModel`).
|
|
71
|
+
|
|
72
72
|
<PropertiesTable
|
|
73
73
|
content={[
|
|
74
74
|
{
|
|
75
|
-
name: "
|
|
76
|
-
type: "
|
|
77
|
-
description:
|
|
75
|
+
name: "apiKey",
|
|
76
|
+
type: "string",
|
|
77
|
+
description:
|
|
78
|
+
"Azure Speech Services API key (NOT Azure OpenAI key). Falls back to AZURE_API_KEY environment variable.",
|
|
78
79
|
isOptional: true,
|
|
79
80
|
},
|
|
80
81
|
{
|
|
81
|
-
name: "
|
|
82
|
+
name: "region",
|
|
82
83
|
type: "string",
|
|
83
84
|
description:
|
|
84
|
-
"Azure
|
|
85
|
+
"Azure region (e.g., 'eastus', 'westeurope'). Falls back to AZURE_REGION environment variable.",
|
|
85
86
|
isOptional: true,
|
|
86
87
|
},
|
|
87
88
|
{
|
|
88
|
-
name: "
|
|
89
|
+
name: "voiceName",
|
|
90
|
+
type: "string",
|
|
91
|
+
description:
|
|
92
|
+
"Voice ID for speech synthesis (e.g., 'en-US-AriaNeural', 'en-US-JennyNeural'). Only used in speechModel. See voice list below.",
|
|
93
|
+
isOptional: true,
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
name: "language",
|
|
89
97
|
type: "string",
|
|
90
98
|
description:
|
|
91
|
-
"
|
|
99
|
+
"Recognition language code (e.g., 'en-US', 'fr-FR'). Only used in listeningModel.",
|
|
92
100
|
isOptional: true,
|
|
93
101
|
},
|
|
94
102
|
]}
|
|
@@ -111,32 +119,14 @@ Converts text to speech using Azure's neural text-to-speech service.
|
|
|
111
119
|
{
|
|
112
120
|
name: "options.speaker",
|
|
113
121
|
type: "string",
|
|
114
|
-
description: "Voice ID to use for speech synthesis.",
|
|
122
|
+
description: "Voice ID to use for speech synthesis (e.g., 'en-US-JennyNeural'). Overrides the default voice.",
|
|
115
123
|
isOptional: true,
|
|
116
124
|
defaultValue: "Constructor's speaker value",
|
|
117
125
|
},
|
|
118
|
-
{
|
|
119
|
-
name: "options.style",
|
|
120
|
-
type: "string",
|
|
121
|
-
description: "Speaking style (e.g., 'cheerful', 'sad', 'angry').",
|
|
122
|
-
isOptional: true,
|
|
123
|
-
},
|
|
124
|
-
{
|
|
125
|
-
name: "options.rate",
|
|
126
|
-
type: "string",
|
|
127
|
-
description: "Speaking rate (e.g., 'slow', 'medium', 'fast').",
|
|
128
|
-
isOptional: true,
|
|
129
|
-
},
|
|
130
|
-
{
|
|
131
|
-
name: "options.pitch",
|
|
132
|
-
type: "string",
|
|
133
|
-
description: "Voice pitch (e.g., 'low', 'medium', 'high').",
|
|
134
|
-
isOptional: true,
|
|
135
|
-
},
|
|
136
126
|
]}
|
|
137
127
|
/>
|
|
138
128
|
|
|
139
|
-
Returns: `Promise<NodeJS.ReadableStream>`
|
|
129
|
+
Returns: `Promise<NodeJS.ReadableStream>` - Audio stream in WAV format
|
|
140
130
|
|
|
141
131
|
### listen()
|
|
142
132
|
|
|
@@ -147,31 +137,19 @@ Transcribes audio using Azure's speech-to-text service.
|
|
|
147
137
|
{
|
|
148
138
|
name: "audioStream",
|
|
149
139
|
type: "NodeJS.ReadableStream",
|
|
150
|
-
description: "Audio stream to transcribe.",
|
|
140
|
+
description: "Audio stream to transcribe. Must be in WAV format.",
|
|
151
141
|
isOptional: false,
|
|
152
142
|
},
|
|
153
|
-
{
|
|
154
|
-
name: "options.filetype",
|
|
155
|
-
type: "string",
|
|
156
|
-
description: "Audio format of the input stream.",
|
|
157
|
-
isOptional: true,
|
|
158
|
-
defaultValue: "'wav'",
|
|
159
|
-
},
|
|
160
|
-
{
|
|
161
|
-
name: "options.language",
|
|
162
|
-
type: "string",
|
|
163
|
-
description: "Language code for transcription.",
|
|
164
|
-
isOptional: true,
|
|
165
|
-
defaultValue: "'en-US'",
|
|
166
|
-
},
|
|
167
143
|
]}
|
|
168
144
|
/>
|
|
169
145
|
|
|
170
|
-
Returns: `Promise<string>`
|
|
146
|
+
Returns: `Promise<string>` - The recognized text from the audio
|
|
147
|
+
|
|
148
|
+
**Note:** Language and recognition settings are configured in the `listeningModel` configuration during initialization, not passed as options to this method.
|
|
171
149
|
|
|
172
150
|
### getSpeakers()
|
|
173
151
|
|
|
174
|
-
Returns an array of available voice options, where each node contains:
|
|
152
|
+
Returns an array of available voice options (200+ voices), where each node contains:
|
|
175
153
|
|
|
176
154
|
<PropertiesTable
|
|
177
155
|
content={[
|
|
@@ -179,40 +157,77 @@ Returns an array of available voice options, where each node contains:
|
|
|
179
157
|
name: "voiceId",
|
|
180
158
|
type: "string",
|
|
181
159
|
description:
|
|
182
|
-
"Unique identifier for the voice (e.g., 'en-US-JennyNeural')",
|
|
183
|
-
isOptional: false,
|
|
184
|
-
},
|
|
185
|
-
{
|
|
186
|
-
name: "name",
|
|
187
|
-
type: "string",
|
|
188
|
-
description: "Human-readable name of the voice",
|
|
160
|
+
"Unique identifier for the voice (e.g., 'en-US-JennyNeural', 'fr-FR-DeniseNeural')",
|
|
189
161
|
isOptional: false,
|
|
190
162
|
},
|
|
191
163
|
{
|
|
192
|
-
name: "
|
|
164
|
+
name: "language",
|
|
193
165
|
type: "string",
|
|
194
|
-
description: "Language
|
|
166
|
+
description: "Language code extracted from voice ID (e.g., 'en', 'fr')",
|
|
195
167
|
isOptional: false,
|
|
196
168
|
},
|
|
197
169
|
{
|
|
198
|
-
name: "
|
|
170
|
+
name: "region",
|
|
199
171
|
type: "string",
|
|
200
|
-
description: "
|
|
172
|
+
description: "Region code extracted from voice ID (e.g., 'US', 'GB', 'FR')",
|
|
201
173
|
isOptional: false,
|
|
202
174
|
},
|
|
203
|
-
{
|
|
204
|
-
name: "styles",
|
|
205
|
-
type: "string[]",
|
|
206
|
-
description: "Available speaking styles for the voice",
|
|
207
|
-
isOptional: true,
|
|
208
|
-
},
|
|
209
175
|
]}
|
|
210
176
|
/>
|
|
211
177
|
|
|
212
|
-
|
|
178
|
+
Returns: `Promise<Array<{ voiceId: string; language: string; region: string; }>>`
|
|
179
|
+
|
|
180
|
+
## Important Notes
|
|
181
|
+
|
|
182
|
+
### Azure Speech Services vs Azure OpenAI
|
|
183
|
+
|
|
184
|
+
**⚠️ Critical:** This package uses **Azure Speech Services**, which is different from **Azure OpenAI Services**.
|
|
185
|
+
|
|
186
|
+
- **DO NOT** use your `AZURE_OPENAI_API_KEY` for this package
|
|
187
|
+
- **DO** use an Azure Speech Services subscription key (obtain from Azure Portal under "Speech Services")
|
|
188
|
+
- These are separate Azure resources with different API keys and endpoints
|
|
189
|
+
|
|
190
|
+
### Environment Variables
|
|
191
|
+
|
|
192
|
+
API keys and regions can be provided via constructor options or environment variables:
|
|
193
|
+
|
|
194
|
+
- `AZURE_API_KEY` - Your Azure Speech Services subscription key
|
|
195
|
+
- `AZURE_REGION` - Your Azure region (e.g., 'eastus', 'westeurope')
|
|
196
|
+
|
|
197
|
+
### Voice Capabilities
|
|
198
|
+
|
|
199
|
+
- Azure offers 200+ neural voices across 50+ languages
|
|
200
|
+
- Each voice ID follows the format: `{language}-{region}-{name}Neural` (e.g., 'en-US-JennyNeural')
|
|
201
|
+
- Some voices include multilingual support or HD quality variants
|
|
202
|
+
- Audio output is in WAV format
|
|
203
|
+
- Audio input for recognition must be in WAV format
|
|
204
|
+
|
|
205
|
+
## Available Voices
|
|
206
|
+
|
|
207
|
+
Azure provides 200+ neural voices across many languages. Some popular English voices include:
|
|
208
|
+
|
|
209
|
+
- **US English:**
|
|
210
|
+
- `en-US-AriaNeural` (Female, default)
|
|
211
|
+
- `en-US-JennyNeural` (Female)
|
|
212
|
+
- `en-US-GuyNeural` (Male)
|
|
213
|
+
- `en-US-DavisNeural` (Male)
|
|
214
|
+
- `en-US-AvaNeural` (Female)
|
|
215
|
+
- `en-US-AndrewNeural` (Male)
|
|
216
|
+
|
|
217
|
+
- **British English:**
|
|
218
|
+
- `en-GB-SoniaNeural` (Female)
|
|
219
|
+
- `en-GB-RyanNeural` (Male)
|
|
220
|
+
- `en-GB-LibbyNeural` (Female)
|
|
221
|
+
|
|
222
|
+
- **Australian English:**
|
|
223
|
+
- `en-AU-NatashaNeural` (Female)
|
|
224
|
+
- `en-AU-WilliamNeural` (Male)
|
|
225
|
+
|
|
226
|
+
To get a complete list of all 200+ voices:
|
|
227
|
+
|
|
228
|
+
```typescript
|
|
229
|
+
const voices = await voice.getSpeakers();
|
|
230
|
+
console.log(voices); // Array of { voiceId, language, region }
|
|
231
|
+
```
|
|
213
232
|
|
|
214
|
-
|
|
215
|
-
- Azure offers a wide range of neural voices across many languages
|
|
216
|
-
- Some voices support speaking styles like cheerful, sad, angry, etc.
|
|
217
|
-
- Speech recognition supports multiple audio formats and languages
|
|
218
|
-
- Azure's speech services provide high-quality neural voices with natural-sounding speech
|
|
233
|
+
For more information, see the [Azure Neural TTS documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=tts).
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: CompositeVoice | Voice
|
|
2
|
+
title: "Reference: CompositeVoice | Voice"
|
|
3
3
|
description: "Documentation for the CompositeVoice class, which enables combining multiple voice providers for flexible text-to-speech and speech-to-text operations."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Deepgram | Voice
|
|
2
|
+
title: "Reference: Deepgram | Voice"
|
|
3
3
|
description: "Documentation for the Deepgram voice implementation, providing text-to-speech and speech-to-text capabilities with multiple voice models and languages."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: ElevenLabs | Voice
|
|
2
|
+
title: "Reference: ElevenLabs | Voice"
|
|
3
3
|
description: "Documentation for the ElevenLabs voice implementation, offering high-quality text-to-speech capabilities with multiple voice models and natural-sounding synthesis."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Google Gemini Live Voice | Voice
|
|
2
|
+
title: "Reference: Google Gemini Live Voice | Voice"
|
|
3
3
|
description: "Documentation for the GeminiLiveVoice class, providing real-time multimodal voice interactions using Google's Gemini Live API with support for both Gemini API and Vertex AI."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: MastraVoice | Voice
|
|
2
|
+
title: "Reference: MastraVoice | Voice"
|
|
3
3
|
description: "Documentation for the MastraVoice abstract base class, which defines the core interface for all voice services in Mastra, including speech-to-speech capabilities."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: OpenAI Realtime Voice | Voice
|
|
2
|
+
title: "Reference: OpenAI Realtime Voice | Voice"
|
|
3
3
|
description: "Documentation for the OpenAIRealtimeVoice class, providing real-time text-to-speech and speech-to-text capabilities via WebSockets."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: voice.addInstructions() | Voice
|
|
2
|
+
title: "Reference: voice.addInstructions() | Voice"
|
|
3
3
|
description: "Documentation for the addInstructions() method available in voice providers, which adds instructions to guide the voice model's behavior."
|
|
4
4
|
---
|
|
5
5
|
|