NVIDIA Riva: ASR and TTS

NVIDIA Riva

NVIDIA Riva is a GPU-accelerated multilingual speech and translation AI software development kit for building fully customizable, real-time conversational AI pipelines—including automatic speech recognition (ASR), text-to-speech (TTS), and neural machine translation (NMT) applications—that can be deployed in clouds, in data centers, at the edge, or on embedded devices.

The Riva Speech API server exposes a simple API for performing speech recognition, speech synthesis, and a variety of natural language processing inferences and is integrated into LangChain for ASR and TTS. See instructions on how to setup a Riva Speech API server below.

Integrating NVIDIA Riva to LangChain Chains

The NVIDIARivaASR, NVIDIARivaTTS utility runnables are LangChain runnables that integrate NVIDIA Riva into LCEL chains for Automatic Speech Recognition (ASR) and Text To Speech (TTS).

This example goes over how to use these LangChain runnables to: 1. Accept streamed audio, 2. convert the audio to text, 3. send the text to an LLM, 4. stream a textual LLM response, and 5. convert the response to streamed human-sounding audio.

1. NVIDIA Riva Runnables

There are 2 Riva Runnables:

RivaASR: Converts audio bytes into text for an LLM using NVIDIA Riva.
RivaTTS: Converts text into audio bytes using NVIDIA Riva.

a. RivaASR

The RivaASR runnable converts audio bytes into a string for an LLM using NVIDIA Riva.

It’s useful for sending an audio stream (a message containing streaming audio) into a chain and preprocessing that audio by converting it to a string to create an LLM prompt.

ASRInputType = AudioStream # the AudioStream type is a custom type for a message queue containing streaming audio
ASROutputType = str

class RivaASR(
    RivaAuthMixin,
    RivaCommonConfigMixin,
    RunnableSerializable[ASRInputType, ASROutputType],
):
    """A runnable that performs Automatic Speech Recognition (ASR) using NVIDIA Riva."""

    name: str = "nvidia_riva_asr"
    description: str = (
        "A Runnable for converting audio bytes to a string."
        "This is useful for feeding an audio stream into a chain and"
        "preprocessing that audio to create an LLM prompt."
    )

    # riva options
    audio_channel_count: int = Field(
        1, description="The number of audio channels in the input audio stream."
    )
    profanity_filter: bool = Field(
        True,
        description=(
            "Controls whether or not Riva should attempt to filter "
            "profanity out of the transcribed text."
        ),
    )
    enable_automatic_punctuation: bool = Field(
        True,
        description=(
            "Controls whether Riva should attempt to correct "
            "senetence puncuation in the transcribed text."
        ),
    )

When this runnable is called on an input, it takes an input audio stream that acts as a queue and concatenates transcription as chunks are returned.After a response is fully generated, a string is returned. * Note that since the LLM requires a full query the ASR is concatenated and not streamed in token-by-token.

b. RivaTTS

The RivaTTS runnable converts text output to audio bytes.

It’s useful for processing the streamed textual response from an LLM by converting the text to audio bytes. These audio bytes sound like a natural human voice to be played back to the user.

TTSInputType = Union[str, AnyMessage, PromptValue]
TTSOutputType = byte

