PlayAI

L'implémentation vocale PlayAI de Mastra fournit des fonctionnalités de synthèse vocale au moyen de l'API PlayAI.

Exemple d'utilisation

import { PlayAIVoice } from '@mastra/voice-playai'

// Initialize with default configuration (uses PLAYAI_API_KEY environment variable and PLAYAI_USER_ID environment variable)
const voice = new PlayAIVoice()

// Initialize with default configuration
const voice = new PlayAIVoice({
  speechModel: {
    name: 'PlayDialog',
    apiKey: process.env.PLAYAI_API_KEY,
    userId: process.env.PLAYAI_USER_ID,
  },
  speaker: 'Angelo', // Default voice
})

// Convert text to speech with a specific voice
const audioStream = await voice.speak('Hello, world!', {
  speaker:
    's3://voice-cloning-zero-shot/b27bc13e-996f-4841-b584-4d35801aea98/original/manifest.json', // Dexter voice
})

Paramètres du constructeur

speechModel?:

PlayAIConfig

= { name: 'PlayDialog' }

Configuration de la fonctionnalité de synthèse vocale

PlayAIConfig

name?:

'PlayDialog' | 'Play3.0-mini'

Modèle PlayAI à utiliser

apiKey?:

string

Clé d'API PlayAI. Utilise par défaut la variable d'environnement PLAYAI_API_KEY

userId?:

string

Identifiant d'utilisateur PlayAI. Utilise par défaut la variable d'environnement PLAYAI_USER_ID

speaker?:

string

= Premier identifiant vocal disponible

Identifiant vocal à utiliser par défaut pour la synthèse vocale

Méthodes

speak()

Convertit du texte en parole au moyen du modèle vocal et de la voix configurés.

input:

string | NodeJS.ReadableStream

Texte à convertir en parole. Si un flux est fourni, il est d'abord converti en texte.

options?:

Options

Options de configuration.

Options

speaker?:

string

Remplace la voix par défaut pour cette requête

Renvoie : Promise<NodeJS.ReadableStream>.

getSpeakers()

Renvoie un tableau des options vocales disponibles, dans lequel chaque élément contient :

name:

string

Nom de la voix

accent:

string

Accent de la voix (par exemple, 'US', 'British', 'Australian')

gender:

'M' | 'F'

Genre de la voix

age:

'Young' | 'Middle' | 'Old'

Catégorie d'âge de la voix

style:

'Conversational' | 'Narrative'

Style d'élocution de la voix

voiceId:

string

Identifiant unique de la voix

listen()

Cette méthode n'est pas prise en charge par PlayAI et lève une erreur. PlayAI ne fournit aucune fonctionnalité de reconnaissance vocale.

Remarques

• PlayAI nécessite à la fois une clé d'API et un identifiant d'utilisateur pour l'authentification
• Le service propose deux modèles : 'PlayDialog' et 'Play3.0-mini'
• Chaque voix possède un identifiant de manifeste S3 unique qui doit être utilisé lors des appels à l'API