第3章 参考文档

参考

参考章节提供 Mastra API 的文档，包括参数、类型以及使用示例。

AcpAgent createACPTool() AgentController Class Session Class Agent Class Channels createInngestAgent() createSkill() Durable Agent.generate() .generateLegacy() .getDefaultGenerateOptions Legacy() .getDefaultOptions() .getDefaultStreamOptions Legacy() .getDescription() .getInstructions() .getLLM() .getMemory() .getMetadata() .getModel() .getSkill() .getTools() .getVoice() .listAgents() .listScorers() .listSkills() .listSuspendedRuns() .listTools() .listWorkflows() .network() Overview chatRoute() handleChatStream() handleNetworkStream() handleWorkflowStream() networkRoute() toAISdkMessages() toAISdkStream() toAISdkV4Messages() toAISdkV5Messages() withMastra() withSseHeartbeat() workflowRoute() workflowSnapshotToStream()

Auth0 Better Auth Clerk Fine-Grained Authorization Firebase Google JSON Web Token Neon Okta Supabase WorkOS

Agent Browser Browser Viewer FirecrawlBrowser MastraBrowser Class Stagehand Browser Channel Provider Slack Provider Teams Provider Telegram Provider Classifier create-mastra mastra

Agent Controller API Agents API Conversations API Datasets API Error Handling Logs API Mastra Client SDK Memory API Observability API Responses API Tools API Vectors API Workflows API

ACP server mountAgentControllerOnMastra() buildBasePrompt() createCodingAgent() channels() credential() Provider tools tools()

Mastra Class Mastra Model Gateway .addDynamicWorkflow() .addDynamicWorkflows() .addGateway() .getAgent() .getAgentById() .getClassifier() .getClassifierById() .getDeployer() .getEditor() .getGateway() .getGatewayById() .getLogger() .getMCPServer() .getMCPServerById() .getMemory() .getScorer() .getScorerById() .getServer() .getStorage() .getTool() .getToolById() .getVector() .getWorkflow() .listAgents() .listClassifiers() .listGateways() .listLogs() .listLogsByRunId() .listMCPServers() .listMemory() .listScorers() .listTools() .listVectors() .listWorkflows() .removeWorkspace() .setLogger() .setStorage()

Cloudflare Deployer Netlify Vercel

BlobStore Provider

Mastra Editor Class Processor Provider Prompt blocks Tool configuration Tool Provider Versioning

Browser Provider Storage Browser Ref Filesystem Provider Sandbox Provider Storage Workspace Ref createClassifier Scorer() createScorer() filterRun() Mastra Scorer notScorable() Quick Checks runEvals() Scorer Utils Answer Relevancy Scorer Answer Similarity Scorer Bias Completeness Content Similarity Scorer Context Precision Scorer Context Recall Scorer Context Relevance Scorer Faithfulness Hallucination Keyword Coverage Scorer Multi-turn Judge Scorer Noise Sensitivity Scorer Prompt Alignment Scorer Rubric Scorer Summarization Scorer Textual Difference Scorer Tone Consistency Scorer Tool Call Accuracy Scorers Toxicity Trajectory Accuracy Scorers

Dataset Class Datasets Manager Class .addItem() .addItems() .compareExperiments() .create() .createExperiment() .delete() .deleteExperiment() .deleteItem() .deleteItems() .finalizeExperiment() .get() .getDetails() .getExperiment() .getItem() .getItemHistory() .list() .listExperimentResults() .listExperiments() .listItems() .listVersions() .purgeItem() .runExperimentItem() .startExperiment() .startExperimentAsync() .submitExperimentResult() .update() .updateExperiment() .updateItem()

config.ts Instructions Logger Memory Observability Processors Schedules Scorers Server Skills Storage Studio Subagents Tools Workflows Workspace Cloned Thread Utilities

Memory Class Observational Memory Serialized Memory Config summarizeConversation() .cloneThread() .copyThread() .createThread() .deleteMessages() .getThreadById() .listThreads() .recall() .settled() .summarizeThread() .updateThreadResourceId()

@mastra/mcp v1 to v2 AgentNetwork to .network() AI SDK v4 to v5 Mastra Cloud to Mastra platform VNext to Standard APIs .network() to Supervisor Agents Overview Agents CLI Client SDK Deployment Evals Mastra MCP Memory Processors RAG Storage Tools Tracing Vectors Voice Workflows Feedback Pino Logger Automatic Metrics Metric queries Configuration Advanced trace queries Instances Interfaces Span filtering Spans Agents MD Injector Batch Parts Processor Classifier Processor Cyber Refusal Handler FileUpload Processor Language Detector Memory Input Filter Message History Model Selection Processor Moderation Processor PII Detector Prefill Error Handler Processor Interface Prompt Injection Detector Provider History Compat Regex Filter Processor Response Cache Semantic Recall Skill Search Processor Stream Error Retry Processor System Prompt Scrubber Token Cost Control Token Limiter Processor Tool Call Filter Tool Search Processor Unicode Normalizer Unsupported File Handler Working Memory Caching Pub Sub Event Emitter Pub Sub Google Cloud Pub Sub Lease Provider Pub Sub Redis Streams Pub Sub Unix Socket Pub Sub Valkey Streams Pub Sub Overview Chunking and Embedding Database Config Embed Extract Params Graph RAG Graph RAG Guide MDocument Metadata Filters rerank() rerankWithScorer() Retrieval Vector Databases .chunk() Overview createRoute() Elysia Adapter Express Adapter Fastify Adapter Hono Adapter Koa Adapter Mastra Server Nest JS Adapter Next.js Adapter registerApiRoute() Server Routes TanStack Start Adapter createNotificationInboxTool() Signal Provider Task Signal Provider Webhook Signal Provider Overview Composite Storage Retention (prune) Turso Storage Chunk Types smoothStream() Mastra Model Output .stream() .streamLegacy() .streamUntilIdle() .observeStream() .resumeStream() .stream() .timeTravelStream() Overview askUserTool createBedrockKBTool() createCodeMode() createDocumentChunkerTool() createGraphRAGTool() createTool() createVectorQueryTool() Isolated Vm Code Mode Transport MCP Client MCP Server QuickJs Code Mode Transport submitPlanTool Task tools Amazon S3 Vector Store Astra Vector Store Azure AI Search Vector Store Chroma Vector Store Cloudflare Vector Store Convex Vector Store Couchbase Vector Store Duck DB Vector Store Elastic Search Vector Store Lance Vector Store lib SQL Vector Store Mongo DB Vector Store Open Search Vector Store Oracle DB Vector Store PG Vector Store Pinecone Vector Store Qdrant Vector Store Turbopuffer Vector Store Upstash Vector Store Weaviate Vector Store Overview Composite Voice Events Mastra Voice Speech to Speech Speech to Text Text to Speech .addInstructions() .addTools() .answer() .close() .connect() .getSpeakers() .listen() .off() .on() .send() .speak() .updateConfig() Overview Dynamic Workflow Definition Run Class Step Class Workflow Class Workflow State Reader .agent() .branch() .classifier() .commit() .createRun() .dountil() .dowhile() .foreach() .map() .parallel() .sleep() .sleepUntil() .then() .tool() .cancel() .restart() .resume() .start() .startAsync() .timeTravel() Local Filesystem Local Sandbox Platform Filesystem Platform Sandbox Sandbox Process Manager Workspace Class Workspace Filesystem Workspace Sandbox