class RivaTTS(
    RivaAuthMixin,
    RivaCommonConfigMixin,
    RunnableSerializable[TTSInputType, TTSOutputType],
):
    """A runnable that performs Text-to-Speech (TTS) with NVIDIA Riva."""

    name: str = "nvidia_riva_tts"
    description: str = (
        "A tool for converting text to speech."
        "This is useful for converting LLM output into audio bytes."
    )

    # riva options
    voice_name: str = Field(
        "English-US.Female-1",
        description=(
            "The voice model in Riva to use for speech. "
            "Pre-trained models are documented in "
            "[the Riva documentation]"
            "(https://docs.nvidia.com/deeplearning/riva/user-guide/docs/tts/tts-overview.html)."
        ),
    )
    output_directory: Optional[str] = Field(
        None,
        description=(
            "The directory where all audio files should be saved. "
            "A null value indicates that wave files should not be saved. "
            "This is useful for debugging purposes."
        ),

When this runnable is called on an input, it takes iterable text chunks and streams them into output audio bytes that are either written to a .wav file or played out loud.

2. Installation

The NVIDIA Riva client library must be installed.

%pip install --upgrade --quiet nvidia-riva-client

Note: you may need to restart the kernel to use updated packages.

3. Setup

To get started with NVIDIA Riva:

Follow the Riva Quick Start setup instructions for Local Deployment Using Quick Start Scripts.

4. Import and Inspect Runnables

Import the RivaASR and RivaTTS runnables and inspect their schemas to understand their fields.

import json

from langchain_community.utilities.nvidia_riva import (
    RivaASR,
    RivaTTS,
)

API Reference:

Let’s view the schemas.

print(json.dumps(RivaASR.schema(), indent=2))
print(json.dumps(RivaTTS.schema(), indent=2))

{
  "title": "RivaASR",
  "description": "A runnable that performs Automatic Speech Recognition (ASR) using NVIDIA Riva.",
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "default": "nvidia_riva_asr",
      "type": "string"
    },
    "encoding": {
      "description": "The encoding on the audio stream.",
      "default": "LINEAR_PCM",
      "allOf": [
        {
          "$ref": "#/definitions/RivaAudioEncoding"
        }
      ]
    },
    "sample_rate_hertz": {
      "title": "Sample Rate Hertz",
      "description": "The sample rate frequency of audio stream.",
      "default": 8000,
      "type": "integer"
    },
    "language_code": {
      "title": "Language Code",
      "description": "The [BCP-47 language code](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) for the target language.",
      "default": "en-US",
      "type": "string"
    },
    "url": {
      "title": "Url",
      "description": "The full URL where the Riva service can be found.",
      "default": "http://localhost:50051",
      "examples": [
        "http://localhost:50051",
        "https://user@pass:riva.example.com"
      ],
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 65536,
          "format": "uri"
        },
        {
          "type": "string"
        }
      ]
    },
    "ssl_cert": {
      "title": "Ssl Cert",
      "description": "A full path to the file where Riva's public ssl key can be read.",
      "type": "string"
    },
    "description": {
      "title": "Description",
      "default": "A Runnable for converting audio bytes to a string.This is useful for feeding an audio stream into a chain andpreprocessing that audio to create an LLM prompt.",
      "type": "string"
    },
    "audio_channel_count": {
      "title": "Audio Channel Count",
      "description": "The number of audio channels in the input audio stream.",
      "default": 1,
      "type": "integer"
    },
    "profanity_filter": {
      "title": "Profanity Filter",
      "description": "Controls whether or not Riva should attempt to filter profanity out of the transcribed text.",
      "default": true,
      "type": "boolean"
    },
    "enable_automatic_punctuation": {
      "title": "Enable Automatic Punctuation",
      "description": "Controls whether Riva should attempt to correct senetence puncuation in the transcribed text.",
      "default": true,
      "type": "boolean"
    }
  },
  "definitions": {
    "RivaAudioEncoding": {
      "title": "RivaAudioEncoding",
      "description": "An enum of the possible choices for Riva audio encoding.\n\nThe list of types exposed by the Riva GRPC Protobuf files can be found\nwith the following commands:\n```python\nimport riva.client\nprint(riva.client.AudioEncoding.keys())  # noqa: T201\n```",
      "enum": [
        "ALAW",
        "ENCODING_UNSPECIFIED",
        "FLAC",
        "LINEAR_PCM",
        "MULAW",
        "OGGOPUS"
      ],
      "type": "string"
    }
  }
}
{
  "title": "RivaTTS",
  "description": "A runnable that performs Text-to-Speech (TTS) with NVIDIA Riva.",
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "default": "nvidia_riva_tts",
      "type": "string"
    },
    "encoding": {
      "description": "The encoding on the audio stream.",
      "default": "LINEAR_PCM",
      "allOf": [
        {
          "$ref": "#/definitions/RivaAudioEncoding"
        }
      ]
    },
    "sample_rate_hertz": {
      "title": "Sample Rate Hertz",
      "description": "The sample rate frequency of audio stream.",
      "default": 8000,
      "type": "integer"
    },
    "language_code": {
      "title": "Language Code",
      "description": "The [BCP-47 language code](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) for the target language.",
      "default": "en-US",
      "type": "string"
    },
    "url": {
      "title": "Url",
      "description": "The full URL where the Riva service can be found.",
      "default": "http://localhost:50051",
      "examples": [
        "http://localhost:50051",
        "https://user@pass:riva.example.com"
      ],
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 65536,
          "format": "uri"
        },
        {
          "type": "string"
        }
      ]
    },
    "ssl_cert": {
      "title": "Ssl Cert",
      "description": "A full path to the file where Riva's public ssl key can be read.",
      "type": "string"
    },
    "description": {
      "title": "Description",
      "default": "A tool for converting text to speech.This is useful for converting LLM output into audio bytes.",
      "type": "string"
    },
    "voice_name": {
      "title": "Voice Name",
      "description": "The voice model in Riva to use for speech. Pre-trained models are documented in [the Riva documentation](https://docs.nvidia.com/deeplearning/riva/user-guide/docs/tts/tts-overview.html).",
      "default": "English-US.Female-1",
      "type": "string"
    },
    "output_directory": {
      "title": "Output Directory",
      "description": "The directory where all audio files should be saved. A null value indicates that wave files should not be saved. This is useful for debugging purposes.",
      "type": "string"
    }
  },
  "definitions": {
    "RivaAudioEncoding": {
      "title": "RivaAudioEncoding",
      "description": "An enum of the possible choices for Riva audio encoding.\n\nThe list of types exposed by the Riva GRPC Protobuf files can be found\nwith the following commands:\n```python\nimport riva.client\nprint(riva.client.AudioEncoding.keys())  # noqa: T201\n```",
      "enum": [
        "ALAW",
        "ENCODING_UNSPECIFIED",
        "FLAC",
        "LINEAR_PCM",
        "MULAW",
        "OGGOPUS"
      ],
      "type": "string"
    }
  }
}

