@mastra/mcp-docs-server 1.1.4 → 1.1.5
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/CHANGELOG.md +14 -0
- package/package.json +5 -5
- package/.docs/docs/agents/adding-voice.md +0 -353
- package/.docs/docs/agents/agent-approval.md +0 -377
- package/.docs/docs/agents/agent-memory.md +0 -212
- package/.docs/docs/agents/guardrails.md +0 -382
- package/.docs/docs/agents/network-approval.md +0 -275
- package/.docs/docs/agents/networks.md +0 -290
- package/.docs/docs/agents/overview.md +0 -309
- package/.docs/docs/agents/processors.md +0 -632
- package/.docs/docs/agents/structured-output.md +0 -271
- package/.docs/docs/agents/using-tools.md +0 -214
- package/.docs/docs/build-with-ai/mcp-docs-server.md +0 -241
- package/.docs/docs/build-with-ai/skills.md +0 -35
- package/.docs/docs/community/contributing-templates.md +0 -3
- package/.docs/docs/community/discord.md +0 -9
- package/.docs/docs/community/licensing.md +0 -66
- package/.docs/docs/deployment/cloud-providers.md +0 -15
- package/.docs/docs/deployment/mastra-server.md +0 -122
- package/.docs/docs/deployment/monorepo.md +0 -142
- package/.docs/docs/deployment/overview.md +0 -62
- package/.docs/docs/deployment/studio.md +0 -234
- package/.docs/docs/deployment/web-framework.md +0 -52
- package/.docs/docs/deployment/workflow-runners.md +0 -9
- package/.docs/docs/evals/built-in-scorers.md +0 -47
- package/.docs/docs/evals/custom-scorers.md +0 -519
- package/.docs/docs/evals/overview.md +0 -146
- package/.docs/docs/evals/running-in-ci.md +0 -106
- package/.docs/docs/getting-started/build-with-ai.md +0 -68
- package/.docs/docs/getting-started/manual-install.md +0 -226
- package/.docs/docs/getting-started/project-structure.md +0 -60
- package/.docs/docs/getting-started/start.md +0 -28
- package/.docs/docs/getting-started/studio.md +0 -101
- package/.docs/docs/index.md +0 -43
- package/.docs/docs/mastra-cloud/deployment.md +0 -77
- package/.docs/docs/mastra-cloud/observability.md +0 -38
- package/.docs/docs/mastra-cloud/overview.md +0 -23
- package/.docs/docs/mastra-cloud/setup.md +0 -42
- package/.docs/docs/mastra-cloud/studio.md +0 -24
- package/.docs/docs/mcp/overview.md +0 -370
- package/.docs/docs/mcp/publishing-mcp-server.md +0 -95
- package/.docs/docs/memory/memory-processors.md +0 -316
- package/.docs/docs/memory/message-history.md +0 -260
- package/.docs/docs/memory/observational-memory.md +0 -246
- package/.docs/docs/memory/overview.md +0 -45
- package/.docs/docs/memory/semantic-recall.md +0 -272
- package/.docs/docs/memory/storage.md +0 -261
- package/.docs/docs/memory/working-memory.md +0 -400
- package/.docs/docs/observability/datasets/overview.md +0 -188
- package/.docs/docs/observability/datasets/running-experiments.md +0 -266
- package/.docs/docs/observability/logging.md +0 -99
- package/.docs/docs/observability/overview.md +0 -70
- package/.docs/docs/observability/tracing/bridges/otel.md +0 -209
- package/.docs/docs/observability/tracing/exporters/arize.md +0 -274
- package/.docs/docs/observability/tracing/exporters/braintrust.md +0 -111
- package/.docs/docs/observability/tracing/exporters/cloud.md +0 -129
- package/.docs/docs/observability/tracing/exporters/datadog.md +0 -187
- package/.docs/docs/observability/tracing/exporters/default.md +0 -211
- package/.docs/docs/observability/tracing/exporters/laminar.md +0 -100
- package/.docs/docs/observability/tracing/exporters/langfuse.md +0 -217
- package/.docs/docs/observability/tracing/exporters/langsmith.md +0 -202
- package/.docs/docs/observability/tracing/exporters/otel.md +0 -479
- package/.docs/docs/observability/tracing/exporters/posthog.md +0 -148
- package/.docs/docs/observability/tracing/exporters/sentry.md +0 -208
- package/.docs/docs/observability/tracing/overview.md +0 -1114
- package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +0 -303
- package/.docs/docs/rag/chunking-and-embedding.md +0 -183
- package/.docs/docs/rag/graph-rag.md +0 -215
- package/.docs/docs/rag/overview.md +0 -72
- package/.docs/docs/rag/retrieval.md +0 -521
- package/.docs/docs/rag/vector-databases.md +0 -648
- package/.docs/docs/server/auth/auth0.md +0 -222
- package/.docs/docs/server/auth/better-auth.md +0 -203
- package/.docs/docs/server/auth/clerk.md +0 -132
- package/.docs/docs/server/auth/composite-auth.md +0 -234
- package/.docs/docs/server/auth/custom-auth-provider.md +0 -513
- package/.docs/docs/server/auth/firebase.md +0 -272
- package/.docs/docs/server/auth/jwt.md +0 -110
- package/.docs/docs/server/auth/simple-auth.md +0 -178
- package/.docs/docs/server/auth/supabase.md +0 -117
- package/.docs/docs/server/auth/workos.md +0 -190
- package/.docs/docs/server/auth.md +0 -38
- package/.docs/docs/server/custom-adapters.md +0 -374
- package/.docs/docs/server/custom-api-routes.md +0 -267
- package/.docs/docs/server/mastra-client.md +0 -243
- package/.docs/docs/server/mastra-server.md +0 -71
- package/.docs/docs/server/middleware.md +0 -228
- package/.docs/docs/server/request-context.md +0 -478
- package/.docs/docs/server/server-adapters.md +0 -547
- package/.docs/docs/streaming/events.md +0 -247
- package/.docs/docs/streaming/overview.md +0 -181
- package/.docs/docs/streaming/tool-streaming.md +0 -178
- package/.docs/docs/streaming/workflow-streaming.md +0 -109
- package/.docs/docs/voice/overview.md +0 -979
- package/.docs/docs/voice/speech-to-speech.md +0 -103
- package/.docs/docs/voice/speech-to-text.md +0 -80
- package/.docs/docs/voice/text-to-speech.md +0 -84
- package/.docs/docs/workflows/agents-and-tools.md +0 -170
- package/.docs/docs/workflows/control-flow.md +0 -823
- package/.docs/docs/workflows/error-handling.md +0 -360
- package/.docs/docs/workflows/human-in-the-loop.md +0 -213
- package/.docs/docs/workflows/overview.md +0 -372
- package/.docs/docs/workflows/snapshots.md +0 -238
- package/.docs/docs/workflows/suspend-and-resume.md +0 -205
- package/.docs/docs/workflows/time-travel.md +0 -309
- package/.docs/docs/workflows/workflow-state.md +0 -181
- package/.docs/docs/workspace/filesystem.md +0 -162
- package/.docs/docs/workspace/overview.md +0 -239
- package/.docs/docs/workspace/sandbox.md +0 -63
- package/.docs/docs/workspace/search.md +0 -219
- package/.docs/docs/workspace/skills.md +0 -126
- package/.docs/guides/agent-frameworks/ai-sdk.md +0 -140
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +0 -1463
- package/.docs/guides/build-your-ui/assistant-ui.md +0 -156
- package/.docs/guides/build-your-ui/copilotkit.md +0 -292
- package/.docs/guides/deployment/amazon-ec2.md +0 -130
- package/.docs/guides/deployment/aws-lambda.md +0 -248
- package/.docs/guides/deployment/azure-app-services.md +0 -114
- package/.docs/guides/deployment/cloudflare.md +0 -99
- package/.docs/guides/deployment/digital-ocean.md +0 -168
- package/.docs/guides/deployment/inngest.md +0 -685
- package/.docs/guides/deployment/netlify.md +0 -77
- package/.docs/guides/deployment/vercel.md +0 -101
- package/.docs/guides/getting-started/astro.md +0 -408
- package/.docs/guides/getting-started/electron.md +0 -504
- package/.docs/guides/getting-started/express.md +0 -251
- package/.docs/guides/getting-started/hono.md +0 -191
- package/.docs/guides/getting-started/next-js.md +0 -355
- package/.docs/guides/getting-started/nuxt.md +0 -476
- package/.docs/guides/getting-started/quickstart.md +0 -67
- package/.docs/guides/getting-started/sveltekit.md +0 -300
- package/.docs/guides/getting-started/vite-react.md +0 -439
- package/.docs/guides/guide/ai-recruiter.md +0 -227
- package/.docs/guides/guide/chef-michel.md +0 -215
- package/.docs/guides/guide/code-review-bot.md +0 -221
- package/.docs/guides/guide/dev-assistant.md +0 -304
- package/.docs/guides/guide/docs-manager.md +0 -238
- package/.docs/guides/guide/github-actions-pr-description.md +0 -236
- package/.docs/guides/guide/notes-mcp-server.md +0 -425
- package/.docs/guides/guide/research-assistant.md +0 -349
- package/.docs/guides/guide/stock-agent.md +0 -134
- package/.docs/guides/guide/web-search.md +0 -326
- package/.docs/guides/guide/whatsapp-chat-bot.md +0 -416
- package/.docs/guides/index.md +0 -3
- package/.docs/guides/migrations/agentnetwork.md +0 -101
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +0 -112
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +0 -404
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +0 -57
- package/.docs/guides/migrations/upgrade-to-v1/client.md +0 -337
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +0 -37
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +0 -239
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +0 -143
- package/.docs/guides/migrations/upgrade-to-v1/mcp.md +0 -97
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +0 -285
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +0 -119
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +0 -68
- package/.docs/guides/migrations/upgrade-to-v1/rag.md +0 -42
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +0 -553
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +0 -180
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +0 -417
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +0 -87
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +0 -30
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +0 -341
- package/.docs/guides/migrations/vnext-to-standard-apis.md +0 -364
- package/.docs/models/embeddings.md +0 -161
- package/.docs/models/gateways/azure-openai.md +0 -128
- package/.docs/models/gateways/custom-gateways.md +0 -545
- package/.docs/models/gateways/netlify.md +0 -88
- package/.docs/models/gateways/openrouter.md +0 -219
- package/.docs/models/gateways/vercel.md +0 -225
- package/.docs/models/gateways.md +0 -14
- package/.docs/models/index.md +0 -286
- package/.docs/models/providers/302ai.md +0 -134
- package/.docs/models/providers/abacus.md +0 -125
- package/.docs/models/providers/agentrouter.md +0 -90
- package/.docs/models/providers/aihubmix.md +0 -107
- package/.docs/models/providers/alibaba-cn.md +0 -135
- package/.docs/models/providers/alibaba.md +0 -111
- package/.docs/models/providers/amazon-bedrock.md +0 -33
- package/.docs/models/providers/anthropic.md +0 -153
- package/.docs/models/providers/azure.md +0 -33
- package/.docs/models/providers/bailing.md +0 -72
- package/.docs/models/providers/baseten.md +0 -77
- package/.docs/models/providers/berget.md +0 -78
- package/.docs/models/providers/cerebras.md +0 -101
- package/.docs/models/providers/chutes.md +0 -136
- package/.docs/models/providers/cloudflare-ai-gateway.md +0 -33
- package/.docs/models/providers/cloudflare-workers-ai.md +0 -109
- package/.docs/models/providers/cohere.md +0 -33
- package/.docs/models/providers/cortecs.md +0 -91
- package/.docs/models/providers/deepinfra.md +0 -112
- package/.docs/models/providers/deepseek.md +0 -88
- package/.docs/models/providers/fastrouter.md +0 -84
- package/.docs/models/providers/fireworks-ai.md +0 -89
- package/.docs/models/providers/firmware.md +0 -85
- package/.docs/models/providers/friendli.md +0 -78
- package/.docs/models/providers/github-models.md +0 -125
- package/.docs/models/providers/google-vertex.md +0 -33
- package/.docs/models/providers/google.md +0 -159
- package/.docs/models/providers/groq.md +0 -107
- package/.docs/models/providers/helicone.md +0 -161
- package/.docs/models/providers/huggingface.md +0 -90
- package/.docs/models/providers/iflowcn.md +0 -84
- package/.docs/models/providers/inception.md +0 -72
- package/.docs/models/providers/inference.md +0 -79
- package/.docs/models/providers/io-intelligence.md +0 -87
- package/.docs/models/providers/io-net.md +0 -87
- package/.docs/models/providers/jiekou.md +0 -131
- package/.docs/models/providers/kilo.md +0 -333
- package/.docs/models/providers/kimi-for-coding.md +0 -100
- package/.docs/models/providers/kuae-cloud-coding-plan.md +0 -71
- package/.docs/models/providers/llama.md +0 -77
- package/.docs/models/providers/lmstudio.md +0 -73
- package/.docs/models/providers/lucidquery.md +0 -72
- package/.docs/models/providers/minimax-cn-coding-plan.md +0 -102
- package/.docs/models/providers/minimax-cn.md +0 -102
- package/.docs/models/providers/minimax-coding-plan.md +0 -102
- package/.docs/models/providers/minimax.md +0 -104
- package/.docs/models/providers/mistral.md +0 -124
- package/.docs/models/providers/moark.md +0 -72
- package/.docs/models/providers/modelscope.md +0 -77
- package/.docs/models/providers/moonshotai-cn.md +0 -76
- package/.docs/models/providers/moonshotai.md +0 -76
- package/.docs/models/providers/morph.md +0 -73
- package/.docs/models/providers/nano-gpt.md +0 -103
- package/.docs/models/providers/nebius.md +0 -116
- package/.docs/models/providers/nova.md +0 -72
- package/.docs/models/providers/novita-ai.md +0 -154
- package/.docs/models/providers/nvidia.md +0 -141
- package/.docs/models/providers/ollama-cloud.md +0 -103
- package/.docs/models/providers/ollama.md +0 -33
- package/.docs/models/providers/openai.md +0 -193
- package/.docs/models/providers/opencode.md +0 -100
- package/.docs/models/providers/ovhcloud.md +0 -83
- package/.docs/models/providers/perplexity.md +0 -100
- package/.docs/models/providers/poe.md +0 -183
- package/.docs/models/providers/privatemode-ai.md +0 -75
- package/.docs/models/providers/requesty.md +0 -90
- package/.docs/models/providers/scaleway.md +0 -84
- package/.docs/models/providers/siliconflow-cn.md +0 -138
- package/.docs/models/providers/siliconflow.md +0 -140
- package/.docs/models/providers/stackit.md +0 -78
- package/.docs/models/providers/stepfun.md +0 -73
- package/.docs/models/providers/submodel.md +0 -79
- package/.docs/models/providers/synthetic.md +0 -96
- package/.docs/models/providers/togetherai.md +0 -115
- package/.docs/models/providers/upstage.md +0 -73
- package/.docs/models/providers/venice.md +0 -95
- package/.docs/models/providers/vivgrid.md +0 -106
- package/.docs/models/providers/vultr.md +0 -75
- package/.docs/models/providers/wandb.md +0 -80
- package/.docs/models/providers/xai.md +0 -141
- package/.docs/models/providers/xiaomi.md +0 -71
- package/.docs/models/providers/zai-coding-plan.md +0 -80
- package/.docs/models/providers/zai.md +0 -79
- package/.docs/models/providers/zenmux.md +0 -161
- package/.docs/models/providers/zhipuai-coding-plan.md +0 -79
- package/.docs/models/providers/zhipuai.md +0 -79
- package/.docs/models/providers.md +0 -81
- package/.docs/reference/agents/agent.md +0 -142
- package/.docs/reference/agents/generate.md +0 -174
- package/.docs/reference/agents/generateLegacy.md +0 -176
- package/.docs/reference/agents/getDefaultGenerateOptions.md +0 -36
- package/.docs/reference/agents/getDefaultOptions.md +0 -34
- package/.docs/reference/agents/getDefaultStreamOptions.md +0 -36
- package/.docs/reference/agents/getDescription.md +0 -21
- package/.docs/reference/agents/getInstructions.md +0 -34
- package/.docs/reference/agents/getLLM.md +0 -37
- package/.docs/reference/agents/getMemory.md +0 -34
- package/.docs/reference/agents/getModel.md +0 -34
- package/.docs/reference/agents/getTools.md +0 -29
- package/.docs/reference/agents/getVoice.md +0 -34
- package/.docs/reference/agents/listAgents.md +0 -35
- package/.docs/reference/agents/listScorers.md +0 -34
- package/.docs/reference/agents/listTools.md +0 -34
- package/.docs/reference/agents/listWorkflows.md +0 -34
- package/.docs/reference/agents/network.md +0 -134
- package/.docs/reference/ai-sdk/chat-route.md +0 -82
- package/.docs/reference/ai-sdk/handle-chat-stream.md +0 -53
- package/.docs/reference/ai-sdk/handle-network-stream.md +0 -37
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +0 -55
- package/.docs/reference/ai-sdk/network-route.md +0 -74
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +0 -232
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +0 -79
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +0 -73
- package/.docs/reference/ai-sdk/with-mastra.md +0 -59
- package/.docs/reference/ai-sdk/workflow-route.md +0 -79
- package/.docs/reference/auth/auth0.md +0 -73
- package/.docs/reference/auth/better-auth.md +0 -71
- package/.docs/reference/auth/clerk.md +0 -36
- package/.docs/reference/auth/firebase.md +0 -80
- package/.docs/reference/auth/jwt.md +0 -26
- package/.docs/reference/auth/supabase.md +0 -33
- package/.docs/reference/auth/workos.md +0 -84
- package/.docs/reference/cli/create-mastra.md +0 -137
- package/.docs/reference/cli/mastra.md +0 -336
- package/.docs/reference/client-js/agents.md +0 -438
- package/.docs/reference/client-js/error-handling.md +0 -16
- package/.docs/reference/client-js/logs.md +0 -24
- package/.docs/reference/client-js/mastra-client.md +0 -63
- package/.docs/reference/client-js/memory.md +0 -225
- package/.docs/reference/client-js/observability.md +0 -72
- package/.docs/reference/client-js/telemetry.md +0 -20
- package/.docs/reference/client-js/tools.md +0 -44
- package/.docs/reference/client-js/vectors.md +0 -79
- package/.docs/reference/client-js/workflows.md +0 -199
- package/.docs/reference/configuration.md +0 -749
- package/.docs/reference/core/addGateway.md +0 -42
- package/.docs/reference/core/getAgent.md +0 -21
- package/.docs/reference/core/getAgentById.md +0 -21
- package/.docs/reference/core/getDeployer.md +0 -22
- package/.docs/reference/core/getGateway.md +0 -38
- package/.docs/reference/core/getGatewayById.md +0 -41
- package/.docs/reference/core/getLogger.md +0 -22
- package/.docs/reference/core/getMCPServer.md +0 -45
- package/.docs/reference/core/getMCPServerById.md +0 -53
- package/.docs/reference/core/getMemory.md +0 -50
- package/.docs/reference/core/getScorer.md +0 -54
- package/.docs/reference/core/getScorerById.md +0 -54
- package/.docs/reference/core/getServer.md +0 -22
- package/.docs/reference/core/getStorage.md +0 -22
- package/.docs/reference/core/getStoredAgentById.md +0 -89
- package/.docs/reference/core/getTelemetry.md +0 -22
- package/.docs/reference/core/getVector.md +0 -22
- package/.docs/reference/core/getWorkflow.md +0 -40
- package/.docs/reference/core/listAgents.md +0 -21
- package/.docs/reference/core/listGateways.md +0 -40
- package/.docs/reference/core/listLogs.md +0 -38
- package/.docs/reference/core/listLogsByRunId.md +0 -36
- package/.docs/reference/core/listMCPServers.md +0 -51
- package/.docs/reference/core/listMemory.md +0 -56
- package/.docs/reference/core/listScorers.md +0 -29
- package/.docs/reference/core/listStoredAgents.md +0 -93
- package/.docs/reference/core/listVectors.md +0 -22
- package/.docs/reference/core/listWorkflows.md +0 -21
- package/.docs/reference/core/mastra-class.md +0 -66
- package/.docs/reference/core/mastra-model-gateway.md +0 -153
- package/.docs/reference/core/setLogger.md +0 -26
- package/.docs/reference/core/setStorage.md +0 -27
- package/.docs/reference/datasets/addItem.md +0 -35
- package/.docs/reference/datasets/addItems.md +0 -33
- package/.docs/reference/datasets/compareExperiments.md +0 -48
- package/.docs/reference/datasets/create.md +0 -49
- package/.docs/reference/datasets/dataset.md +0 -78
- package/.docs/reference/datasets/datasets-manager.md +0 -84
- package/.docs/reference/datasets/delete.md +0 -23
- package/.docs/reference/datasets/deleteExperiment.md +0 -25
- package/.docs/reference/datasets/deleteItem.md +0 -25
- package/.docs/reference/datasets/deleteItems.md +0 -27
- package/.docs/reference/datasets/get.md +0 -29
- package/.docs/reference/datasets/getDetails.md +0 -45
- package/.docs/reference/datasets/getExperiment.md +0 -28
- package/.docs/reference/datasets/getItem.md +0 -31
- package/.docs/reference/datasets/getItemHistory.md +0 -29
- package/.docs/reference/datasets/list.md +0 -29
- package/.docs/reference/datasets/listExperimentResults.md +0 -37
- package/.docs/reference/datasets/listExperiments.md +0 -31
- package/.docs/reference/datasets/listItems.md +0 -44
- package/.docs/reference/datasets/listVersions.md +0 -31
- package/.docs/reference/datasets/startExperiment.md +0 -60
- package/.docs/reference/datasets/startExperimentAsync.md +0 -41
- package/.docs/reference/datasets/update.md +0 -46
- package/.docs/reference/datasets/updateItem.md +0 -36
- package/.docs/reference/deployer/cloudflare.md +0 -79
- package/.docs/reference/deployer/netlify.md +0 -82
- package/.docs/reference/deployer/vercel.md +0 -91
- package/.docs/reference/deployer.md +0 -100
- package/.docs/reference/evals/answer-relevancy.md +0 -105
- package/.docs/reference/evals/answer-similarity.md +0 -99
- package/.docs/reference/evals/bias.md +0 -120
- package/.docs/reference/evals/completeness.md +0 -137
- package/.docs/reference/evals/content-similarity.md +0 -101
- package/.docs/reference/evals/context-precision.md +0 -196
- package/.docs/reference/evals/context-relevance.md +0 -536
- package/.docs/reference/evals/create-scorer.md +0 -270
- package/.docs/reference/evals/faithfulness.md +0 -114
- package/.docs/reference/evals/hallucination.md +0 -220
- package/.docs/reference/evals/keyword-coverage.md +0 -128
- package/.docs/reference/evals/mastra-scorer.md +0 -123
- package/.docs/reference/evals/noise-sensitivity.md +0 -685
- package/.docs/reference/evals/prompt-alignment.md +0 -619
- package/.docs/reference/evals/run-evals.md +0 -138
- package/.docs/reference/evals/scorer-utils.md +0 -330
- package/.docs/reference/evals/textual-difference.md +0 -113
- package/.docs/reference/evals/tone-consistency.md +0 -119
- package/.docs/reference/evals/tool-call-accuracy.md +0 -533
- package/.docs/reference/evals/toxicity.md +0 -123
- package/.docs/reference/harness/harness-class.md +0 -645
- package/.docs/reference/index.md +0 -276
- package/.docs/reference/logging/pino-logger.md +0 -117
- package/.docs/reference/memory/clone-utilities.md +0 -199
- package/.docs/reference/memory/cloneThread.md +0 -130
- package/.docs/reference/memory/createThread.md +0 -68
- package/.docs/reference/memory/deleteMessages.md +0 -40
- package/.docs/reference/memory/getThreadById.md +0 -24
- package/.docs/reference/memory/listThreads.md +0 -145
- package/.docs/reference/memory/memory-class.md +0 -147
- package/.docs/reference/memory/observational-memory.md +0 -565
- package/.docs/reference/memory/recall.md +0 -91
- package/.docs/reference/observability/tracing/bridges/otel.md +0 -131
- package/.docs/reference/observability/tracing/configuration.md +0 -178
- package/.docs/reference/observability/tracing/exporters/arize.md +0 -141
- package/.docs/reference/observability/tracing/exporters/braintrust.md +0 -93
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +0 -163
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +0 -138
- package/.docs/reference/observability/tracing/exporters/datadog.md +0 -116
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +0 -174
- package/.docs/reference/observability/tracing/exporters/laminar.md +0 -78
- package/.docs/reference/observability/tracing/exporters/langfuse.md +0 -134
- package/.docs/reference/observability/tracing/exporters/langsmith.md +0 -110
- package/.docs/reference/observability/tracing/exporters/otel.md +0 -199
- package/.docs/reference/observability/tracing/exporters/posthog.md +0 -92
- package/.docs/reference/observability/tracing/exporters/sentry.md +0 -184
- package/.docs/reference/observability/tracing/instances.md +0 -109
- package/.docs/reference/observability/tracing/interfaces.md +0 -749
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +0 -144
- package/.docs/reference/observability/tracing/spans.md +0 -224
- package/.docs/reference/processors/batch-parts-processor.md +0 -61
- package/.docs/reference/processors/language-detector.md +0 -81
- package/.docs/reference/processors/message-history-processor.md +0 -85
- package/.docs/reference/processors/moderation-processor.md +0 -104
- package/.docs/reference/processors/pii-detector.md +0 -107
- package/.docs/reference/processors/processor-interface.md +0 -525
- package/.docs/reference/processors/prompt-injection-detector.md +0 -71
- package/.docs/reference/processors/semantic-recall-processor.md +0 -123
- package/.docs/reference/processors/system-prompt-scrubber.md +0 -80
- package/.docs/reference/processors/token-limiter-processor.md +0 -113
- package/.docs/reference/processors/tool-call-filter.md +0 -85
- package/.docs/reference/processors/tool-search-processor.md +0 -113
- package/.docs/reference/processors/unicode-normalizer.md +0 -62
- package/.docs/reference/processors/working-memory-processor.md +0 -154
- package/.docs/reference/rag/chunk.md +0 -221
- package/.docs/reference/rag/database-config.md +0 -264
- package/.docs/reference/rag/document.md +0 -114
- package/.docs/reference/rag/embeddings.md +0 -92
- package/.docs/reference/rag/extract-params.md +0 -168
- package/.docs/reference/rag/graph-rag.md +0 -111
- package/.docs/reference/rag/metadata-filters.md +0 -216
- package/.docs/reference/rag/rerank.md +0 -80
- package/.docs/reference/rag/rerankWithScorer.md +0 -80
- package/.docs/reference/server/create-route.md +0 -260
- package/.docs/reference/server/express-adapter.md +0 -176
- package/.docs/reference/server/fastify-adapter.md +0 -90
- package/.docs/reference/server/hono-adapter.md +0 -162
- package/.docs/reference/server/koa-adapter.md +0 -127
- package/.docs/reference/server/mastra-server.md +0 -298
- package/.docs/reference/server/register-api-route.md +0 -249
- package/.docs/reference/server/routes.md +0 -306
- package/.docs/reference/storage/cloudflare-d1.md +0 -218
- package/.docs/reference/storage/cloudflare.md +0 -88
- package/.docs/reference/storage/composite.md +0 -235
- package/.docs/reference/storage/convex.md +0 -161
- package/.docs/reference/storage/dynamodb.md +0 -282
- package/.docs/reference/storage/lance.md +0 -131
- package/.docs/reference/storage/libsql.md +0 -135
- package/.docs/reference/storage/mongodb.md +0 -262
- package/.docs/reference/storage/mssql.md +0 -155
- package/.docs/reference/storage/overview.md +0 -121
- package/.docs/reference/storage/postgresql.md +0 -529
- package/.docs/reference/storage/upstash.md +0 -160
- package/.docs/reference/streaming/ChunkType.md +0 -292
- package/.docs/reference/streaming/agents/MastraModelOutput.md +0 -182
- package/.docs/reference/streaming/agents/stream.md +0 -212
- package/.docs/reference/streaming/agents/streamLegacy.md +0 -142
- package/.docs/reference/streaming/workflows/observeStream.md +0 -42
- package/.docs/reference/streaming/workflows/resumeStream.md +0 -61
- package/.docs/reference/streaming/workflows/stream.md +0 -88
- package/.docs/reference/streaming/workflows/timeTravelStream.md +0 -142
- package/.docs/reference/templates/overview.md +0 -194
- package/.docs/reference/tools/create-tool.md +0 -237
- package/.docs/reference/tools/document-chunker-tool.md +0 -89
- package/.docs/reference/tools/graph-rag-tool.md +0 -185
- package/.docs/reference/tools/mcp-client.md +0 -962
- package/.docs/reference/tools/mcp-server.md +0 -1275
- package/.docs/reference/tools/vector-query-tool.md +0 -459
- package/.docs/reference/vectors/astra.md +0 -121
- package/.docs/reference/vectors/chroma.md +0 -267
- package/.docs/reference/vectors/convex.md +0 -303
- package/.docs/reference/vectors/couchbase.md +0 -226
- package/.docs/reference/vectors/duckdb.md +0 -318
- package/.docs/reference/vectors/elasticsearch.md +0 -189
- package/.docs/reference/vectors/lance.md +0 -220
- package/.docs/reference/vectors/libsql.md +0 -305
- package/.docs/reference/vectors/mongodb.md +0 -295
- package/.docs/reference/vectors/opensearch.md +0 -99
- package/.docs/reference/vectors/pg.md +0 -408
- package/.docs/reference/vectors/pinecone.md +0 -168
- package/.docs/reference/vectors/qdrant.md +0 -222
- package/.docs/reference/vectors/s3vectors.md +0 -277
- package/.docs/reference/vectors/turbopuffer.md +0 -157
- package/.docs/reference/vectors/upstash.md +0 -294
- package/.docs/reference/vectors/vectorize.md +0 -147
- package/.docs/reference/voice/azure.md +0 -148
- package/.docs/reference/voice/cloudflare.md +0 -83
- package/.docs/reference/voice/composite-voice.md +0 -121
- package/.docs/reference/voice/deepgram.md +0 -79
- package/.docs/reference/voice/elevenlabs.md +0 -98
- package/.docs/reference/voice/google-gemini-live.md +0 -378
- package/.docs/reference/voice/google.md +0 -228
- package/.docs/reference/voice/mastra-voice.md +0 -313
- package/.docs/reference/voice/murf.md +0 -122
- package/.docs/reference/voice/openai-realtime.md +0 -203
- package/.docs/reference/voice/openai.md +0 -88
- package/.docs/reference/voice/playai.md +0 -80
- package/.docs/reference/voice/sarvam.md +0 -126
- package/.docs/reference/voice/speechify.md +0 -75
- package/.docs/reference/voice/voice.addInstructions.md +0 -56
- package/.docs/reference/voice/voice.addTools.md +0 -67
- package/.docs/reference/voice/voice.answer.md +0 -54
- package/.docs/reference/voice/voice.close.md +0 -51
- package/.docs/reference/voice/voice.connect.md +0 -94
- package/.docs/reference/voice/voice.events.md +0 -37
- package/.docs/reference/voice/voice.getSpeakers.md +0 -129
- package/.docs/reference/voice/voice.listen.md +0 -164
- package/.docs/reference/voice/voice.off.md +0 -54
- package/.docs/reference/voice/voice.on.md +0 -111
- package/.docs/reference/voice/voice.send.md +0 -65
- package/.docs/reference/voice/voice.speak.md +0 -157
- package/.docs/reference/voice/voice.updateConfig.md +0 -60
- package/.docs/reference/workflows/run-methods/cancel.md +0 -86
- package/.docs/reference/workflows/run-methods/restart.md +0 -33
- package/.docs/reference/workflows/run-methods/resume.md +0 -59
- package/.docs/reference/workflows/run-methods/start.md +0 -58
- package/.docs/reference/workflows/run-methods/startAsync.md +0 -67
- package/.docs/reference/workflows/run-methods/timeTravel.md +0 -142
- package/.docs/reference/workflows/run.md +0 -59
- package/.docs/reference/workflows/step.md +0 -119
- package/.docs/reference/workflows/workflow-methods/branch.md +0 -25
- package/.docs/reference/workflows/workflow-methods/commit.md +0 -17
- package/.docs/reference/workflows/workflow-methods/create-run.md +0 -63
- package/.docs/reference/workflows/workflow-methods/dountil.md +0 -25
- package/.docs/reference/workflows/workflow-methods/dowhile.md +0 -25
- package/.docs/reference/workflows/workflow-methods/foreach.md +0 -118
- package/.docs/reference/workflows/workflow-methods/map.md +0 -93
- package/.docs/reference/workflows/workflow-methods/parallel.md +0 -21
- package/.docs/reference/workflows/workflow-methods/sleep.md +0 -35
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +0 -35
- package/.docs/reference/workflows/workflow-methods/then.md +0 -21
- package/.docs/reference/workflows/workflow.md +0 -157
- package/.docs/reference/workspace/e2b-sandbox.md +0 -288
- package/.docs/reference/workspace/filesystem.md +0 -202
- package/.docs/reference/workspace/gcs-filesystem.md +0 -170
- package/.docs/reference/workspace/local-filesystem.md +0 -327
- package/.docs/reference/workspace/local-sandbox.md +0 -285
- package/.docs/reference/workspace/s3-filesystem.md +0 -169
- package/.docs/reference/workspace/sandbox.md +0 -81
- package/.docs/reference/workspace/workspace-class.md +0 -226
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# dataset.listExperimentResults()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Lists individual item results for a specific experiment with pagination.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
const { results, pagination } = await dataset.listExperimentResults({
|
|
17
|
-
experimentId: "exp-id",
|
|
18
|
-
page: 0,
|
|
19
|
-
perPage: 50,
|
|
20
|
-
});
|
|
21
|
-
|
|
22
|
-
for (const result of results) {
|
|
23
|
-
console.log(`Item ${result.itemId}: ${result.error ? "FAILED" : "OK"}`);
|
|
24
|
-
}
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Parameters
|
|
28
|
-
|
|
29
|
-
**experimentId:** (`string`): ID of the experiment to list results for.
|
|
30
|
-
|
|
31
|
-
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
32
|
-
|
|
33
|
-
**perPage?:** (`number`): Number of results per page. Defaults to \`20\`.
|
|
34
|
-
|
|
35
|
-
## Returns
|
|
36
|
-
|
|
37
|
-
**result:** (`Promise<object>`): objectresults:ExperimentResult\[]Array of item-level results.ExperimentResultid:stringUnique result ID.experimentId:stringID of the parent experiment.itemId:stringID of the dataset item.itemDatasetVersion:number | nullDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target.groundTruth:unknown | nullExpected output.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen execution started.completedAt:DateWhen execution completed.retryCount:numberNumber of retry attempts.traceId:string | nullTrace ID for observability.createdAt:DateWhen the result record was created.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# dataset.listExperiments()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Lists all experiments (runs) for this dataset with pagination.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
const { experiments, pagination } = await dataset.listExperiments({ page: 0, perPage: 10 });
|
|
17
|
-
|
|
18
|
-
for (const exp of experiments) {
|
|
19
|
-
console.log(`${exp.id}: ${exp.status} (${exp.succeededCount}/${exp.totalItems})`);
|
|
20
|
-
}
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Parameters
|
|
24
|
-
|
|
25
|
-
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
26
|
-
|
|
27
|
-
**perPage?:** (`number`): Number of experiments per page. Defaults to \`20\`.
|
|
28
|
-
|
|
29
|
-
## Returns
|
|
30
|
-
|
|
31
|
-
**result:** (`Promise<object>`): objectexperiments:Experiment\[]Array of experiment records.Experimentid:stringUnique experiment ID.name?:stringDisplay name.description?:stringDescription.metadata?:Record\<string, unknown>Arbitrary metadata.datasetId:stringID of the parent dataset.datasetVersion:number | nullDataset version used for the experiment.targetType:'agent' | 'workflow' | 'scorer' | 'processor'Type of target used.targetId:stringID of the target used.status:'pending' | 'running' | 'completed' | 'failed'Current status of the experiment.totalItems:numberTotal number of items.succeededCount:numberNumber of successful items.failedCount:numberNumber of failed items.skippedCount:numberNumber of skipped items.startedAt:Date | nullWhen the experiment started.completedAt:Date | nullWhen the experiment completed.createdAt:DateWhen the experiment record was created.updatedAt:DateWhen the experiment record was last updated.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# dataset.listItems()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Lists items in the dataset. When a `version` is specified, returns all items at that version. Otherwise, returns paginated items from the latest version.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
// Paginated list (default: page 0, 20 per page)
|
|
17
|
-
const result = await dataset.listItems();
|
|
18
|
-
|
|
19
|
-
// List with search
|
|
20
|
-
const filtered = await dataset.listItems({ search: "TypeScript", page: 0, perPage: 10 });
|
|
21
|
-
|
|
22
|
-
// List all items at a specific version
|
|
23
|
-
const versionedItems = await dataset.listItems({ version: 2 });
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Parameters
|
|
27
|
-
|
|
28
|
-
**version?:** (`number`): Dataset version to list items at. When set, returns all items at that version (no pagination).
|
|
29
|
-
|
|
30
|
-
**page?:** (`number`): Page number for pagination. Defaults to \`0\`.
|
|
31
|
-
|
|
32
|
-
**perPage?:** (`number`): Number of items per page. Defaults to \`20\`.
|
|
33
|
-
|
|
34
|
-
**search?:** (`string`): Search string to filter items.
|
|
35
|
-
|
|
36
|
-
## Returns
|
|
37
|
-
|
|
38
|
-
When `version` is specified:
|
|
39
|
-
|
|
40
|
-
**result:** (`Promise<DatasetItem[]>`): Array of all items at the specified dataset version.
|
|
41
|
-
|
|
42
|
-
When `version` is not specified:
|
|
43
|
-
|
|
44
|
-
**result:** (`Promise<object>`): objectitems:DatasetItem\[]Array of items for the current page.pagination:objectPagination metadata.objecttotal:numberTotal number of items.page:numberCurrent page number.perPage:number | falseItems per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# dataset.listVersions()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Lists all versions of the dataset with pagination.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
const { versions, pagination } = await dataset.listVersions({ page: 0, perPage: 10 });
|
|
17
|
-
|
|
18
|
-
for (const version of versions) {
|
|
19
|
-
console.log(`Version ${version.version} created at ${version.createdAt}`);
|
|
20
|
-
}
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Parameters
|
|
24
|
-
|
|
25
|
-
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
26
|
-
|
|
27
|
-
**perPage?:** (`number`): Number of versions per page. Defaults to \`20\`.
|
|
28
|
-
|
|
29
|
-
## Returns
|
|
30
|
-
|
|
31
|
-
**result:** (`Promise<object>`): objectversions:DatasetVersion\[]Array of version records.DatasetVersionid:stringUnique identifier of the version record.datasetId:stringID of the parent dataset.version:numberVersion number.createdAt:DateWhen this version was created.pagination:objectPagination metadata.objecttotal:numberTotal number of versions.page:numberCurrent page number.perPage:number | falseVersions per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
# dataset.startExperiment()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Runs an experiment on the dataset and waits for completion. Executes all items against a target (agent, workflow, or scorer) with optional scoring.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
// Run against a registered agent with scorers
|
|
17
|
-
const summary = await dataset.startExperiment({
|
|
18
|
-
targetType: "agent",
|
|
19
|
-
targetId: "my-agent",
|
|
20
|
-
scorers: ["accuracy", "relevancy"],
|
|
21
|
-
maxConcurrency: 10,
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
console.log(`${summary.succeededCount}/${summary.totalItems} succeeded`);
|
|
25
|
-
console.log(`Status: ${summary.status}`);
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## Parameters
|
|
29
|
-
|
|
30
|
-
**targetType?:** (`'agent' | 'workflow' | 'scorer'`): Type of registered target to run items against. Use with \`targetId\`.
|
|
31
|
-
|
|
32
|
-
**targetId?:** (`string`): ID of the registered target. Use with \`targetType\`.
|
|
33
|
-
|
|
34
|
-
**scorers?:** (`(MastraScorer | string)[]`): Scorers to evaluate each result. Pass \`MastraScorer\` instances or registered scorer IDs.
|
|
35
|
-
|
|
36
|
-
**name?:** (`string`): Display name for the experiment.
|
|
37
|
-
|
|
38
|
-
**description?:** (`string`): Description of the experiment.
|
|
39
|
-
|
|
40
|
-
**metadata?:** (`Record<string, unknown>`): Arbitrary metadata for the experiment.
|
|
41
|
-
|
|
42
|
-
**version?:** (`number`): Pin to a specific dataset version. Defaults to the latest version.
|
|
43
|
-
|
|
44
|
-
**maxConcurrency?:** (`number`): Maximum concurrent item executions. Defaults to \`5\`.
|
|
45
|
-
|
|
46
|
-
**signal?:** (`AbortSignal`): AbortSignal for cancelling the experiment.
|
|
47
|
-
|
|
48
|
-
**itemTimeout?:** (`number`): Per-item execution timeout in milliseconds.
|
|
49
|
-
|
|
50
|
-
**maxRetries?:** (`number`): Maximum retries per item on failure. Defaults to \`0\` (no retries). Abort errors are never retried.
|
|
51
|
-
|
|
52
|
-
## Returns
|
|
53
|
-
|
|
54
|
-
**result:** (`Promise<ExperimentSummary>`): ExperimentSummaryexperimentId:stringUnique ID of the experiment.status:'pending' | 'running' | 'completed' | 'failed'Final status of the experiment.totalItems:numberTotal number of items in the dataset.succeededCount:numberNumber of items that succeeded.failedCount:numberNumber of items that failed.skippedCount:numberNumber of items skipped (e.g., due to abort).completedWithErrors:boolean\`true\` if the run completed but some items failed.startedAt:DateWhen the experiment started.completedAt:DateWhen the experiment completed.results:ItemWithScores\[]All item results with their scores.ItemWithScoresitemId:stringID of the dataset item.itemVersion:numberDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target, or \`null\` if failed.groundTruth:unknown | nullExpected output from the dataset item.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen item execution started.completedAt:DateWhen item execution completed.retryCount:numberNumber of retry attempts.scores:ScorerResult\[]Results from all scorers for this item.ScorerResultscorerId:stringID of the scorer.scorerName:stringDisplay name of the scorer.score:number | nullComputed score, or \`null\` if the scorer failed.reason:string | nullReason/explanation for the score.error:string | nullError message if the scorer failed.
|
|
55
|
-
|
|
56
|
-
## Related
|
|
57
|
-
|
|
58
|
-
- [dataset.startExperimentAsync()](https://mastra.ai/reference/datasets/startExperimentAsync)
|
|
59
|
-
- [dataset.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)
|
|
60
|
-
- [DatasetsManager.compareExperiments()](https://mastra.ai/reference/datasets/compareExperiments)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
# dataset.startExperimentAsync()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Starts an experiment asynchronously (fire-and-forget). Returns immediately with the experiment ID and a `'pending'` status. The experiment runs in the background.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
// Start experiment without waiting
|
|
17
|
-
const { experimentId, status } = await dataset.startExperimentAsync({
|
|
18
|
-
targetType: "agent",
|
|
19
|
-
targetId: "my-agent",
|
|
20
|
-
scorers: ["accuracy"],
|
|
21
|
-
});
|
|
22
|
-
|
|
23
|
-
console.log(`Experiment ${experimentId} started with status: ${status}`);
|
|
24
|
-
|
|
25
|
-
// Check progress later
|
|
26
|
-
const experiment = await dataset.getExperiment({ experimentId });
|
|
27
|
-
console.log(`Current status: ${experiment.status}`);
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## Parameters
|
|
31
|
-
|
|
32
|
-
Takes the same `StartExperimentConfig` as [`dataset.startExperiment()`](https://mastra.ai/reference/datasets/startExperiment).
|
|
33
|
-
|
|
34
|
-
## Returns
|
|
35
|
-
|
|
36
|
-
**result:** (`Promise<object>`): objectexperimentId:stringUnique ID of the created experiment.status:'pending'Always \`'pending'\` since the experiment hasn't started executing yet.
|
|
37
|
-
|
|
38
|
-
## Related
|
|
39
|
-
|
|
40
|
-
- [dataset.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
|
|
41
|
-
- [dataset.getExperiment()](https://mastra.ai/reference/datasets/getExperiment)
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# dataset.update()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Updates dataset metadata, name, description, and/or schemas. Zod schemas are automatically converted to JSON Schema.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
import { z } from "zod";
|
|
12
|
-
|
|
13
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
14
|
-
|
|
15
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
16
|
-
|
|
17
|
-
// Update with plain metadata
|
|
18
|
-
const updated = await dataset.update({
|
|
19
|
-
name: "Updated QA pairs",
|
|
20
|
-
description: "Revised evaluation set",
|
|
21
|
-
});
|
|
22
|
-
|
|
23
|
-
// Update with Zod schema (auto-converted to JSON Schema)
|
|
24
|
-
const updated2 = await dataset.update({
|
|
25
|
-
inputSchema: z.object({
|
|
26
|
-
question: z.string(),
|
|
27
|
-
context: z.string().optional(),
|
|
28
|
-
}),
|
|
29
|
-
});
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Parameters
|
|
33
|
-
|
|
34
|
-
**name?:** (`string`): New display name.
|
|
35
|
-
|
|
36
|
-
**description?:** (`string`): New description.
|
|
37
|
-
|
|
38
|
-
**metadata?:** (`Record<string, unknown>`): Updated metadata.
|
|
39
|
-
|
|
40
|
-
**inputSchema?:** (`unknown`): JSON Schema or Zod schema for item inputs.
|
|
41
|
-
|
|
42
|
-
**groundTruthSchema?:** (`unknown`): JSON Schema or Zod schema for item ground truths.
|
|
43
|
-
|
|
44
|
-
## Returns
|
|
45
|
-
|
|
46
|
-
**result:** (`Promise<DatasetRecord>`): The updated dataset record. See dataset.getDetails() for the full shape.
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# dataset.updateItem()
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
-
|
|
5
|
-
Updates an existing item in the dataset. Only the provided fields are updated. Updating an item creates a new version.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
|
|
12
|
-
const mastra = new Mastra({ /* storage config */ });
|
|
13
|
-
|
|
14
|
-
const dataset = await mastra.datasets.get({ id: "dataset-id" });
|
|
15
|
-
|
|
16
|
-
const updated = await dataset.updateItem({
|
|
17
|
-
itemId: "item-id",
|
|
18
|
-
input: { question: "What is TypeScript?" },
|
|
19
|
-
groundTruth: { answer: "A typed superset of JavaScript" },
|
|
20
|
-
metadata: { reviewed: true },
|
|
21
|
-
});
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## Parameters
|
|
25
|
-
|
|
26
|
-
**itemId:** (`string`): ID of the item to update.
|
|
27
|
-
|
|
28
|
-
**input?:** (`unknown`): Updated input data.
|
|
29
|
-
|
|
30
|
-
**groundTruth?:** (`unknown`): Updated ground truth.
|
|
31
|
-
|
|
32
|
-
**metadata?:** (`Record<string, unknown>`): Updated metadata.
|
|
33
|
-
|
|
34
|
-
## Returns
|
|
35
|
-
|
|
36
|
-
**result:** (`Promise<DatasetItem>`): The updated dataset item. See dataset.addItem() for the item shape.
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# CloudflareDeployer
|
|
2
|
-
|
|
3
|
-
The `CloudflareDeployer` bundles your Mastra server and generates a `wrangler.jsonc` file conforming to Cloudflare's [wrangler configuration](https://developers.cloudflare.com/workers/wrangler/configuration/). Cloudflare deploys this as a Cloudflare Worker.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
To use `CloudflareDeployer`, install the `@mastra/deployer-cloudflare` package:
|
|
8
|
-
|
|
9
|
-
**npm**:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
npm install @mastra/deployer-cloudflare@latest
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
**pnpm**:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
pnpm add @mastra/deployer-cloudflare@latest
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
**Yarn**:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
yarn add @mastra/deployer-cloudflare@latest
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
**Bun**:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
bun add @mastra/deployer-cloudflare@latest
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Usage example
|
|
34
|
-
|
|
35
|
-
Import `CloudflareDeployer` and set it as the deployer in your Mastra configuration:
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
import { Mastra } from "@mastra/core";
|
|
39
|
-
import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
|
|
40
|
-
|
|
41
|
-
export const mastra = new Mastra({
|
|
42
|
-
deployer: new CloudflareDeployer({
|
|
43
|
-
name: "your-project-name",
|
|
44
|
-
routes: [
|
|
45
|
-
{
|
|
46
|
-
pattern: "example.com/*",
|
|
47
|
-
zone_name: "example.com",
|
|
48
|
-
custom_domain: true
|
|
49
|
-
}
|
|
50
|
-
],
|
|
51
|
-
vars: {
|
|
52
|
-
NODE_ENV: "production",
|
|
53
|
-
API_KEY: "<api-key>"
|
|
54
|
-
},
|
|
55
|
-
d1_databases: [
|
|
56
|
-
{
|
|
57
|
-
binding: "DB",
|
|
58
|
-
database_name: "my-database",
|
|
59
|
-
database_id: "d1-database-id",
|
|
60
|
-
preview_database_id: "your-preview-database-id"
|
|
61
|
-
}
|
|
62
|
-
],
|
|
63
|
-
kv_namespaces: [
|
|
64
|
-
{
|
|
65
|
-
binding: "CACHE",
|
|
66
|
-
id: "kv-namespace-id"
|
|
67
|
-
}
|
|
68
|
-
]
|
|
69
|
-
})
|
|
70
|
-
});
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Constructor options
|
|
74
|
-
|
|
75
|
-
The `CloudflareDeployer` constructor accepts the same configuration options as `wrangler.jsonc`. See the [Wrangler configuration documentation](https://developers.cloudflare.com/workers/wrangler/configuration/) for all available options.
|
|
76
|
-
|
|
77
|
-
## Build output
|
|
78
|
-
|
|
79
|
-
After running `mastra build`, the deployer generates a `wrangler.jsonc` file conforming to Cloudflare's [wrangler configuration](https://developers.cloudflare.com/workers/wrangler/configuration/). It points to files inside `.mastra/output` so you need to run `mastra build` before deploying with Wrangler.
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
# NetlifyDeployer
|
|
2
|
-
|
|
3
|
-
The `NetlifyDeployer` class handles packaging, configuration, and deployment by adapting Mastra's output to create an optimized version of your server. It extends the base [`Deployer`](https://mastra.ai/reference/deployer) class with Netlify specific functionality. It enables you to run Mastra within Netlify functions.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
In order to use `NetlifyDeployer`, you need to install the `@mastra/deployer-netlify` package:
|
|
8
|
-
|
|
9
|
-
**npm**:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
npm install @mastra/deployer-netlify@latest
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
**pnpm**:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
pnpm add @mastra/deployer-netlify@latest
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
**Yarn**:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
yarn add @mastra/deployer-netlify@latest
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
**Bun**:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
bun add @mastra/deployer-netlify@latest
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Usage example
|
|
34
|
-
|
|
35
|
-
Import `NetlifyDeployer` and set it as the deployer in your Mastra configuration:
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
import { Mastra } from "@mastra/core";
|
|
39
|
-
import { NetlifyDeployer } from "@mastra/deployer-netlify";
|
|
40
|
-
|
|
41
|
-
export const mastra = new Mastra({
|
|
42
|
-
deployer: new NetlifyDeployer(),
|
|
43
|
-
});
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Output
|
|
47
|
-
|
|
48
|
-
After running `mastra build`, the deployer generates a `.netlify` folder. The build output includes all agents, tools, and workflows of your project, alongside a special `config.json` file. The `config.json` file configures the behavior of Netlify functions.
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
your-project/
|
|
52
|
-
└── .netlify/
|
|
53
|
-
└── v1/
|
|
54
|
-
├── config.json
|
|
55
|
-
└── functions/
|
|
56
|
-
└── api/
|
|
57
|
-
├── index.mjs
|
|
58
|
-
├── package.json
|
|
59
|
-
└── node_modules/
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
The `config.json` file contains:
|
|
63
|
-
|
|
64
|
-
```json
|
|
65
|
-
{
|
|
66
|
-
"functions": {
|
|
67
|
-
"directory": ".netlify/v1/functions",
|
|
68
|
-
"node_bundler": "none",
|
|
69
|
-
"included_files": [
|
|
70
|
-
".netlify/v1/functions/**"
|
|
71
|
-
]
|
|
72
|
-
},
|
|
73
|
-
"redirects": [
|
|
74
|
-
{
|
|
75
|
-
"force": true,
|
|
76
|
-
"from": "/*",
|
|
77
|
-
"to": "/.netlify/functions/api/:splat",
|
|
78
|
-
"status": 200
|
|
79
|
-
}
|
|
80
|
-
]
|
|
81
|
-
}
|
|
82
|
-
```
|
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
# VercelDeployer
|
|
2
|
-
|
|
3
|
-
The `VercelDeployer` bundles your Mastra server and generates output conforming to Vercel's [Build Output API](https://vercel.com/docs/build-output-api/v3). Vercel deploys this output directly as serverless functions.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
To use `VercelDeployer`, install the `@mastra/deployer-vercel` package:
|
|
8
|
-
|
|
9
|
-
**npm**:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
npm install @mastra/deployer-vercel@latest
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
**pnpm**:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
pnpm add @mastra/deployer-vercel@latest
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
**Yarn**:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
yarn add @mastra/deployer-vercel@latest
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
**Bun**:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
bun add @mastra/deployer-vercel@latest
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Usage example
|
|
34
|
-
|
|
35
|
-
Import `VercelDeployer` and set it as the deployer in your Mastra configuration:
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
import { Mastra } from "@mastra/core";
|
|
39
|
-
import { VercelDeployer } from "@mastra/deployer-vercel";
|
|
40
|
-
|
|
41
|
-
export const mastra = new Mastra({
|
|
42
|
-
deployer: new VercelDeployer(),
|
|
43
|
-
});
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Constructor options
|
|
47
|
-
|
|
48
|
-
The deployer accepts overrides that are written to the Vercel Output API function config (`.vc-config.json`):
|
|
49
|
-
|
|
50
|
-
- `maxDuration?: number` — Function execution timeout (in seconds)
|
|
51
|
-
- `memory?: number` — Function memory (in MB)
|
|
52
|
-
- `regions?: string[]` — Regions to deploy the function (e.g. `['sfo1','iad1']`)
|
|
53
|
-
|
|
54
|
-
These options are merged into `.vercel/output/functions/index.func/.vc-config.json` while preserving default fields (`handler`, `launcherType`, `runtime`, `shouldAddHelpers`).
|
|
55
|
-
|
|
56
|
-
### Example with overrides
|
|
57
|
-
|
|
58
|
-
```typescript
|
|
59
|
-
import { Mastra } from "@mastra/core";
|
|
60
|
-
import { VercelDeployer } from "@mastra/deployer-vercel";
|
|
61
|
-
|
|
62
|
-
export const mastra = new Mastra({
|
|
63
|
-
deployer: new VercelDeployer({
|
|
64
|
-
maxDuration: 600,
|
|
65
|
-
memory: 1536,
|
|
66
|
-
regions: ["sfo1", "iad1"],
|
|
67
|
-
}),
|
|
68
|
-
});
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## Build output
|
|
72
|
-
|
|
73
|
-
After running `mastra build`, the deployer generates a `.vercel/output` directory conforming to Vercel's [Build Output API (v3)](https://vercel.com/docs/build-output-api/v3). This directory contains routing configuration and serverless function bundles that Vercel deploys directly, bypassing framework detection.
|
|
74
|
-
|
|
75
|
-
The output contains:
|
|
76
|
-
|
|
77
|
-
- **config.json** — Routing configuration that directs all requests to your function
|
|
78
|
-
- **functions/** — Your Mastra server bundled as a serverless function
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
.vercel/
|
|
82
|
-
└── output/
|
|
83
|
-
├── config.json
|
|
84
|
-
└── functions/
|
|
85
|
-
└── index.func/
|
|
86
|
-
├── .vc-config.json
|
|
87
|
-
├── index.mjs
|
|
88
|
-
└── node_modules/
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
This folder is generated during build and should not be committed to version control.
|
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
# Deployer
|
|
2
|
-
|
|
3
|
-
The Deployer handles the deployment of standalone Mastra applications by packaging code, managing environment files, and serving applications using the Hono framework. Concrete implementations must define the deploy method for specific deployment targets.
|
|
4
|
-
|
|
5
|
-
## Usage Example
|
|
6
|
-
|
|
7
|
-
If you want to create a custom deployer, you can extend the abstract `Deployer` class and implement the `deploy` method with your specific deployment logic. Here's an example:
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Deployer } from "@mastra/deployer";
|
|
11
|
-
|
|
12
|
-
class CustomDeployer extends Deployer {
|
|
13
|
-
constructor() {
|
|
14
|
-
super({ name: "custom-deployer" });
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
async deploy(outputDirectory: string): Promise<void> {
|
|
18
|
-
// Prepare the output directory
|
|
19
|
-
await this.prepare(outputDirectory);
|
|
20
|
-
|
|
21
|
-
// Bundle the application
|
|
22
|
-
await this._bundle("server.ts", "mastra.ts", outputDirectory);
|
|
23
|
-
|
|
24
|
-
// Custom deployment logic
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Parameters
|
|
30
|
-
|
|
31
|
-
### Constructor Parameters
|
|
32
|
-
|
|
33
|
-
**args:** (`object`): Configuration options for the Deployer.
|
|
34
|
-
|
|
35
|
-
**args.name:** (`string`): A unique name for the deployer instance.
|
|
36
|
-
|
|
37
|
-
### deploy Parameters
|
|
38
|
-
|
|
39
|
-
**outputDirectory:** (`string`): The directory where the bundled and deployment-ready application will be output.
|
|
40
|
-
|
|
41
|
-
## Methods
|
|
42
|
-
|
|
43
|
-
**getEnvFiles:** (`() => Promise<string[]>`): Returns a list of environment files to be used during deployment. By default, it looks for '.env.production' and '.env' files.
|
|
44
|
-
|
|
45
|
-
**deploy:** (`(outputDirectory: string) => Promise<void>`): Abstract method that must be implemented by subclasses. Handles the deployment process to the specified output directory.
|
|
46
|
-
|
|
47
|
-
## Inherited Methods from Bundler
|
|
48
|
-
|
|
49
|
-
The Deployer class inherits the following key methods from the Bundler class:
|
|
50
|
-
|
|
51
|
-
**prepare:** (`(outputDirectory: string) => Promise<void>`): Prepares the output directory by cleaning it and creating necessary subdirectories.
|
|
52
|
-
|
|
53
|
-
**writePackageJson:** (`(outputDirectory: string, dependencies: Map<string, string>) => Promise<void>`): Generates a package.json file in the output directory with the specified dependencies.
|
|
54
|
-
|
|
55
|
-
**\_bundle:** (`(serverFile: string, mastraEntryFile: string, outputDirectory: string, bundleLocation?: string) => Promise<void>`): Bundles the application using the specified server and Mastra entry files.
|
|
56
|
-
|
|
57
|
-
## Core Concepts
|
|
58
|
-
|
|
59
|
-
### Deployment Lifecycle
|
|
60
|
-
|
|
61
|
-
The Deployer abstract class implements a structured deployment lifecycle:
|
|
62
|
-
|
|
63
|
-
1. **Initialization**: The deployer is initialized with a name and creates a Deps instance for dependency management.
|
|
64
|
-
2. **Environment Setup**: The `getEnvFiles` method identifies environment files (.env.production, .env) to be used during deployment.
|
|
65
|
-
3. **Preparation**: The `prepare` method (inherited from Bundler) cleans the output directory and creates necessary subdirectories.
|
|
66
|
-
4. **Bundling**: The `_bundle` method (inherited from Bundler) packages the application code and its dependencies.
|
|
67
|
-
5. **Deployment**: The abstract `deploy` method is implemented by subclasses to handle the actual deployment process.
|
|
68
|
-
|
|
69
|
-
### Environment File Management
|
|
70
|
-
|
|
71
|
-
The Deployer class includes built-in support for environment file management through the `getEnvFiles` method. This method:
|
|
72
|
-
|
|
73
|
-
- Looks for environment files in a predefined order (.env.production, .env)
|
|
74
|
-
- Uses the FileService to find the first existing file
|
|
75
|
-
- Returns an array of found environment files
|
|
76
|
-
- Returns an empty array if no environment files are found
|
|
77
|
-
|
|
78
|
-
```typescript
|
|
79
|
-
getEnvFiles(): Promise<string[]> {
|
|
80
|
-
const possibleFiles = ['.env.production', '.env.local', '.env'];
|
|
81
|
-
|
|
82
|
-
try {
|
|
83
|
-
const fileService = new FileService();
|
|
84
|
-
const envFile = fileService.getFirstExistingFile(possibleFiles);
|
|
85
|
-
|
|
86
|
-
return Promise.resolve([envFile]);
|
|
87
|
-
} catch {}
|
|
88
|
-
|
|
89
|
-
return Promise.resolve([]);
|
|
90
|
-
}
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
### Bundling and Deployment Relationship
|
|
94
|
-
|
|
95
|
-
The Deployer class extends the Bundler class, establishing a clear relationship between bundling and deployment:
|
|
96
|
-
|
|
97
|
-
1. **Bundling as a Prerequisite**: Bundling is a prerequisite step for deployment, where the application code is packaged into a deployable format.
|
|
98
|
-
2. **Shared Infrastructure**: Both bundling and deployment share common infrastructure like dependency management and file system operations.
|
|
99
|
-
3. **Specialized Deployment Logic**: While bundling focuses on code packaging, deployment adds environment-specific logic for deploying the bundled code.
|
|
100
|
-
4. **Extensibility**: The abstract `deploy` method allows for creating specialized deployers for different target environments.
|