Skip to Content
リファレンスエージェントgetVoice()

Agent.getVoice()

getVoice()メソッドは、エージェントに設定された音声プロバイダーを取得し、それが関数の場合は解決します。このメソッドは、テキスト読み上げや音声認識機能のためにエージェントの音声機能にアクセスするために使用されます。

構文

getVoice({ runtimeContext }: { runtimeContext?: RuntimeContext } = {}): CompositeVoice | Promise<CompositeVoice>

パラメーター


runtimeContext?:

RuntimeContext
依存性注入やコンテキスト情報のためのランタイムコンテキスト。指定されていない場合は、新しい RuntimeContext インスタンスがデフォルトで使用されます。

戻り値

CompositeVoiceインスタンスまたはCompositeVoiceインスタンスに解決されるPromiseを返します。エージェントに音声プロバイダーが設定されていない場合は、デフォルトの音声プロバイダーを返します。

説明

getVoice() メソッドは、エージェントの音声機能にアクセスするために使用されます。このメソッドは、音声プロバイダーを解決します。音声プロバイダーは、直接指定することも、関数から返されることもあります。

音声プロバイダーによって以下が可能になります：

  • テキストを音声に変換する（発話）
  • 音声をテキストに変換する（聞き取り）
  • 利用可能なスピーカーや音声の取得

例

基本的な使い方

import { Agent } from "@mastra/core/agent";
import { ElevenLabsVoice } from "@mastra/voice-elevenlabs";
import { openai } from "@ai-sdk/openai";
 
// Create an agent with a voice provider
const agent = new Agent({
  name: "voice-assistant",
  instructions: "You are a helpful voice assistant.",
  model: openai("gpt-4o"),
  voice: new ElevenLabsVoice({
    apiKey: process.env.ELEVENLABS_API_KEY,
  }),
});
 
// Get the voice provider
const voice = await agent.getVoice();
 
// Use the voice provider for text-to-speech
const audioStream = await voice.speak("Hello, how can I help you today?");
 
// Use the voice provider for speech-to-text
const transcription = await voice.listen(audioStream);
 
// Get available speakers
const speakers = await voice.getSpeakers();
console.log(speakers);

RuntimeContextとの併用

import { Agent } from "@mastra/core/agent";
import { ElevenLabsVoice } from "@mastra/voice-elevenlabs";
import { RuntimeContext } from "@mastra/core/runtime-context";
import { openai } from "@ai-sdk/openai";
 
// Create an agent with a dynamic voice provider
const agent = new Agent({
  name: "voice-assistant",
  instructions: ({ runtimeContext }) => {
    // Dynamic instructions based on runtime context
    const instructions = runtimeContext.get("preferredVoiceInstructions");
    return instructions || "You are a helpful voice assistant.";
  },
  model: openai("gpt-4o"),
  voice: new ElevenLabsVoice({
    apiKey: process.env.ELEVENLABS_API_KEY,
  }),
});
 
// Create a runtime context with preferences
const context = new RuntimeContext();
context.set("preferredVoiceInstructions", "You are an evil voice assistant");
 
// Get the voice provider using the runtime context
const voice = await agent.getVoice({ runtimeContext: context });
 
// Use the voice provider
const audioStream = await voice.speak("Hello, how can I help you today?");
getWorkflows()getInstructions()