5. Declare Riva ASR and Riva TTS Runnables

For this example, a single-channel audio file (mulaw format, so .wav) is used.

You will need a Riva speech server setup, so if you don’t have a Riva speech server, go to Setup.

a. Set Audio Parameters

Some parameters of audio can be inferred by the mulaw file, but others are set explicitly.

Replace audio_file with the path of your audio file.

import pywav  # pywav is used instead of built-in wave because of mulaw support
from langchain_community.utilities.nvidia_riva import RivaAudioEncoding

audio_file = "./audio_files/en-US_sample2.wav"
wav_file = pywav.WavRead(audio_file)
audio_data = wav_file.getdata()
audio_encoding = RivaAudioEncoding.from_wave_format_code(wav_file.getaudioformat())
sample_rate = wav_file.getsamplerate()
delay_time = 1 / 4
chunk_size = int(sample_rate * delay_time)
delay_time = 1 / 8
num_channels = wav_file.getnumofchannels()

API Reference:

RivaAudioEncoding

import IPython

IPython.display.Audio(audio_file)

b. Set the Speech Server and Declare Riva LangChain Runnables

Be sure to set RIVA_SPEECH_URL to be the URI of your Riva speech server.

The runnables act as clients to the speech server. Many of the fields set in this example are configured based on the sample audio data.

RIVA_SPEECH_URL = "http://localhost:50051/"

riva_asr = RivaASR(
    url=RIVA_SPEECH_URL,  # the location of the Riva ASR server
    encoding=audio_encoding,
    audio_channel_count=num_channels,
    sample_rate_hertz=sample_rate,
    profanity_filter=True,
    enable_automatic_punctuation=True,
    language_code="en-US",
)

riva_tts = RivaTTS(
    url=RIVA_SPEECH_URL,  # the location of the Riva TTS server
    output_directory="./scratch",  # location of the output .wav files
    language_code="en-US",
    voice_name="English-US.Female-1",
)

6. Create Additional Chain Components

As usual, declare the other parts of the chain. In this case, it’s just a prompt template and an LLM.

LangChain compatible NVIDIA LLMs from NVIDIA AI Foundation Endpoints can also be used by following these instructions.

from langchain_core.prompts import PromptTemplate
from langchain_openai import OpenAI

prompt = PromptTemplate.from_template("{user_input}")
llm = OpenAI(openai_api_key="sk-xxx")

API Reference:

Now, tie together all the parts of the chain including RivaASR and RivaTTS.

chain = {"user_input": riva_asr} | prompt | llm | riva_tts

7. Run the Chain with Streamed Inputs and Outputs

a. Mimic Audio Streaming

To mimic streaming, first convert the processed audio data to iterable chunks of audio bytes.

Two functions, producer and consumer, respectively handle asynchronously passing audio data into the chain and consuming audio data out of the chain.

import asyncio

from langchain_community.utilities.nvidia_riva import AudioStream

audio_chunks = [
    audio_data[0 + i : chunk_size + i] for i in range(0, len(audio_data), chunk_size)
]


async def producer(input_stream) -> None:
    """Produces audio chunk bytes into an AudioStream as streaming audio input."""
    for chunk in audio_chunks:
        await input_stream.aput(chunk)
    input_stream.close()


async def consumer(input_stream, output_stream) -> None:
    """
    Consumes audio chunks from input stream and passes them along the chain
    constructed comprised of ASR -> text based prompt for an LLM -> TTS chunks
    with synthesized voice of LLM response put in an output stream.
    """
    while not input_stream.complete:
        async for chunk in chain.astream(input_stream):
            await output_stream.put(
                chunk
            )  # for production code don't forget to add a timeout


input_stream = AudioStream(maxsize=1000)
output_stream = asyncio.Queue()

# send data into the chain
producer_task = asyncio.create_task(producer(input_stream))
# get data out of the chain
consumer_task = asyncio.create_task(consumer(input_stream, output_stream))

while not consumer_task.done():
    try:
        generated_audio = await asyncio.wait_for(
            output_stream.get(), timeout=2
        )  # for production code don't forget to add a timeout
    except asyncio.TimeoutError:
        continue

await producer_task
await consumer_task

API Reference:

AudioStream

8. Listen to Voice Response

The audio response is written to ./scratch and should contain an audio clip that is a response to the input audio.

import glob
import os

output_path = os.path.join(os.getcwd(), "scratch")
file_type = "*.wav"
files_path = os.path.join(output_path, file_type)
files = glob.glob(files_path)

IPython.display.Audio(files[0])

NVIDIA Riva​

Integrating NVIDIA Riva to LangChain Chains​

1. NVIDIA Riva Runnables​

a. RivaASR​

b. RivaTTS​

2. Installation​

3. Setup​

4. Import and Inspect Runnables​

API Reference:

5. Declare Riva ASR and Riva TTS Runnables​

a. Set Audio Parameters​

API Reference:

b. Set the Speech Server and Declare Riva LangChain Runnables​

6. Create Additional Chain Components​

API Reference:

7. Run the Chain with Streamed Inputs and Outputs​

a. Mimic Audio Streaming​

API Reference:

8. Listen to Voice Response​

Help us out by providing feedback on this documentation page:

NVIDIA Riva

Integrating NVIDIA Riva to LangChain Chains

1. NVIDIA Riva Runnables

a. RivaASR

b. RivaTTS

2. Installation

3. Setup

4. Import and Inspect Runnables

5. Declare Riva ASR and Riva TTS Runnables

a. Set Audio Parameters

b. Set the Speech Server and Declare Riva LangChain Runnables

6. Create Additional Chain Components

7. Run the Chain with Streamed Inputs and Outputs

a. Mimic Audio Streaming

8. Listen to Voice Response