Merge pull request #3130 from pipecat-ai/vp-nvidia-docs
update nvidia services naming
This commit is contained in:
@@ -26,6 +26,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
has any effect. Noise gating is now handled automatically by the AIC VAD
|
has any effect. Noise gating is now handled automatically by the AIC VAD
|
||||||
system. Use `AICFilter.create_vad_analyzer()` for VAD functionality instead.
|
system. Use `AICFilter.create_vad_analyzer()` for VAD functionality instead.
|
||||||
|
|
||||||
|
- NVIDIA Services name changes (all functionality is unchanged):
|
||||||
|
|
||||||
|
- `NimLLMService` is now deprecated, use `NvidiaLLMService` instead.
|
||||||
|
- `RivaSTTService` is now deprecated, use `NvidiaSTTService` instead.
|
||||||
|
- `RivaTTSService` is now deprecated, use `NvidiaTTSService` instead.
|
||||||
|
- Use `uv pip install pipecat-ai[nvidia]` instead of
|
||||||
|
`uv pip install pipecat-ai[riva]`
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fixed an issue in `SarvamTTSService` where the last sentence was not being
|
- Fixed an issue in `SarvamTTSService` where the last sentence was not being
|
||||||
|
|||||||
@@ -79,7 +79,7 @@ Once your PR is submitted, post in the `#community-integrations` Discord channel
|
|||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
- [RivaSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/riva/stt.py)
|
- [NvidiaSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/nvidia/stt.py)
|
||||||
- [FalSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/fal/stt.py)
|
- [FalSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/fal/stt.py)
|
||||||
|
|
||||||
#### Key requirements:
|
#### Key requirements:
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ from pipecat.pipeline.runner import PipelineRunner
|
|||||||
from pipecat.pipeline.task import PipelineTask
|
from pipecat.pipeline.task import PipelineTask
|
||||||
from pipecat.runner.types import RunnerArguments
|
from pipecat.runner.types import RunnerArguments
|
||||||
from pipecat.runner.utils import create_transport
|
from pipecat.runner.utils import create_transport
|
||||||
from pipecat.services.riva.tts import FastPitchTTSService
|
from pipecat.services.nvidia.tts import NvidiaTTSService
|
||||||
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
||||||
from pipecat.transports.daily.transport import DailyParams
|
from pipecat.transports.daily.transport import DailyParams
|
||||||
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
||||||
@@ -36,7 +36,7 @@ transport_params = {
|
|||||||
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
||||||
logger.info(f"Starting bot")
|
logger.info(f"Starting bot")
|
||||||
|
|
||||||
tts = FastPitchTTSService(api_key=os.getenv("NVIDIA_API_KEY"))
|
tts = NvidiaTTSService(api_key=os.getenv("NVIDIA_API_KEY"))
|
||||||
|
|
||||||
task = PipelineTask(
|
task = PipelineTask(
|
||||||
Pipeline([tts, transport.output()]),
|
Pipeline([tts, transport.output()]),
|
||||||
@@ -22,9 +22,9 @@ from pipecat.processors.aggregators.llm_context import LLMContext
|
|||||||
from pipecat.processors.aggregators.llm_response_universal import LLMContextAggregatorPair
|
from pipecat.processors.aggregators.llm_response_universal import LLMContextAggregatorPair
|
||||||
from pipecat.runner.types import RunnerArguments
|
from pipecat.runner.types import RunnerArguments
|
||||||
from pipecat.runner.utils import create_transport
|
from pipecat.runner.utils import create_transport
|
||||||
from pipecat.services.nim.llm import NimLLMService
|
from pipecat.services.nvidia.llm import NvidiaLLMService
|
||||||
from pipecat.services.riva.stt import RivaSTTService
|
from pipecat.services.nvidia.stt import NvidiaSTTService
|
||||||
from pipecat.services.riva.tts import RivaTTSService
|
from pipecat.services.nvidia.tts import NvidiaTTSService
|
||||||
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
||||||
from pipecat.transports.daily.transport import DailyParams
|
from pipecat.transports.daily.transport import DailyParams
|
||||||
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
||||||
@@ -59,11 +59,13 @@ transport_params = {
|
|||||||
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
||||||
logger.info(f"Starting bot")
|
logger.info(f"Starting bot")
|
||||||
|
|
||||||
stt = RivaSTTService(api_key=os.getenv("NVIDIA_API_KEY"))
|
stt = NvidiaSTTService(api_key=os.getenv("NVIDIA_API_KEY"))
|
||||||
|
|
||||||
llm = NimLLMService(api_key=os.getenv("NVIDIA_API_KEY"), model="meta/llama-3.1-405b-instruct")
|
llm = NvidiaLLMService(
|
||||||
|
api_key=os.getenv("NVIDIA_API_KEY"), model="meta/llama-3.1-405b-instruct"
|
||||||
|
)
|
||||||
|
|
||||||
tts = RivaTTSService(api_key=os.getenv("NVIDIA_API_KEY"))
|
tts = NvidiaTTSService(api_key=os.getenv("NVIDIA_API_KEY"))
|
||||||
|
|
||||||
messages = [
|
messages = [
|
||||||
{
|
{
|
||||||
@@ -27,7 +27,7 @@ from pipecat.runner.utils import create_transport
|
|||||||
from pipecat.services.cartesia.tts import CartesiaTTSService
|
from pipecat.services.cartesia.tts import CartesiaTTSService
|
||||||
from pipecat.services.deepgram.stt import DeepgramSTTService
|
from pipecat.services.deepgram.stt import DeepgramSTTService
|
||||||
from pipecat.services.llm_service import FunctionCallParams
|
from pipecat.services.llm_service import FunctionCallParams
|
||||||
from pipecat.services.nim.llm import NimLLMService
|
from pipecat.services.nvidia.llm import NvidiaLLMService
|
||||||
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
||||||
from pipecat.transports.daily.transport import DailyParams
|
from pipecat.transports.daily.transport import DailyParams
|
||||||
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
||||||
@@ -75,11 +75,11 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
|||||||
# text_filters=[MarkdownTextFilter()],
|
# text_filters=[MarkdownTextFilter()],
|
||||||
)
|
)
|
||||||
|
|
||||||
llm = NimLLMService(
|
llm = NvidiaLLMService(
|
||||||
api_key=os.getenv("NVIDIA_API_KEY"),
|
api_key=os.getenv("NVIDIA_API_KEY"),
|
||||||
model="nvidia/llama-3.3-nemotron-super-49b-v1.5",
|
model="nvidia/llama-3.3-nemotron-super-49b-v1.5",
|
||||||
# Recommended when turning thinking off
|
# Recommended when turning thinking off
|
||||||
params=NimLLMService.InputParams(temperature=0.0),
|
params=NvidiaLLMService.InputParams(temperature=0.0),
|
||||||
)
|
)
|
||||||
# You can also register a function_name of None to get all functions
|
# You can also register a function_name of None to get all functions
|
||||||
# sent to the same callback with an additional function_name parameter.
|
# sent to the same callback with an additional function_name parameter.
|
||||||
@@ -83,8 +83,8 @@ mistral = []
|
|||||||
mlx-whisper = [ "mlx-whisper~=0.4.2" ]
|
mlx-whisper = [ "mlx-whisper~=0.4.2" ]
|
||||||
moondream = [ "accelerate~=1.10.0", "einops~=0.8.0", "pyvips[binary]~=3.0.0", "timm~=1.0.13", "transformers>=4.48.0" ]
|
moondream = [ "accelerate~=1.10.0", "einops~=0.8.0", "pyvips[binary]~=3.0.0", "timm~=1.0.13", "transformers>=4.48.0" ]
|
||||||
neuphonic = [ "pipecat-ai[websockets-base]" ]
|
neuphonic = [ "pipecat-ai[websockets-base]" ]
|
||||||
nim = []
|
|
||||||
noisereduce = [ "noisereduce~=3.0.3" ]
|
noisereduce = [ "noisereduce~=3.0.3" ]
|
||||||
|
nvidia = [ "nvidia-riva-client~=2.21.1" ]
|
||||||
openai = [ "pipecat-ai[websockets-base]" ]
|
openai = [ "pipecat-ai[websockets-base]" ]
|
||||||
openpipe = [ "openpipe>=4.50.0,<6" ]
|
openpipe = [ "openpipe>=4.50.0,<6" ]
|
||||||
openrouter = []
|
openrouter = []
|
||||||
@@ -93,7 +93,7 @@ playht = [ "pipecat-ai[websockets-base]" ]
|
|||||||
qwen = []
|
qwen = []
|
||||||
remote-smart-turn = []
|
remote-smart-turn = []
|
||||||
rime = [ "pipecat-ai[websockets-base]" ]
|
rime = [ "pipecat-ai[websockets-base]" ]
|
||||||
riva = [ "nvidia-riva-client~=2.21.1" ]
|
riva = [ "pipecat-ai[nvidia]" ]
|
||||||
runner = [ "python-dotenv>=1.0.0,<2.0.0", "uvicorn>=0.32.0,<1.0.0", "fastapi>=0.115.6,<0.122.0", "pipecat-ai-small-webrtc-prebuilt>=1.0.0"]
|
runner = [ "python-dotenv>=1.0.0,<2.0.0", "uvicorn>=0.32.0,<1.0.0", "fastapi>=0.115.6,<0.122.0", "pipecat-ai-small-webrtc-prebuilt>=1.0.0"]
|
||||||
sagemaker = ["aws_sdk_sagemaker_runtime_http2; python_version>='3.12'"]
|
sagemaker = ["aws_sdk_sagemaker_runtime_http2; python_version>='3.12'"]
|
||||||
sambanova = []
|
sambanova = []
|
||||||
|
|||||||
@@ -103,7 +103,7 @@ TESTS_07 = [
|
|||||||
("07o-interruptible-assemblyai.py", EVAL_SIMPLE_MATH),
|
("07o-interruptible-assemblyai.py", EVAL_SIMPLE_MATH),
|
||||||
("07q-interruptible-rime.py", EVAL_SIMPLE_MATH),
|
("07q-interruptible-rime.py", EVAL_SIMPLE_MATH),
|
||||||
("07q-interruptible-rime-http.py", EVAL_SIMPLE_MATH),
|
("07q-interruptible-rime-http.py", EVAL_SIMPLE_MATH),
|
||||||
("07r-interruptible-riva-nim.py", EVAL_SIMPLE_MATH),
|
("07r-interruptible-nvidia.py", EVAL_SIMPLE_MATH),
|
||||||
("07s-interruptible-google-audio-in.py", EVAL_SIMPLE_MATH),
|
("07s-interruptible-google-audio-in.py", EVAL_SIMPLE_MATH),
|
||||||
("07t-interruptible-fish.py", EVAL_SIMPLE_MATH),
|
("07t-interruptible-fish.py", EVAL_SIMPLE_MATH),
|
||||||
("07v-interruptible-neuphonic.py", EVAL_SIMPLE_MATH),
|
("07v-interruptible-neuphonic.py", EVAL_SIMPLE_MATH),
|
||||||
@@ -136,7 +136,7 @@ TESTS_14 = [
|
|||||||
("14g-function-calling-grok.py", EVAL_WEATHER),
|
("14g-function-calling-grok.py", EVAL_WEATHER),
|
||||||
("14h-function-calling-azure.py", EVAL_WEATHER),
|
("14h-function-calling-azure.py", EVAL_WEATHER),
|
||||||
("14i-function-calling-fireworks.py", EVAL_WEATHER),
|
("14i-function-calling-fireworks.py", EVAL_WEATHER),
|
||||||
("14j-function-calling-nim.py", EVAL_WEATHER),
|
("14j-function-calling-nvidia.py", EVAL_WEATHER),
|
||||||
("14k-function-calling-cerebras.py", EVAL_WEATHER),
|
("14k-function-calling-cerebras.py", EVAL_WEATHER),
|
||||||
("14m-function-calling-openrouter.py", EVAL_WEATHER),
|
("14m-function-calling-openrouter.py", EVAL_WEATHER),
|
||||||
("14n-function-calling-perplexity.py", EVAL_WEATHER),
|
("14n-function-calling-perplexity.py", EVAL_WEATHER),
|
||||||
|
|||||||
@@ -8,98 +8,23 @@
|
|||||||
|
|
||||||
This module provides a service for interacting with NVIDIA's NIM (NVIDIA Inference
|
This module provides a service for interacting with NVIDIA's NIM (NVIDIA Inference
|
||||||
Microservice) API while maintaining compatibility with the OpenAI-style interface.
|
Microservice) API while maintaining compatibility with the OpenAI-style interface.
|
||||||
|
|
||||||
|
.. deprecated:: 0.0.96
|
||||||
|
This module is deprecated. Please NvidiaLLMService from
|
||||||
|
pipecat.services.nvidia.llm instead.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from pipecat.metrics.metrics import LLMTokenUsage
|
import warnings
|
||||||
from pipecat.processors.aggregators.llm_context import LLMContext
|
|
||||||
from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
|
|
||||||
from pipecat.services.openai.llm import OpenAILLMService
|
|
||||||
|
|
||||||
|
from pipecat.services.nvidia.llm import NvidiaLLMService
|
||||||
|
|
||||||
class NimLLMService(OpenAILLMService):
|
with warnings.catch_warnings():
|
||||||
"""A service for interacting with NVIDIA's NIM (NVIDIA Inference Microservice) API.
|
warnings.simplefilter("always")
|
||||||
|
warnings.warn(
|
||||||
|
"NimLLMService from pipecat.services.nim.llm is deprecated. "
|
||||||
|
"Please use NvidiaLLMService from pipecat.services.nvidia.llm instead.",
|
||||||
|
DeprecationWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
|
|
||||||
This service extends OpenAILLMService to work with NVIDIA's NIM API while maintaining
|
NimLLMService = NvidiaLLMService
|
||||||
compatibility with the OpenAI-style interface. It specifically handles the difference
|
|
||||||
in token usage reporting between NIM (incremental) and OpenAI (final summary).
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
api_key: str,
|
|
||||||
base_url: str = "https://integrate.api.nvidia.com/v1",
|
|
||||||
model: str = "nvidia/llama-3.1-nemotron-70b-instruct",
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
"""Initialize the NimLLMService.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
api_key: The API key for accessing NVIDIA's NIM API.
|
|
||||||
base_url: The base URL for NIM API. Defaults to "https://integrate.api.nvidia.com/v1".
|
|
||||||
model: The model identifier to use. Defaults to "nvidia/llama-3.1-nemotron-70b-instruct".
|
|
||||||
**kwargs: Additional keyword arguments passed to OpenAILLMService.
|
|
||||||
"""
|
|
||||||
super().__init__(api_key=api_key, base_url=base_url, model=model, **kwargs)
|
|
||||||
# Counters for accumulating token usage metrics
|
|
||||||
self._prompt_tokens = 0
|
|
||||||
self._completion_tokens = 0
|
|
||||||
self._total_tokens = 0
|
|
||||||
self._has_reported_prompt_tokens = False
|
|
||||||
self._is_processing = False
|
|
||||||
|
|
||||||
async def _process_context(self, context: OpenAILLMContext | LLMContext):
|
|
||||||
"""Process a context through the LLM and accumulate token usage metrics.
|
|
||||||
|
|
||||||
This method overrides the parent class implementation to handle NVIDIA's
|
|
||||||
incremental token reporting style, accumulating the counts and reporting
|
|
||||||
them once at the end of processing.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
context: The context to process, containing messages and other information
|
|
||||||
needed for the LLM interaction.
|
|
||||||
"""
|
|
||||||
# Reset all counters and flags at the start of processing
|
|
||||||
self._prompt_tokens = 0
|
|
||||||
self._completion_tokens = 0
|
|
||||||
self._total_tokens = 0
|
|
||||||
self._has_reported_prompt_tokens = False
|
|
||||||
self._is_processing = True
|
|
||||||
|
|
||||||
try:
|
|
||||||
await super()._process_context(context)
|
|
||||||
finally:
|
|
||||||
self._is_processing = False
|
|
||||||
# Report final accumulated token usage at the end of processing
|
|
||||||
if self._prompt_tokens > 0 or self._completion_tokens > 0:
|
|
||||||
self._total_tokens = self._prompt_tokens + self._completion_tokens
|
|
||||||
tokens = LLMTokenUsage(
|
|
||||||
prompt_tokens=self._prompt_tokens,
|
|
||||||
completion_tokens=self._completion_tokens,
|
|
||||||
total_tokens=self._total_tokens,
|
|
||||||
)
|
|
||||||
await super().start_llm_usage_metrics(tokens)
|
|
||||||
|
|
||||||
async def start_llm_usage_metrics(self, tokens: LLMTokenUsage):
|
|
||||||
"""Accumulate token usage metrics during processing.
|
|
||||||
|
|
||||||
This method intercepts the incremental token updates from NVIDIA's API
|
|
||||||
and accumulates them instead of passing each update to the metrics system.
|
|
||||||
The final accumulated totals are reported at the end of processing.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
tokens: The token usage metrics for the current chunk of processing,
|
|
||||||
containing prompt_tokens and completion_tokens counts.
|
|
||||||
"""
|
|
||||||
# Only accumulate metrics during active processing
|
|
||||||
if not self._is_processing:
|
|
||||||
return
|
|
||||||
|
|
||||||
# Record prompt tokens the first time we see them
|
|
||||||
if not self._has_reported_prompt_tokens and tokens.prompt_tokens > 0:
|
|
||||||
self._prompt_tokens = tokens.prompt_tokens
|
|
||||||
self._has_reported_prompt_tokens = True
|
|
||||||
|
|
||||||
# Update completion tokens count if it has increased
|
|
||||||
if tokens.completion_tokens > self._completion_tokens:
|
|
||||||
self._completion_tokens = tokens.completion_tokens
|
|
||||||
|
|||||||
0
src/pipecat/services/nvidia/__init__.py
Normal file
0
src/pipecat/services/nvidia/__init__.py
Normal file
105
src/pipecat/services/nvidia/llm.py
Normal file
105
src/pipecat/services/nvidia/llm.py
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2024–2025, Daily
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: BSD 2-Clause License
|
||||||
|
#
|
||||||
|
|
||||||
|
"""NVIDIA NIM API service implementation.
|
||||||
|
|
||||||
|
This module provides a service for interacting with NVIDIA's NIM (NVIDIA Inference
|
||||||
|
Microservice) API while maintaining compatibility with the OpenAI-style interface.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from pipecat.metrics.metrics import LLMTokenUsage
|
||||||
|
from pipecat.processors.aggregators.llm_context import LLMContext
|
||||||
|
from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
|
||||||
|
from pipecat.services.openai.llm import OpenAILLMService
|
||||||
|
|
||||||
|
|
||||||
|
class NvidiaLLMService(OpenAILLMService):
|
||||||
|
"""A service for interacting with NVIDIA's NIM (NVIDIA Inference Microservice) API.
|
||||||
|
|
||||||
|
This service extends OpenAILLMService to work with NVIDIA's NIM API while maintaining
|
||||||
|
compatibility with the OpenAI-style interface. It specifically handles the difference
|
||||||
|
in token usage reporting between NIM (incremental) and OpenAI (final summary).
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
api_key: str,
|
||||||
|
base_url: str = "https://integrate.api.nvidia.com/v1",
|
||||||
|
model: str = "nvidia/llama-3.1-nemotron-70b-instruct",
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
"""Initialize the NvidiaLLMService.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
api_key: The API key for accessing NVIDIA's NIM API.
|
||||||
|
base_url: The base URL for NIM API. Defaults to "https://integrate.api.nvidia.com/v1".
|
||||||
|
model: The model identifier to use. Defaults to "nvidia/llama-3.1-nemotron-70b-instruct".
|
||||||
|
**kwargs: Additional keyword arguments passed to OpenAILLMService.
|
||||||
|
"""
|
||||||
|
super().__init__(api_key=api_key, base_url=base_url, model=model, **kwargs)
|
||||||
|
# Counters for accumulating token usage metrics
|
||||||
|
self._prompt_tokens = 0
|
||||||
|
self._completion_tokens = 0
|
||||||
|
self._total_tokens = 0
|
||||||
|
self._has_reported_prompt_tokens = False
|
||||||
|
self._is_processing = False
|
||||||
|
|
||||||
|
async def _process_context(self, context: OpenAILLMContext | LLMContext):
|
||||||
|
"""Process a context through the LLM and accumulate token usage metrics.
|
||||||
|
|
||||||
|
This method overrides the parent class implementation to handle NVIDIA's
|
||||||
|
incremental token reporting style, accumulating the counts and reporting
|
||||||
|
them once at the end of processing.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
context: The context to process, containing messages and other information
|
||||||
|
needed for the LLM interaction.
|
||||||
|
"""
|
||||||
|
# Reset all counters and flags at the start of processing
|
||||||
|
self._prompt_tokens = 0
|
||||||
|
self._completion_tokens = 0
|
||||||
|
self._total_tokens = 0
|
||||||
|
self._has_reported_prompt_tokens = False
|
||||||
|
self._is_processing = True
|
||||||
|
|
||||||
|
try:
|
||||||
|
await super()._process_context(context)
|
||||||
|
finally:
|
||||||
|
self._is_processing = False
|
||||||
|
# Report final accumulated token usage at the end of processing
|
||||||
|
if self._prompt_tokens > 0 or self._completion_tokens > 0:
|
||||||
|
self._total_tokens = self._prompt_tokens + self._completion_tokens
|
||||||
|
tokens = LLMTokenUsage(
|
||||||
|
prompt_tokens=self._prompt_tokens,
|
||||||
|
completion_tokens=self._completion_tokens,
|
||||||
|
total_tokens=self._total_tokens,
|
||||||
|
)
|
||||||
|
await super().start_llm_usage_metrics(tokens)
|
||||||
|
|
||||||
|
async def start_llm_usage_metrics(self, tokens: LLMTokenUsage):
|
||||||
|
"""Accumulate token usage metrics during processing.
|
||||||
|
|
||||||
|
This method intercepts the incremental token updates from NVIDIA's API
|
||||||
|
and accumulates them instead of passing each update to the metrics system.
|
||||||
|
The final accumulated totals are reported at the end of processing.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
tokens: The token usage metrics for the current chunk of processing,
|
||||||
|
containing prompt_tokens and completion_tokens counts.
|
||||||
|
"""
|
||||||
|
# Only accumulate metrics during active processing
|
||||||
|
if not self._is_processing:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Record prompt tokens the first time we see them
|
||||||
|
if not self._has_reported_prompt_tokens and tokens.prompt_tokens > 0:
|
||||||
|
self._prompt_tokens = tokens.prompt_tokens
|
||||||
|
self._has_reported_prompt_tokens = True
|
||||||
|
|
||||||
|
# Update completion tokens count if it has increased
|
||||||
|
if tokens.completion_tokens > self._completion_tokens:
|
||||||
|
self._completion_tokens = tokens.completion_tokens
|
||||||
663
src/pipecat/services/nvidia/stt.py
Normal file
663
src/pipecat/services/nvidia/stt.py
Normal file
@@ -0,0 +1,663 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2024–2025, Daily
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: BSD 2-Clause License
|
||||||
|
#
|
||||||
|
|
||||||
|
"""NVIDIA Riva Speech-to-Text service implementations for real-time and batch transcription."""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
from concurrent.futures import CancelledError as FuturesCancelledError
|
||||||
|
from typing import AsyncGenerator, List, Mapping, Optional
|
||||||
|
|
||||||
|
from loguru import logger
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
from pipecat.frames.frames import (
|
||||||
|
CancelFrame,
|
||||||
|
EndFrame,
|
||||||
|
ErrorFrame,
|
||||||
|
Frame,
|
||||||
|
InterimTranscriptionFrame,
|
||||||
|
StartFrame,
|
||||||
|
TranscriptionFrame,
|
||||||
|
)
|
||||||
|
from pipecat.services.stt_service import SegmentedSTTService, STTService
|
||||||
|
from pipecat.transcriptions.language import Language, resolve_language
|
||||||
|
from pipecat.utils.time import time_now_iso8601
|
||||||
|
from pipecat.utils.tracing.service_decorators import traced_stt
|
||||||
|
|
||||||
|
try:
|
||||||
|
import riva.client
|
||||||
|
|
||||||
|
except ModuleNotFoundError as e:
|
||||||
|
logger.error(f"Exception: {e}")
|
||||||
|
logger.error("In order to use NVIDIA Riva STT, you need to `pip install pipecat-ai[nvidia]`.")
|
||||||
|
raise Exception(f"Missing module: {e}")
|
||||||
|
|
||||||
|
|
||||||
|
def language_to_nvidia_riva_language(language: Language) -> Optional[str]:
|
||||||
|
"""Maps Language enum to NVIDIA Riva ASR language codes.
|
||||||
|
|
||||||
|
Source:
|
||||||
|
https://docs.nvidia.com/deeplearning/riva/user-guide/docs/asr/asr-riva-build-table.html?highlight=fr%20fr
|
||||||
|
|
||||||
|
Args:
|
||||||
|
language: Language enum value.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Optional[str]: NVIDIA Riva language code or None if not supported.
|
||||||
|
"""
|
||||||
|
LANGUAGE_MAP = {
|
||||||
|
# Arabic
|
||||||
|
Language.AR: "ar-AR",
|
||||||
|
# English
|
||||||
|
Language.EN: "en-US", # Default to US
|
||||||
|
Language.EN_US: "en-US",
|
||||||
|
Language.EN_GB: "en-GB",
|
||||||
|
# French
|
||||||
|
Language.FR: "fr-FR",
|
||||||
|
Language.FR_FR: "fr-FR",
|
||||||
|
# German
|
||||||
|
Language.DE: "de-DE",
|
||||||
|
Language.DE_DE: "de-DE",
|
||||||
|
# Hindi
|
||||||
|
Language.HI: "hi-IN",
|
||||||
|
Language.HI_IN: "hi-IN",
|
||||||
|
# Italian
|
||||||
|
Language.IT: "it-IT",
|
||||||
|
Language.IT_IT: "it-IT",
|
||||||
|
# Japanese
|
||||||
|
Language.JA: "ja-JP",
|
||||||
|
Language.JA_JP: "ja-JP",
|
||||||
|
# Korean
|
||||||
|
Language.KO: "ko-KR",
|
||||||
|
Language.KO_KR: "ko-KR",
|
||||||
|
# Portuguese
|
||||||
|
Language.PT: "pt-BR", # Default to Brazilian
|
||||||
|
Language.PT_BR: "pt-BR",
|
||||||
|
# Russian
|
||||||
|
Language.RU: "ru-RU",
|
||||||
|
Language.RU_RU: "ru-RU",
|
||||||
|
# Spanish
|
||||||
|
Language.ES: "es-ES", # Default to Spain
|
||||||
|
Language.ES_ES: "es-ES",
|
||||||
|
Language.ES_US: "es-US", # US Spanish
|
||||||
|
}
|
||||||
|
|
||||||
|
return resolve_language(language, LANGUAGE_MAP, use_base_code=False)
|
||||||
|
|
||||||
|
|
||||||
|
class NvidiaSTTService(STTService):
|
||||||
|
"""Real-time speech-to-text service using NVIDIA Riva streaming ASR.
|
||||||
|
|
||||||
|
Provides real-time transcription capabilities using NVIDIA's Riva ASR models
|
||||||
|
through streaming recognition. Supports interim results and continuous audio
|
||||||
|
processing for low-latency applications.
|
||||||
|
"""
|
||||||
|
|
||||||
|
class InputParams(BaseModel):
|
||||||
|
"""Configuration parameters for NVIDIA Riva STT service.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
language: Target language for transcription. Defaults to EN_US.
|
||||||
|
"""
|
||||||
|
|
||||||
|
language: Optional[Language] = Language.EN_US
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
api_key: str,
|
||||||
|
server: str = "grpc.nvcf.nvidia.com:443",
|
||||||
|
model_function_map: Mapping[str, str] = {
|
||||||
|
"function_id": "1598d209-5e27-4d3c-8079-4751568b1081",
|
||||||
|
"model_name": "parakeet-ctc-1.1b-asr",
|
||||||
|
},
|
||||||
|
sample_rate: Optional[int] = None,
|
||||||
|
params: Optional[InputParams] = None,
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
"""Initialize the NVIDIA Riva STT service.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
api_key: NVIDIA API key for authentication.
|
||||||
|
server: NVIDIA Riva server address. Defaults to NVIDIA Cloud Function endpoint.
|
||||||
|
model_function_map: Mapping containing 'function_id' and 'model_name' for the ASR model.
|
||||||
|
sample_rate: Audio sample rate in Hz. If None, uses pipeline default.
|
||||||
|
params: Additional configuration parameters for NVIDIA Riva.
|
||||||
|
**kwargs: Additional arguments passed to STTService.
|
||||||
|
"""
|
||||||
|
super().__init__(sample_rate=sample_rate, **kwargs)
|
||||||
|
|
||||||
|
params = params or NvidiaSTTService.InputParams()
|
||||||
|
|
||||||
|
self._api_key = api_key
|
||||||
|
self._profanity_filter = False
|
||||||
|
self._automatic_punctuation = True
|
||||||
|
self._no_verbatim_transcripts = False
|
||||||
|
self._language_code = params.language
|
||||||
|
self._boosted_lm_words = None
|
||||||
|
self._boosted_lm_score = 4.0
|
||||||
|
self._start_history = -1
|
||||||
|
self._start_threshold = -1.0
|
||||||
|
self._stop_history = -1
|
||||||
|
self._stop_threshold = -1.0
|
||||||
|
self._stop_history_eou = -1
|
||||||
|
self._stop_threshold_eou = -1.0
|
||||||
|
self._custom_configuration = ""
|
||||||
|
self._function_id = model_function_map.get("function_id")
|
||||||
|
|
||||||
|
self._settings = {
|
||||||
|
"language": str(params.language),
|
||||||
|
"profanity_filter": self._profanity_filter,
|
||||||
|
"automatic_punctuation": self._automatic_punctuation,
|
||||||
|
"verbatim_transcripts": not self._no_verbatim_transcripts,
|
||||||
|
"boosted_lm_words": self._boosted_lm_words,
|
||||||
|
"boosted_lm_score": self._boosted_lm_score,
|
||||||
|
}
|
||||||
|
|
||||||
|
self.set_model_name(model_function_map.get("model_name"))
|
||||||
|
|
||||||
|
metadata = [
|
||||||
|
["function-id", self._function_id],
|
||||||
|
["authorization", f"Bearer {api_key}"],
|
||||||
|
]
|
||||||
|
auth = riva.client.Auth(None, True, server, metadata)
|
||||||
|
|
||||||
|
self._asr_service = riva.client.ASRService(auth)
|
||||||
|
|
||||||
|
self._queue = None
|
||||||
|
self._config = None
|
||||||
|
self._thread_task = None
|
||||||
|
self._response_task = None
|
||||||
|
|
||||||
|
def can_generate_metrics(self) -> bool:
|
||||||
|
"""Check if this service can generate processing metrics.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
False - this service does not support metrics generation.
|
||||||
|
"""
|
||||||
|
return False
|
||||||
|
|
||||||
|
async def set_model(self, model: str):
|
||||||
|
"""Set the ASR model for transcription.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
model: Model name to set.
|
||||||
|
|
||||||
|
Note:
|
||||||
|
Model cannot be changed after initialization. Use model_function_map
|
||||||
|
parameter in constructor instead.
|
||||||
|
"""
|
||||||
|
logger.warning(f"Cannot set model after initialization. Set model and function id like so:")
|
||||||
|
example = {"function_id": "<UUID>", "model_name": "<model_name>"}
|
||||||
|
logger.warning(
|
||||||
|
f"{self.__class__.__name__}(api_key=<api_key>, model_function_map={example})"
|
||||||
|
)
|
||||||
|
|
||||||
|
async def start(self, frame: StartFrame):
|
||||||
|
"""Start the NVIDIA Riva STT service and initialize streaming configuration.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
frame: StartFrame indicating pipeline start.
|
||||||
|
"""
|
||||||
|
await super().start(frame)
|
||||||
|
|
||||||
|
if self._config:
|
||||||
|
return
|
||||||
|
|
||||||
|
config = riva.client.StreamingRecognitionConfig(
|
||||||
|
config=riva.client.RecognitionConfig(
|
||||||
|
encoding=riva.client.AudioEncoding.LINEAR_PCM,
|
||||||
|
language_code=self._language_code,
|
||||||
|
model="",
|
||||||
|
max_alternatives=1,
|
||||||
|
profanity_filter=self._profanity_filter,
|
||||||
|
enable_automatic_punctuation=self._automatic_punctuation,
|
||||||
|
verbatim_transcripts=not self._no_verbatim_transcripts,
|
||||||
|
sample_rate_hertz=self.sample_rate,
|
||||||
|
audio_channel_count=1,
|
||||||
|
),
|
||||||
|
interim_results=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
riva.client.add_word_boosting_to_config(
|
||||||
|
config, self._boosted_lm_words, self._boosted_lm_score
|
||||||
|
)
|
||||||
|
|
||||||
|
riva.client.add_endpoint_parameters_to_config(
|
||||||
|
config,
|
||||||
|
self._start_history,
|
||||||
|
self._start_threshold,
|
||||||
|
self._stop_history,
|
||||||
|
self._stop_history_eou,
|
||||||
|
self._stop_threshold,
|
||||||
|
self._stop_threshold_eou,
|
||||||
|
)
|
||||||
|
riva.client.add_custom_configuration_to_config(config, self._custom_configuration)
|
||||||
|
|
||||||
|
self._config = config
|
||||||
|
self._queue = asyncio.Queue()
|
||||||
|
|
||||||
|
if not self._thread_task:
|
||||||
|
self._thread_task = self.create_task(self._thread_task_handler())
|
||||||
|
|
||||||
|
if not self._response_task:
|
||||||
|
self._response_queue = asyncio.Queue()
|
||||||
|
self._response_task = self.create_task(self._response_task_handler())
|
||||||
|
|
||||||
|
async def stop(self, frame: EndFrame):
|
||||||
|
"""Stop the NVIDIA Riva STT service and clean up resources.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
frame: EndFrame indicating pipeline stop.
|
||||||
|
"""
|
||||||
|
await super().stop(frame)
|
||||||
|
await self._stop_tasks()
|
||||||
|
|
||||||
|
async def cancel(self, frame: CancelFrame):
|
||||||
|
"""Cancel the NVIDIA Riva STT service operation.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
frame: CancelFrame indicating operation cancellation.
|
||||||
|
"""
|
||||||
|
await super().cancel(frame)
|
||||||
|
await self._stop_tasks()
|
||||||
|
|
||||||
|
async def _stop_tasks(self):
|
||||||
|
if self._thread_task:
|
||||||
|
await self.cancel_task(self._thread_task)
|
||||||
|
self._thread_task = None
|
||||||
|
|
||||||
|
if self._response_task:
|
||||||
|
await self.cancel_task(self._response_task)
|
||||||
|
self._response_task = None
|
||||||
|
|
||||||
|
def _response_handler(self):
|
||||||
|
responses = self._asr_service.streaming_response_generator(
|
||||||
|
audio_chunks=self,
|
||||||
|
streaming_config=self._config,
|
||||||
|
)
|
||||||
|
for response in responses:
|
||||||
|
if not response.results:
|
||||||
|
continue
|
||||||
|
asyncio.run_coroutine_threadsafe(
|
||||||
|
self._response_queue.put(response), self.get_event_loop()
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _thread_task_handler(self):
|
||||||
|
try:
|
||||||
|
self._thread_running = True
|
||||||
|
await asyncio.to_thread(self._response_handler)
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
self._thread_running = False
|
||||||
|
raise
|
||||||
|
|
||||||
|
@traced_stt
|
||||||
|
async def _handle_transcription(
|
||||||
|
self, transcript: str, is_final: bool, language: Optional[Language] = None
|
||||||
|
):
|
||||||
|
"""Handle a transcription result with tracing."""
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def _handle_response(self, response):
|
||||||
|
for result in response.results:
|
||||||
|
if result and not result.alternatives:
|
||||||
|
continue
|
||||||
|
|
||||||
|
transcript = result.alternatives[0].transcript
|
||||||
|
if transcript and len(transcript) > 0:
|
||||||
|
await self.stop_ttfb_metrics()
|
||||||
|
if result.is_final:
|
||||||
|
await self.stop_processing_metrics()
|
||||||
|
await self.push_frame(
|
||||||
|
TranscriptionFrame(
|
||||||
|
transcript,
|
||||||
|
self._user_id,
|
||||||
|
time_now_iso8601(),
|
||||||
|
self._language_code,
|
||||||
|
result=result,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
await self._handle_transcription(
|
||||||
|
transcript=transcript,
|
||||||
|
is_final=result.is_final,
|
||||||
|
language=self._language_code,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
await self.push_frame(
|
||||||
|
InterimTranscriptionFrame(
|
||||||
|
transcript,
|
||||||
|
self._user_id,
|
||||||
|
time_now_iso8601(),
|
||||||
|
self._language_code,
|
||||||
|
result=result,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _response_task_handler(self):
|
||||||
|
while True:
|
||||||
|
response = await self._response_queue.get()
|
||||||
|
await self._handle_response(response)
|
||||||
|
self._response_queue.task_done()
|
||||||
|
|
||||||
|
async def run_stt(self, audio: bytes) -> AsyncGenerator[Frame, None]:
|
||||||
|
"""Process audio data for speech-to-text transcription.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
audio: Raw audio bytes to transcribe.
|
||||||
|
|
||||||
|
Yields:
|
||||||
|
None - transcription results are pushed to the pipeline via frames.
|
||||||
|
"""
|
||||||
|
await self.start_ttfb_metrics()
|
||||||
|
await self.start_processing_metrics()
|
||||||
|
await self._queue.put(audio)
|
||||||
|
yield None
|
||||||
|
|
||||||
|
def __next__(self) -> bytes:
|
||||||
|
"""Get the next audio chunk for NVIDIA Riva processing.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Audio bytes from the queue.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
StopIteration: When the thread is no longer running.
|
||||||
|
"""
|
||||||
|
if not self._thread_running:
|
||||||
|
raise StopIteration
|
||||||
|
|
||||||
|
try:
|
||||||
|
future = asyncio.run_coroutine_threadsafe(self._queue.get(), self.get_event_loop())
|
||||||
|
return future.result()
|
||||||
|
except FuturesCancelledError:
|
||||||
|
raise StopIteration
|
||||||
|
|
||||||
|
def __iter__(self):
|
||||||
|
"""Return iterator for audio chunk processing.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Self as iterator.
|
||||||
|
"""
|
||||||
|
return self
|
||||||
|
|
||||||
|
|
||||||
|
class NvidiaSegmentedSTTService(SegmentedSTTService):
|
||||||
|
"""Speech-to-text service using NVIDIA Riva's offline/batch models.
|
||||||
|
|
||||||
|
By default, his service uses NVIDIA's Riva Canary ASR API to perform speech-to-text
|
||||||
|
transcription on audio segments. It inherits from SegmentedSTTService to handle
|
||||||
|
audio buffering and speech detection.
|
||||||
|
"""
|
||||||
|
|
||||||
|
class InputParams(BaseModel):
|
||||||
|
"""Configuration parameters for NVIDIA Riva segmented STT service.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
language: Target language for transcription. Defaults to EN_US.
|
||||||
|
profanity_filter: Whether to filter profanity from results.
|
||||||
|
automatic_punctuation: Whether to add automatic punctuation.
|
||||||
|
verbatim_transcripts: Whether to return verbatim transcripts.
|
||||||
|
boosted_lm_words: List of words to boost in language model.
|
||||||
|
boosted_lm_score: Score boost for specified words.
|
||||||
|
"""
|
||||||
|
|
||||||
|
language: Optional[Language] = Language.EN_US
|
||||||
|
profanity_filter: bool = False
|
||||||
|
automatic_punctuation: bool = True
|
||||||
|
verbatim_transcripts: bool = False
|
||||||
|
boosted_lm_words: Optional[List[str]] = None
|
||||||
|
boosted_lm_score: float = 4.0
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
api_key: str,
|
||||||
|
server: str = "grpc.nvcf.nvidia.com:443",
|
||||||
|
model_function_map: Mapping[str, str] = {
|
||||||
|
"function_id": "ee8dc628-76de-4acc-8595-1836e7e857bd",
|
||||||
|
"model_name": "canary-1b-asr",
|
||||||
|
},
|
||||||
|
sample_rate: Optional[int] = None,
|
||||||
|
params: Optional[InputParams] = None,
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
"""Initialize the NVIDIA Riva segmented STT service.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
api_key: NVIDIA API key for authentication
|
||||||
|
server: NVIDIA Riva server address (defaults to NVIDIA Cloud Function endpoint)
|
||||||
|
model_function_map: Mapping of model name and its corresponding NVIDIA Cloud Function ID
|
||||||
|
sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate
|
||||||
|
params: Additional configuration parameters for NVIDIA Riva
|
||||||
|
**kwargs: Additional arguments passed to SegmentedSTTService
|
||||||
|
"""
|
||||||
|
super().__init__(sample_rate=sample_rate, **kwargs)
|
||||||
|
|
||||||
|
params = params or NvidiaSegmentedSTTService.InputParams()
|
||||||
|
|
||||||
|
# Set model name
|
||||||
|
self.set_model_name(model_function_map.get("model_name"))
|
||||||
|
|
||||||
|
# Initialize NVIDIA Riva settings
|
||||||
|
self._api_key = api_key
|
||||||
|
self._server = server
|
||||||
|
self._function_id = model_function_map.get("function_id")
|
||||||
|
self._model_name = model_function_map.get("model_name")
|
||||||
|
|
||||||
|
# Store the language as a Language enum and as a string
|
||||||
|
self._language_enum = params.language or Language.EN_US
|
||||||
|
self._language = self.language_to_service_language(self._language_enum) or "en-US"
|
||||||
|
|
||||||
|
# Configure transcription parameters
|
||||||
|
self._profanity_filter = params.profanity_filter
|
||||||
|
self._automatic_punctuation = params.automatic_punctuation
|
||||||
|
self._verbatim_transcripts = params.verbatim_transcripts
|
||||||
|
self._boosted_lm_words = params.boosted_lm_words
|
||||||
|
self._boosted_lm_score = params.boosted_lm_score
|
||||||
|
|
||||||
|
# Voice activity detection thresholds (use NVIDIA Riva defaults)
|
||||||
|
self._start_history = -1
|
||||||
|
self._start_threshold = -1.0
|
||||||
|
self._stop_history = -1
|
||||||
|
self._stop_threshold = -1.0
|
||||||
|
self._stop_history_eou = -1
|
||||||
|
self._stop_threshold_eou = -1.0
|
||||||
|
self._custom_configuration = ""
|
||||||
|
|
||||||
|
# Create NVIDIA Riva client
|
||||||
|
self._config = None
|
||||||
|
self._asr_service = None
|
||||||
|
self._settings = {"language": self._language_enum}
|
||||||
|
|
||||||
|
def language_to_service_language(self, language: Language) -> Optional[str]:
|
||||||
|
"""Convert pipecat Language enum to NVIDIA Riva's language code.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
language: Language enum value.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
NVIDIA Riva language code or None if not supported.
|
||||||
|
"""
|
||||||
|
return language_to_nvidia_riva_language(language)
|
||||||
|
|
||||||
|
def _initialize_client(self):
|
||||||
|
"""Initialize the NVIDIA Riva ASR client with authentication metadata."""
|
||||||
|
if self._asr_service is not None:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Set up authentication metadata for NVIDIA Cloud Functions
|
||||||
|
metadata = [
|
||||||
|
["function-id", self._function_id],
|
||||||
|
["authorization", f"Bearer {self._api_key}"],
|
||||||
|
]
|
||||||
|
|
||||||
|
# Create authenticated client
|
||||||
|
auth = riva.client.Auth(None, True, self._server, metadata)
|
||||||
|
self._asr_service = riva.client.ASRService(auth)
|
||||||
|
|
||||||
|
logger.info(f"Initialized NvidiaSegmentedSTTService with model: {self.model_name}")
|
||||||
|
|
||||||
|
def _create_recognition_config(self):
|
||||||
|
"""Create the NVIDIA Riva ASR recognition configuration."""
|
||||||
|
# Create base configuration
|
||||||
|
config = riva.client.RecognitionConfig(
|
||||||
|
language_code=self._language, # Now using the string, not a tuple
|
||||||
|
max_alternatives=1,
|
||||||
|
profanity_filter=self._profanity_filter,
|
||||||
|
enable_automatic_punctuation=self._automatic_punctuation,
|
||||||
|
verbatim_transcripts=self._verbatim_transcripts,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Add word boosting if specified
|
||||||
|
if self._boosted_lm_words:
|
||||||
|
riva.client.add_word_boosting_to_config(
|
||||||
|
config, self._boosted_lm_words, self._boosted_lm_score
|
||||||
|
)
|
||||||
|
|
||||||
|
# Add voice activity detection parameters
|
||||||
|
riva.client.add_endpoint_parameters_to_config(
|
||||||
|
config,
|
||||||
|
self._start_history,
|
||||||
|
self._start_threshold,
|
||||||
|
self._stop_history,
|
||||||
|
self._stop_history_eou,
|
||||||
|
self._stop_threshold,
|
||||||
|
self._stop_threshold_eou,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Add any custom configuration
|
||||||
|
if self._custom_configuration:
|
||||||
|
riva.client.add_custom_configuration_to_config(config, self._custom_configuration)
|
||||||
|
|
||||||
|
return config
|
||||||
|
|
||||||
|
def can_generate_metrics(self) -> bool:
|
||||||
|
"""Check if this service can generate processing metrics.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
True - this service supports metrics generation.
|
||||||
|
"""
|
||||||
|
return True
|
||||||
|
|
||||||
|
async def set_model(self, model: str):
|
||||||
|
"""Set the ASR model for transcription.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
model: Model name to set.
|
||||||
|
|
||||||
|
Note:
|
||||||
|
Model cannot be changed after initialization. Use model_function_map
|
||||||
|
parameter in constructor instead.
|
||||||
|
"""
|
||||||
|
logger.warning(f"Cannot set model after initialization. Set model and function id like so:")
|
||||||
|
example = {"function_id": "<UUID>", "model_name": "<model_name>"}
|
||||||
|
logger.warning(
|
||||||
|
f"{self.__class__.__name__}(api_key=<api_key>, model_function_map={example})"
|
||||||
|
)
|
||||||
|
|
||||||
|
async def start(self, frame: StartFrame):
|
||||||
|
"""Initialize the service when the pipeline starts.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
frame: StartFrame indicating pipeline start.
|
||||||
|
"""
|
||||||
|
await super().start(frame)
|
||||||
|
self._initialize_client()
|
||||||
|
self._config = self._create_recognition_config()
|
||||||
|
|
||||||
|
async def set_language(self, language: Language):
|
||||||
|
"""Set the language for the STT service.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
language: Target language for transcription.
|
||||||
|
"""
|
||||||
|
logger.info(f"Switching STT language to: [{language}]")
|
||||||
|
self._language_enum = language
|
||||||
|
self._language = self.language_to_service_language(language) or "en-US"
|
||||||
|
self._settings["language"] = language
|
||||||
|
|
||||||
|
# Update configuration with new language
|
||||||
|
if self._config:
|
||||||
|
self._config.language_code = self._language
|
||||||
|
|
||||||
|
@traced_stt
|
||||||
|
async def _handle_transcription(
|
||||||
|
self, transcript: str, is_final: bool, language: Optional[Language] = None
|
||||||
|
):
|
||||||
|
"""Handle a transcription result with tracing."""
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def run_stt(self, audio: bytes) -> AsyncGenerator[Frame, None]:
|
||||||
|
"""Transcribe an audio segment.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
audio: Raw audio bytes in WAV format (already converted by base class).
|
||||||
|
|
||||||
|
Yields:
|
||||||
|
Frame: TranscriptionFrame containing the transcribed text.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
await self.start_processing_metrics()
|
||||||
|
await self.start_ttfb_metrics()
|
||||||
|
|
||||||
|
# Make sure the client is initialized
|
||||||
|
if self._asr_service is None:
|
||||||
|
self._initialize_client()
|
||||||
|
|
||||||
|
# Make sure the config is created
|
||||||
|
if self._config is None:
|
||||||
|
self._config = self._create_recognition_config()
|
||||||
|
|
||||||
|
# Type assertion to satisfy the IDE
|
||||||
|
assert self._asr_service is not None, "ASR service not initialized"
|
||||||
|
assert self._config is not None, "Recognition config not created"
|
||||||
|
|
||||||
|
# Process audio with NVIDIA Riva ASR - explicitly request non-future response
|
||||||
|
raw_response = self._asr_service.offline_recognize(audio, self._config, future=False)
|
||||||
|
|
||||||
|
await self.stop_ttfb_metrics()
|
||||||
|
await self.stop_processing_metrics()
|
||||||
|
|
||||||
|
# Process the response - handle different possible return types
|
||||||
|
try:
|
||||||
|
# If it's a future-like object, get the result
|
||||||
|
if hasattr(raw_response, "result"):
|
||||||
|
response = raw_response.result()
|
||||||
|
else:
|
||||||
|
response = raw_response
|
||||||
|
|
||||||
|
# Process transcription results
|
||||||
|
transcription_found = False
|
||||||
|
|
||||||
|
# Now we can safely check results
|
||||||
|
# Type hint for the IDE
|
||||||
|
results = getattr(response, "results", [])
|
||||||
|
|
||||||
|
for result in results:
|
||||||
|
alternatives = getattr(result, "alternatives", [])
|
||||||
|
if alternatives:
|
||||||
|
text = alternatives[0].transcript.strip()
|
||||||
|
if text:
|
||||||
|
logger.debug(f"Transcription: [{text}]")
|
||||||
|
yield TranscriptionFrame(
|
||||||
|
text,
|
||||||
|
self._user_id,
|
||||||
|
time_now_iso8601(),
|
||||||
|
self._language_enum,
|
||||||
|
)
|
||||||
|
transcription_found = True
|
||||||
|
|
||||||
|
await self._handle_transcription(text, True, self._language_enum)
|
||||||
|
|
||||||
|
if not transcription_found:
|
||||||
|
logger.debug("No transcription results found in NVIDIA Riva response")
|
||||||
|
|
||||||
|
except AttributeError as ae:
|
||||||
|
logger.error(f"Unexpected response structure from NVIDIA Riva: {ae}")
|
||||||
|
yield ErrorFrame(f"Unexpected NVIDIA Riva response format: {str(ae)}")
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"{self} exception: {e}")
|
||||||
|
yield ErrorFrame(error=f"{self} error: {e}")
|
||||||
187
src/pipecat/services/nvidia/tts.py
Normal file
187
src/pipecat/services/nvidia/tts.py
Normal file
@@ -0,0 +1,187 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2024–2025, Daily
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: BSD 2-Clause License
|
||||||
|
#
|
||||||
|
|
||||||
|
"""NVIDIA Riva text-to-speech service implementation.
|
||||||
|
|
||||||
|
This module provides integration with NVIDIA Riva's TTS services through
|
||||||
|
gRPC API for high-quality speech synthesis.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import os
|
||||||
|
from typing import AsyncGenerator, Mapping, Optional
|
||||||
|
|
||||||
|
from pipecat.utils.tracing.service_decorators import traced_tts
|
||||||
|
|
||||||
|
# Suppress gRPC fork warnings
|
||||||
|
os.environ["GRPC_ENABLE_FORK_SUPPORT"] = "false"
|
||||||
|
|
||||||
|
from loguru import logger
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
from pipecat.frames.frames import (
|
||||||
|
ErrorFrame,
|
||||||
|
Frame,
|
||||||
|
TTSAudioRawFrame,
|
||||||
|
TTSStartedFrame,
|
||||||
|
TTSStoppedFrame,
|
||||||
|
)
|
||||||
|
from pipecat.services.tts_service import TTSService
|
||||||
|
from pipecat.transcriptions.language import Language
|
||||||
|
|
||||||
|
try:
|
||||||
|
import riva.client
|
||||||
|
|
||||||
|
except ModuleNotFoundError as e:
|
||||||
|
logger.error(f"Exception: {e}")
|
||||||
|
logger.error("In order to use NVIDIA Riva TTS, you need to `pip install pipecat-ai[nvidia]`.")
|
||||||
|
raise Exception(f"Missing module: {e}")
|
||||||
|
|
||||||
|
NVIDIA_TTS_TIMEOUT_SECS = 5
|
||||||
|
|
||||||
|
|
||||||
|
class NvidiaTTSService(TTSService):
|
||||||
|
"""NVIDIA Riva text-to-speech service.
|
||||||
|
|
||||||
|
Provides high-quality text-to-speech synthesis using NVIDIA Riva's
|
||||||
|
cloud-based TTS models. Supports multiple voices, languages, and
|
||||||
|
configurable quality settings.
|
||||||
|
"""
|
||||||
|
|
||||||
|
class InputParams(BaseModel):
|
||||||
|
"""Input parameters for Riva TTS configuration.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
language: Language code for synthesis. Defaults to US English.
|
||||||
|
quality: Audio quality setting (0-100). Defaults to 20.
|
||||||
|
"""
|
||||||
|
|
||||||
|
language: Optional[Language] = Language.EN_US
|
||||||
|
quality: Optional[int] = 20
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
api_key: str,
|
||||||
|
server: str = "grpc.nvcf.nvidia.com:443",
|
||||||
|
voice_id: str = "Magpie-Multilingual.EN-US.Aria",
|
||||||
|
sample_rate: Optional[int] = None,
|
||||||
|
model_function_map: Mapping[str, str] = {
|
||||||
|
"function_id": "877104f7-e885-42b9-8de8-f6e4c6303969",
|
||||||
|
"model_name": "magpie-tts-multilingual",
|
||||||
|
},
|
||||||
|
params: Optional[InputParams] = None,
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
"""Initialize the NVIDIA Riva TTS service.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
api_key: NVIDIA API key for authentication.
|
||||||
|
server: gRPC server endpoint. Defaults to NVIDIA's cloud endpoint.
|
||||||
|
voice_id: Voice model identifier. Defaults to multilingual Ray voice.
|
||||||
|
sample_rate: Audio sample rate. If None, uses service default.
|
||||||
|
model_function_map: Dictionary containing function_id and model_name for the TTS model.
|
||||||
|
params: Additional configuration parameters for TTS synthesis.
|
||||||
|
**kwargs: Additional arguments passed to parent TTSService.
|
||||||
|
"""
|
||||||
|
super().__init__(sample_rate=sample_rate, **kwargs)
|
||||||
|
|
||||||
|
params = params or NvidiaTTSService.InputParams()
|
||||||
|
|
||||||
|
self._api_key = api_key
|
||||||
|
self._voice_id = voice_id
|
||||||
|
self._language_code = params.language
|
||||||
|
self._quality = params.quality
|
||||||
|
self._function_id = model_function_map.get("function_id")
|
||||||
|
|
||||||
|
self.set_model_name(model_function_map.get("model_name"))
|
||||||
|
self.set_voice(voice_id)
|
||||||
|
|
||||||
|
metadata = [
|
||||||
|
["function-id", self._function_id],
|
||||||
|
["authorization", f"Bearer {api_key}"],
|
||||||
|
]
|
||||||
|
auth = riva.client.Auth(None, True, server, metadata)
|
||||||
|
|
||||||
|
self._service = riva.client.SpeechSynthesisService(auth)
|
||||||
|
|
||||||
|
# warm up the service
|
||||||
|
config_response = self._service.stub.GetRivaSynthesisConfig(
|
||||||
|
riva.client.proto.riva_tts_pb2.RivaSynthesisConfigRequest()
|
||||||
|
)
|
||||||
|
|
||||||
|
async def set_model(self, model: str):
|
||||||
|
"""Attempt to set the TTS model.
|
||||||
|
|
||||||
|
Note: Model cannot be changed after initialization for Riva service.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
model: The model name to set (operation not supported).
|
||||||
|
"""
|
||||||
|
logger.warning(f"Cannot set model after initialization. Set model and function id like so:")
|
||||||
|
example = {"function_id": "<UUID>", "model_name": "<model_name>"}
|
||||||
|
logger.warning(
|
||||||
|
f"{self.__class__.__name__}(api_key=<api_key>, model_function_map={example})"
|
||||||
|
)
|
||||||
|
|
||||||
|
@traced_tts
|
||||||
|
async def run_tts(self, text: str) -> AsyncGenerator[Frame, None]:
|
||||||
|
"""Generate speech from text using NVIDIA Riva TTS.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
text: The text to synthesize into speech.
|
||||||
|
|
||||||
|
Yields:
|
||||||
|
Frame: Audio frames containing the synthesized speech data.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def read_audio_responses(queue: asyncio.Queue):
|
||||||
|
def add_response(r):
|
||||||
|
asyncio.run_coroutine_threadsafe(queue.put(r), self.get_event_loop())
|
||||||
|
|
||||||
|
try:
|
||||||
|
responses = self._service.synthesize_online(
|
||||||
|
text,
|
||||||
|
self._voice_id,
|
||||||
|
self._language_code,
|
||||||
|
sample_rate_hz=self.sample_rate,
|
||||||
|
zero_shot_audio_prompt_file=None,
|
||||||
|
zero_shot_quality=self._quality,
|
||||||
|
custom_dictionary={},
|
||||||
|
)
|
||||||
|
for r in responses:
|
||||||
|
add_response(r)
|
||||||
|
add_response(None)
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"{self} exception: {e}")
|
||||||
|
add_response(None)
|
||||||
|
|
||||||
|
await self.start_ttfb_metrics()
|
||||||
|
yield TTSStartedFrame()
|
||||||
|
|
||||||
|
logger.debug(f"{self}: Generating TTS [{text}]")
|
||||||
|
|
||||||
|
try:
|
||||||
|
queue = asyncio.Queue()
|
||||||
|
await asyncio.to_thread(read_audio_responses, queue)
|
||||||
|
|
||||||
|
# Wait for the thread to start.
|
||||||
|
resp = await asyncio.wait_for(queue.get(), timeout=NVIDIA_TTS_TIMEOUT_SECS)
|
||||||
|
while resp:
|
||||||
|
await self.stop_ttfb_metrics()
|
||||||
|
frame = TTSAudioRawFrame(
|
||||||
|
audio=resp.audio,
|
||||||
|
sample_rate=self.sample_rate,
|
||||||
|
num_channels=1,
|
||||||
|
)
|
||||||
|
yield frame
|
||||||
|
resp = await asyncio.wait_for(queue.get(), timeout=NVIDIA_TTS_TIMEOUT_SECS)
|
||||||
|
except asyncio.TimeoutError:
|
||||||
|
logger.error(f"{self} timeout waiting for audio response")
|
||||||
|
yield ErrorFrame(error=f"{self} error: {e}")
|
||||||
|
|
||||||
|
await self.start_tts_usage_metrics(text)
|
||||||
|
yield TTSStoppedFrame()
|
||||||
@@ -4,707 +4,32 @@
|
|||||||
# SPDX-License-Identifier: BSD 2-Clause License
|
# SPDX-License-Identifier: BSD 2-Clause License
|
||||||
#
|
#
|
||||||
|
|
||||||
"""NVIDIA Riva Speech-to-Text service implementations for real-time and batch transcription."""
|
"""NVIDIA Riva Speech-to-Text service implementations for real-time and batch transcription.
|
||||||
|
|
||||||
import asyncio
|
.. deprecated:: 0.0.96
|
||||||
from concurrent.futures import CancelledError as FuturesCancelledError
|
This module is deprecated. Please NvidiaSTTService from
|
||||||
from typing import AsyncGenerator, List, Mapping, Optional
|
pipecat.services.nvidia.stt instead.
|
||||||
|
"""
|
||||||
|
|
||||||
from loguru import logger
|
import warnings
|
||||||
from pydantic import BaseModel
|
|
||||||
|
|
||||||
from pipecat.frames.frames import (
|
from pipecat.services.nvidia.stt import (
|
||||||
CancelFrame,
|
NvidiaSegmentedSTTService,
|
||||||
EndFrame,
|
NvidiaSTTService,
|
||||||
ErrorFrame,
|
language_to_nvidia_riva_language,
|
||||||
Frame,
|
|
||||||
InterimTranscriptionFrame,
|
|
||||||
StartFrame,
|
|
||||||
TranscriptionFrame,
|
|
||||||
)
|
)
|
||||||
from pipecat.services.stt_service import SegmentedSTTService, STTService
|
|
||||||
from pipecat.transcriptions.language import Language, resolve_language
|
|
||||||
from pipecat.utils.time import time_now_iso8601
|
|
||||||
from pipecat.utils.tracing.service_decorators import traced_stt
|
|
||||||
|
|
||||||
try:
|
with warnings.catch_warnings():
|
||||||
import riva.client
|
warnings.simplefilter("always")
|
||||||
|
warnings.warn(
|
||||||
except ModuleNotFoundError as e:
|
"RivaSTTService and ParakeetSTTService "
|
||||||
logger.error(f"Exception: {e}")
|
"from pipecat.services.riva.stt is deprecated. "
|
||||||
logger.error("In order to use NVIDIA Riva STT, you need to `pip install pipecat-ai[riva]`.")
|
"Please use NvidiaSTTService from pipecat.services.nvidia.stt instead.",
|
||||||
raise Exception(f"Missing module: {e}")
|
DeprecationWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
def language_to_riva_language(language: Language) -> Optional[str]:
|
|
||||||
"""Maps Language enum to Riva ASR language codes.
|
RivaSTTService = NvidiaSTTService
|
||||||
|
language_to_riva_language = language_to_nvidia_riva_language
|
||||||
Source:
|
RivaSegmentedSTTService = NvidiaSegmentedSTTService
|
||||||
https://docs.nvidia.com/deeplearning/riva/user-guide/docs/asr/asr-riva-build-table.html?highlight=fr%20fr
|
ParakeetSTTService = NvidiaSTTService
|
||||||
|
|
||||||
Args:
|
|
||||||
language: Language enum value.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Optional[str]: Riva language code or None if not supported.
|
|
||||||
"""
|
|
||||||
LANGUAGE_MAP = {
|
|
||||||
# Arabic
|
|
||||||
Language.AR: "ar-AR",
|
|
||||||
# English
|
|
||||||
Language.EN: "en-US", # Default to US
|
|
||||||
Language.EN_US: "en-US",
|
|
||||||
Language.EN_GB: "en-GB",
|
|
||||||
# French
|
|
||||||
Language.FR: "fr-FR",
|
|
||||||
Language.FR_FR: "fr-FR",
|
|
||||||
# German
|
|
||||||
Language.DE: "de-DE",
|
|
||||||
Language.DE_DE: "de-DE",
|
|
||||||
# Hindi
|
|
||||||
Language.HI: "hi-IN",
|
|
||||||
Language.HI_IN: "hi-IN",
|
|
||||||
# Italian
|
|
||||||
Language.IT: "it-IT",
|
|
||||||
Language.IT_IT: "it-IT",
|
|
||||||
# Japanese
|
|
||||||
Language.JA: "ja-JP",
|
|
||||||
Language.JA_JP: "ja-JP",
|
|
||||||
# Korean
|
|
||||||
Language.KO: "ko-KR",
|
|
||||||
Language.KO_KR: "ko-KR",
|
|
||||||
# Portuguese
|
|
||||||
Language.PT: "pt-BR", # Default to Brazilian
|
|
||||||
Language.PT_BR: "pt-BR",
|
|
||||||
# Russian
|
|
||||||
Language.RU: "ru-RU",
|
|
||||||
Language.RU_RU: "ru-RU",
|
|
||||||
# Spanish
|
|
||||||
Language.ES: "es-ES", # Default to Spain
|
|
||||||
Language.ES_ES: "es-ES",
|
|
||||||
Language.ES_US: "es-US", # US Spanish
|
|
||||||
}
|
|
||||||
|
|
||||||
return resolve_language(language, LANGUAGE_MAP, use_base_code=False)
|
|
||||||
|
|
||||||
|
|
||||||
class RivaSTTService(STTService):
|
|
||||||
"""Real-time speech-to-text service using NVIDIA Riva streaming ASR.
|
|
||||||
|
|
||||||
Provides real-time transcription capabilities using NVIDIA's Riva ASR models
|
|
||||||
through streaming recognition. Supports interim results and continuous audio
|
|
||||||
processing for low-latency applications.
|
|
||||||
"""
|
|
||||||
|
|
||||||
class InputParams(BaseModel):
|
|
||||||
"""Configuration parameters for Riva STT service.
|
|
||||||
|
|
||||||
Parameters:
|
|
||||||
language: Target language for transcription. Defaults to EN_US.
|
|
||||||
"""
|
|
||||||
|
|
||||||
language: Optional[Language] = Language.EN_US
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
api_key: str,
|
|
||||||
server: str = "grpc.nvcf.nvidia.com:443",
|
|
||||||
model_function_map: Mapping[str, str] = {
|
|
||||||
"function_id": "1598d209-5e27-4d3c-8079-4751568b1081",
|
|
||||||
"model_name": "parakeet-ctc-1.1b-asr",
|
|
||||||
},
|
|
||||||
sample_rate: Optional[int] = None,
|
|
||||||
params: Optional[InputParams] = None,
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
"""Initialize the Riva STT service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
api_key: NVIDIA API key for authentication.
|
|
||||||
server: Riva server address. Defaults to NVIDIA Cloud Function endpoint.
|
|
||||||
model_function_map: Mapping containing 'function_id' and 'model_name' for the ASR model.
|
|
||||||
sample_rate: Audio sample rate in Hz. If None, uses pipeline default.
|
|
||||||
params: Additional configuration parameters for Riva.
|
|
||||||
**kwargs: Additional arguments passed to STTService.
|
|
||||||
"""
|
|
||||||
super().__init__(sample_rate=sample_rate, **kwargs)
|
|
||||||
|
|
||||||
params = params or RivaSTTService.InputParams()
|
|
||||||
|
|
||||||
self._api_key = api_key
|
|
||||||
self._profanity_filter = False
|
|
||||||
self._automatic_punctuation = True
|
|
||||||
self._no_verbatim_transcripts = False
|
|
||||||
self._language_code = params.language
|
|
||||||
self._boosted_lm_words = None
|
|
||||||
self._boosted_lm_score = 4.0
|
|
||||||
self._start_history = -1
|
|
||||||
self._start_threshold = -1.0
|
|
||||||
self._stop_history = -1
|
|
||||||
self._stop_threshold = -1.0
|
|
||||||
self._stop_history_eou = -1
|
|
||||||
self._stop_threshold_eou = -1.0
|
|
||||||
self._custom_configuration = ""
|
|
||||||
self._function_id = model_function_map.get("function_id")
|
|
||||||
|
|
||||||
self._settings = {
|
|
||||||
"language": str(params.language),
|
|
||||||
"profanity_filter": self._profanity_filter,
|
|
||||||
"automatic_punctuation": self._automatic_punctuation,
|
|
||||||
"verbatim_transcripts": not self._no_verbatim_transcripts,
|
|
||||||
"boosted_lm_words": self._boosted_lm_words,
|
|
||||||
"boosted_lm_score": self._boosted_lm_score,
|
|
||||||
}
|
|
||||||
|
|
||||||
self.set_model_name(model_function_map.get("model_name"))
|
|
||||||
|
|
||||||
metadata = [
|
|
||||||
["function-id", self._function_id],
|
|
||||||
["authorization", f"Bearer {api_key}"],
|
|
||||||
]
|
|
||||||
auth = riva.client.Auth(None, True, server, metadata)
|
|
||||||
|
|
||||||
self._asr_service = riva.client.ASRService(auth)
|
|
||||||
|
|
||||||
self._queue = None
|
|
||||||
self._config = None
|
|
||||||
self._thread_task = None
|
|
||||||
self._response_task = None
|
|
||||||
|
|
||||||
def can_generate_metrics(self) -> bool:
|
|
||||||
"""Check if this service can generate processing metrics.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
False - this service does not support metrics generation.
|
|
||||||
"""
|
|
||||||
return False
|
|
||||||
|
|
||||||
async def set_model(self, model: str):
|
|
||||||
"""Set the ASR model for transcription.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
model: Model name to set.
|
|
||||||
|
|
||||||
Note:
|
|
||||||
Model cannot be changed after initialization. Use model_function_map
|
|
||||||
parameter in constructor instead.
|
|
||||||
"""
|
|
||||||
logger.warning(f"Cannot set model after initialization. Set model and function id like so:")
|
|
||||||
example = {"function_id": "<UUID>", "model_name": "<model_name>"}
|
|
||||||
logger.warning(
|
|
||||||
f"{self.__class__.__name__}(api_key=<api_key>, model_function_map={example})"
|
|
||||||
)
|
|
||||||
|
|
||||||
async def start(self, frame: StartFrame):
|
|
||||||
"""Start the Riva STT service and initialize streaming configuration.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
frame: StartFrame indicating pipeline start.
|
|
||||||
"""
|
|
||||||
await super().start(frame)
|
|
||||||
|
|
||||||
if self._config:
|
|
||||||
return
|
|
||||||
|
|
||||||
config = riva.client.StreamingRecognitionConfig(
|
|
||||||
config=riva.client.RecognitionConfig(
|
|
||||||
encoding=riva.client.AudioEncoding.LINEAR_PCM,
|
|
||||||
language_code=self._language_code,
|
|
||||||
model="",
|
|
||||||
max_alternatives=1,
|
|
||||||
profanity_filter=self._profanity_filter,
|
|
||||||
enable_automatic_punctuation=self._automatic_punctuation,
|
|
||||||
verbatim_transcripts=not self._no_verbatim_transcripts,
|
|
||||||
sample_rate_hertz=self.sample_rate,
|
|
||||||
audio_channel_count=1,
|
|
||||||
),
|
|
||||||
interim_results=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
riva.client.add_word_boosting_to_config(
|
|
||||||
config, self._boosted_lm_words, self._boosted_lm_score
|
|
||||||
)
|
|
||||||
|
|
||||||
riva.client.add_endpoint_parameters_to_config(
|
|
||||||
config,
|
|
||||||
self._start_history,
|
|
||||||
self._start_threshold,
|
|
||||||
self._stop_history,
|
|
||||||
self._stop_history_eou,
|
|
||||||
self._stop_threshold,
|
|
||||||
self._stop_threshold_eou,
|
|
||||||
)
|
|
||||||
riva.client.add_custom_configuration_to_config(config, self._custom_configuration)
|
|
||||||
|
|
||||||
self._config = config
|
|
||||||
self._queue = asyncio.Queue()
|
|
||||||
|
|
||||||
if not self._thread_task:
|
|
||||||
self._thread_task = self.create_task(self._thread_task_handler())
|
|
||||||
|
|
||||||
if not self._response_task:
|
|
||||||
self._response_queue = asyncio.Queue()
|
|
||||||
self._response_task = self.create_task(self._response_task_handler())
|
|
||||||
|
|
||||||
async def stop(self, frame: EndFrame):
|
|
||||||
"""Stop the Riva STT service and clean up resources.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
frame: EndFrame indicating pipeline stop.
|
|
||||||
"""
|
|
||||||
await super().stop(frame)
|
|
||||||
await self._stop_tasks()
|
|
||||||
|
|
||||||
async def cancel(self, frame: CancelFrame):
|
|
||||||
"""Cancel the Riva STT service operation.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
frame: CancelFrame indicating operation cancellation.
|
|
||||||
"""
|
|
||||||
await super().cancel(frame)
|
|
||||||
await self._stop_tasks()
|
|
||||||
|
|
||||||
async def _stop_tasks(self):
|
|
||||||
if self._thread_task:
|
|
||||||
await self.cancel_task(self._thread_task)
|
|
||||||
self._thread_task = None
|
|
||||||
|
|
||||||
if self._response_task:
|
|
||||||
await self.cancel_task(self._response_task)
|
|
||||||
self._response_task = None
|
|
||||||
|
|
||||||
def _response_handler(self):
|
|
||||||
responses = self._asr_service.streaming_response_generator(
|
|
||||||
audio_chunks=self,
|
|
||||||
streaming_config=self._config,
|
|
||||||
)
|
|
||||||
for response in responses:
|
|
||||||
if not response.results:
|
|
||||||
continue
|
|
||||||
asyncio.run_coroutine_threadsafe(
|
|
||||||
self._response_queue.put(response), self.get_event_loop()
|
|
||||||
)
|
|
||||||
|
|
||||||
async def _thread_task_handler(self):
|
|
||||||
try:
|
|
||||||
self._thread_running = True
|
|
||||||
await asyncio.to_thread(self._response_handler)
|
|
||||||
except asyncio.CancelledError:
|
|
||||||
self._thread_running = False
|
|
||||||
raise
|
|
||||||
|
|
||||||
@traced_stt
|
|
||||||
async def _handle_transcription(
|
|
||||||
self, transcript: str, is_final: bool, language: Optional[Language] = None
|
|
||||||
):
|
|
||||||
"""Handle a transcription result with tracing."""
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def _handle_response(self, response):
|
|
||||||
for result in response.results:
|
|
||||||
if result and not result.alternatives:
|
|
||||||
continue
|
|
||||||
|
|
||||||
transcript = result.alternatives[0].transcript
|
|
||||||
if transcript and len(transcript) > 0:
|
|
||||||
await self.stop_ttfb_metrics()
|
|
||||||
if result.is_final:
|
|
||||||
await self.stop_processing_metrics()
|
|
||||||
await self.push_frame(
|
|
||||||
TranscriptionFrame(
|
|
||||||
transcript,
|
|
||||||
self._user_id,
|
|
||||||
time_now_iso8601(),
|
|
||||||
self._language_code,
|
|
||||||
result=result,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
await self._handle_transcription(
|
|
||||||
transcript=transcript,
|
|
||||||
is_final=result.is_final,
|
|
||||||
language=self._language_code,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
await self.push_frame(
|
|
||||||
InterimTranscriptionFrame(
|
|
||||||
transcript,
|
|
||||||
self._user_id,
|
|
||||||
time_now_iso8601(),
|
|
||||||
self._language_code,
|
|
||||||
result=result,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
async def _response_task_handler(self):
|
|
||||||
while True:
|
|
||||||
response = await self._response_queue.get()
|
|
||||||
await self._handle_response(response)
|
|
||||||
self._response_queue.task_done()
|
|
||||||
|
|
||||||
async def run_stt(self, audio: bytes) -> AsyncGenerator[Frame, None]:
|
|
||||||
"""Process audio data for speech-to-text transcription.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
audio: Raw audio bytes to transcribe.
|
|
||||||
|
|
||||||
Yields:
|
|
||||||
None - transcription results are pushed to the pipeline via frames.
|
|
||||||
"""
|
|
||||||
await self.start_ttfb_metrics()
|
|
||||||
await self.start_processing_metrics()
|
|
||||||
await self._queue.put(audio)
|
|
||||||
yield None
|
|
||||||
|
|
||||||
def __next__(self) -> bytes:
|
|
||||||
"""Get the next audio chunk for Riva processing.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Audio bytes from the queue.
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
StopIteration: When the thread is no longer running.
|
|
||||||
"""
|
|
||||||
if not self._thread_running:
|
|
||||||
raise StopIteration
|
|
||||||
|
|
||||||
try:
|
|
||||||
future = asyncio.run_coroutine_threadsafe(self._queue.get(), self.get_event_loop())
|
|
||||||
return future.result()
|
|
||||||
except FuturesCancelledError:
|
|
||||||
raise StopIteration
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
"""Return iterator for audio chunk processing.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Self as iterator.
|
|
||||||
"""
|
|
||||||
return self
|
|
||||||
|
|
||||||
|
|
||||||
class RivaSegmentedSTTService(SegmentedSTTService):
|
|
||||||
"""Speech-to-text service using NVIDIA Riva's offline/batch models.
|
|
||||||
|
|
||||||
By default, his service uses NVIDIA's Riva Canary ASR API to perform speech-to-text
|
|
||||||
transcription on audio segments. It inherits from SegmentedSTTService to handle
|
|
||||||
audio buffering and speech detection.
|
|
||||||
"""
|
|
||||||
|
|
||||||
class InputParams(BaseModel):
|
|
||||||
"""Configuration parameters for Riva segmented STT service.
|
|
||||||
|
|
||||||
Parameters:
|
|
||||||
language: Target language for transcription. Defaults to EN_US.
|
|
||||||
profanity_filter: Whether to filter profanity from results.
|
|
||||||
automatic_punctuation: Whether to add automatic punctuation.
|
|
||||||
verbatim_transcripts: Whether to return verbatim transcripts.
|
|
||||||
boosted_lm_words: List of words to boost in language model.
|
|
||||||
boosted_lm_score: Score boost for specified words.
|
|
||||||
"""
|
|
||||||
|
|
||||||
language: Optional[Language] = Language.EN_US
|
|
||||||
profanity_filter: bool = False
|
|
||||||
automatic_punctuation: bool = True
|
|
||||||
verbatim_transcripts: bool = False
|
|
||||||
boosted_lm_words: Optional[List[str]] = None
|
|
||||||
boosted_lm_score: float = 4.0
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
api_key: str,
|
|
||||||
server: str = "grpc.nvcf.nvidia.com:443",
|
|
||||||
model_function_map: Mapping[str, str] = {
|
|
||||||
"function_id": "ee8dc628-76de-4acc-8595-1836e7e857bd",
|
|
||||||
"model_name": "canary-1b-asr",
|
|
||||||
},
|
|
||||||
sample_rate: Optional[int] = None,
|
|
||||||
params: Optional[InputParams] = None,
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
"""Initialize the Riva segmented STT service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
api_key: NVIDIA API key for authentication
|
|
||||||
server: Riva server address (defaults to NVIDIA Cloud Function endpoint)
|
|
||||||
model_function_map: Mapping of model name and its corresponding NVIDIA Cloud Function ID
|
|
||||||
sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate
|
|
||||||
params: Additional configuration parameters for Riva
|
|
||||||
**kwargs: Additional arguments passed to SegmentedSTTService
|
|
||||||
"""
|
|
||||||
super().__init__(sample_rate=sample_rate, **kwargs)
|
|
||||||
|
|
||||||
params = params or RivaSegmentedSTTService.InputParams()
|
|
||||||
|
|
||||||
# Set model name
|
|
||||||
self.set_model_name(model_function_map.get("model_name"))
|
|
||||||
|
|
||||||
# Initialize Riva settings
|
|
||||||
self._api_key = api_key
|
|
||||||
self._server = server
|
|
||||||
self._function_id = model_function_map.get("function_id")
|
|
||||||
self._model_name = model_function_map.get("model_name")
|
|
||||||
|
|
||||||
# Store the language as a Language enum and as a string
|
|
||||||
self._language_enum = params.language or Language.EN_US
|
|
||||||
self._language = self.language_to_service_language(self._language_enum) or "en-US"
|
|
||||||
|
|
||||||
# Configure transcription parameters
|
|
||||||
self._profanity_filter = params.profanity_filter
|
|
||||||
self._automatic_punctuation = params.automatic_punctuation
|
|
||||||
self._verbatim_transcripts = params.verbatim_transcripts
|
|
||||||
self._boosted_lm_words = params.boosted_lm_words
|
|
||||||
self._boosted_lm_score = params.boosted_lm_score
|
|
||||||
|
|
||||||
# Voice activity detection thresholds (use Riva defaults)
|
|
||||||
self._start_history = -1
|
|
||||||
self._start_threshold = -1.0
|
|
||||||
self._stop_history = -1
|
|
||||||
self._stop_threshold = -1.0
|
|
||||||
self._stop_history_eou = -1
|
|
||||||
self._stop_threshold_eou = -1.0
|
|
||||||
self._custom_configuration = ""
|
|
||||||
|
|
||||||
# Create Riva client
|
|
||||||
self._config = None
|
|
||||||
self._asr_service = None
|
|
||||||
self._settings = {"language": self._language_enum}
|
|
||||||
|
|
||||||
def language_to_service_language(self, language: Language) -> Optional[str]:
|
|
||||||
"""Convert pipecat Language enum to Riva's language code.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
language: Language enum value.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Riva language code or None if not supported.
|
|
||||||
"""
|
|
||||||
return language_to_riva_language(language)
|
|
||||||
|
|
||||||
def _initialize_client(self):
|
|
||||||
"""Initialize the Riva ASR client with authentication metadata."""
|
|
||||||
if self._asr_service is not None:
|
|
||||||
return
|
|
||||||
|
|
||||||
# Set up authentication metadata for NVIDIA Cloud Functions
|
|
||||||
metadata = [
|
|
||||||
["function-id", self._function_id],
|
|
||||||
["authorization", f"Bearer {self._api_key}"],
|
|
||||||
]
|
|
||||||
|
|
||||||
# Create authenticated client
|
|
||||||
auth = riva.client.Auth(None, True, self._server, metadata)
|
|
||||||
self._asr_service = riva.client.ASRService(auth)
|
|
||||||
|
|
||||||
logger.info(f"Initialized RivaSegmentedSTTService with model: {self.model_name}")
|
|
||||||
|
|
||||||
def _create_recognition_config(self):
|
|
||||||
"""Create the Riva ASR recognition configuration."""
|
|
||||||
# Create base configuration
|
|
||||||
config = riva.client.RecognitionConfig(
|
|
||||||
language_code=self._language, # Now using the string, not a tuple
|
|
||||||
max_alternatives=1,
|
|
||||||
profanity_filter=self._profanity_filter,
|
|
||||||
enable_automatic_punctuation=self._automatic_punctuation,
|
|
||||||
verbatim_transcripts=self._verbatim_transcripts,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Add word boosting if specified
|
|
||||||
if self._boosted_lm_words:
|
|
||||||
riva.client.add_word_boosting_to_config(
|
|
||||||
config, self._boosted_lm_words, self._boosted_lm_score
|
|
||||||
)
|
|
||||||
|
|
||||||
# Add voice activity detection parameters
|
|
||||||
riva.client.add_endpoint_parameters_to_config(
|
|
||||||
config,
|
|
||||||
self._start_history,
|
|
||||||
self._start_threshold,
|
|
||||||
self._stop_history,
|
|
||||||
self._stop_history_eou,
|
|
||||||
self._stop_threshold,
|
|
||||||
self._stop_threshold_eou,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Add any custom configuration
|
|
||||||
if self._custom_configuration:
|
|
||||||
riva.client.add_custom_configuration_to_config(config, self._custom_configuration)
|
|
||||||
|
|
||||||
return config
|
|
||||||
|
|
||||||
def can_generate_metrics(self) -> bool:
|
|
||||||
"""Check if this service can generate processing metrics.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
True - this service supports metrics generation.
|
|
||||||
"""
|
|
||||||
return True
|
|
||||||
|
|
||||||
async def set_model(self, model: str):
|
|
||||||
"""Set the ASR model for transcription.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
model: Model name to set.
|
|
||||||
|
|
||||||
Note:
|
|
||||||
Model cannot be changed after initialization. Use model_function_map
|
|
||||||
parameter in constructor instead.
|
|
||||||
"""
|
|
||||||
logger.warning(f"Cannot set model after initialization. Set model and function id like so:")
|
|
||||||
example = {"function_id": "<UUID>", "model_name": "<model_name>"}
|
|
||||||
logger.warning(
|
|
||||||
f"{self.__class__.__name__}(api_key=<api_key>, model_function_map={example})"
|
|
||||||
)
|
|
||||||
|
|
||||||
async def start(self, frame: StartFrame):
|
|
||||||
"""Initialize the service when the pipeline starts.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
frame: StartFrame indicating pipeline start.
|
|
||||||
"""
|
|
||||||
await super().start(frame)
|
|
||||||
self._initialize_client()
|
|
||||||
self._config = self._create_recognition_config()
|
|
||||||
|
|
||||||
async def set_language(self, language: Language):
|
|
||||||
"""Set the language for the STT service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
language: Target language for transcription.
|
|
||||||
"""
|
|
||||||
logger.info(f"Switching STT language to: [{language}]")
|
|
||||||
self._language_enum = language
|
|
||||||
self._language = self.language_to_service_language(language) or "en-US"
|
|
||||||
self._settings["language"] = language
|
|
||||||
|
|
||||||
# Update configuration with new language
|
|
||||||
if self._config:
|
|
||||||
self._config.language_code = self._language
|
|
||||||
|
|
||||||
@traced_stt
|
|
||||||
async def _handle_transcription(
|
|
||||||
self, transcript: str, is_final: bool, language: Optional[Language] = None
|
|
||||||
):
|
|
||||||
"""Handle a transcription result with tracing."""
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def run_stt(self, audio: bytes) -> AsyncGenerator[Frame, None]:
|
|
||||||
"""Transcribe an audio segment.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
audio: Raw audio bytes in WAV format (already converted by base class).
|
|
||||||
|
|
||||||
Yields:
|
|
||||||
Frame: TranscriptionFrame containing the transcribed text.
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
await self.start_processing_metrics()
|
|
||||||
await self.start_ttfb_metrics()
|
|
||||||
|
|
||||||
# Make sure the client is initialized
|
|
||||||
if self._asr_service is None:
|
|
||||||
self._initialize_client()
|
|
||||||
|
|
||||||
# Make sure the config is created
|
|
||||||
if self._config is None:
|
|
||||||
self._config = self._create_recognition_config()
|
|
||||||
|
|
||||||
# Type assertion to satisfy the IDE
|
|
||||||
assert self._asr_service is not None, "ASR service not initialized"
|
|
||||||
assert self._config is not None, "Recognition config not created"
|
|
||||||
|
|
||||||
# Process audio with Riva ASR - explicitly request non-future response
|
|
||||||
raw_response = self._asr_service.offline_recognize(audio, self._config, future=False)
|
|
||||||
|
|
||||||
await self.stop_ttfb_metrics()
|
|
||||||
await self.stop_processing_metrics()
|
|
||||||
|
|
||||||
# Process the response - handle different possible return types
|
|
||||||
try:
|
|
||||||
# If it's a future-like object, get the result
|
|
||||||
if hasattr(raw_response, "result"):
|
|
||||||
response = raw_response.result()
|
|
||||||
else:
|
|
||||||
response = raw_response
|
|
||||||
|
|
||||||
# Process transcription results
|
|
||||||
transcription_found = False
|
|
||||||
|
|
||||||
# Now we can safely check results
|
|
||||||
# Type hint for the IDE
|
|
||||||
results = getattr(response, "results", [])
|
|
||||||
|
|
||||||
for result in results:
|
|
||||||
alternatives = getattr(result, "alternatives", [])
|
|
||||||
if alternatives:
|
|
||||||
text = alternatives[0].transcript.strip()
|
|
||||||
if text:
|
|
||||||
logger.debug(f"Transcription: [{text}]")
|
|
||||||
yield TranscriptionFrame(
|
|
||||||
text,
|
|
||||||
self._user_id,
|
|
||||||
time_now_iso8601(),
|
|
||||||
self._language_enum,
|
|
||||||
)
|
|
||||||
transcription_found = True
|
|
||||||
|
|
||||||
await self._handle_transcription(text, True, self._language_enum)
|
|
||||||
|
|
||||||
if not transcription_found:
|
|
||||||
logger.debug("No transcription results found in Riva response")
|
|
||||||
|
|
||||||
except AttributeError as ae:
|
|
||||||
yield ErrorFrame(f"Unexpected Riva response format: {str(ae)}")
|
|
||||||
|
|
||||||
except Exception as e:
|
|
||||||
yield ErrorFrame(error=f"Unknown error occurred: {e}")
|
|
||||||
|
|
||||||
|
|
||||||
class ParakeetSTTService(RivaSTTService):
|
|
||||||
"""Deprecated speech-to-text service using NVIDIA Parakeet models.
|
|
||||||
|
|
||||||
.. deprecated:: 0.0.66
|
|
||||||
This class is deprecated. Use `RivaSTTService` instead for equivalent functionality
|
|
||||||
with Parakeet models by specifying the appropriate model_function_map.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
api_key: str,
|
|
||||||
server: str = "grpc.nvcf.nvidia.com:443",
|
|
||||||
model_function_map: Mapping[str, str] = {
|
|
||||||
"function_id": "1598d209-5e27-4d3c-8079-4751568b1081",
|
|
||||||
"model_name": "parakeet-ctc-1.1b-asr",
|
|
||||||
},
|
|
||||||
sample_rate: Optional[int] = None,
|
|
||||||
params: Optional[RivaSTTService.InputParams] = None, # Use parent class's type
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
"""Initialize the Parakeet STT service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
api_key: NVIDIA API key for authentication.
|
|
||||||
server: Riva server address. Defaults to NVIDIA Cloud Function endpoint.
|
|
||||||
model_function_map: Mapping containing 'function_id' and 'model_name' for Parakeet model.
|
|
||||||
sample_rate: Audio sample rate in Hz. If None, uses pipeline default.
|
|
||||||
params: Additional configuration parameters for Riva.
|
|
||||||
**kwargs: Additional arguments passed to RivaSTTService.
|
|
||||||
"""
|
|
||||||
super().__init__(
|
|
||||||
api_key=api_key,
|
|
||||||
server=server,
|
|
||||||
model_function_map=model_function_map,
|
|
||||||
sample_rate=sample_rate,
|
|
||||||
params=params,
|
|
||||||
**kwargs,
|
|
||||||
)
|
|
||||||
import warnings
|
|
||||||
|
|
||||||
with warnings.catch_warnings():
|
|
||||||
warnings.simplefilter("always")
|
|
||||||
warnings.warn(
|
|
||||||
"`ParakeetSTTService` is deprecated, use `RivaSTTService` instead.",
|
|
||||||
DeprecationWarning,
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -8,231 +8,26 @@
|
|||||||
|
|
||||||
This module provides integration with NVIDIA Riva's TTS services through
|
This module provides integration with NVIDIA Riva's TTS services through
|
||||||
gRPC API for high-quality speech synthesis.
|
gRPC API for high-quality speech synthesis.
|
||||||
|
|
||||||
|
.. deprecated:: 0.0.96
|
||||||
|
This module is deprecated. Please NvidiaTTSService from
|
||||||
|
pipecat.services.nvidia.tts instead.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import asyncio
|
import warnings
|
||||||
import os
|
|
||||||
from typing import AsyncGenerator, Mapping, Optional
|
|
||||||
|
|
||||||
from pipecat.utils.tracing.service_decorators import traced_tts
|
from pipecat.services.nvidia.tts import NVIDIA_TTS_TIMEOUT_SECS, NvidiaTTSService
|
||||||
|
|
||||||
# Suppress gRPC fork warnings
|
with warnings.catch_warnings():
|
||||||
os.environ["GRPC_ENABLE_FORK_SUPPORT"] = "false"
|
warnings.simplefilter("always")
|
||||||
|
warnings.warn(
|
||||||
|
"FastPitchTTSService and RivaTTSService "
|
||||||
|
"from pipecat.services.nim.llm are deprecated. "
|
||||||
|
"Please use NvidiaLLMService from pipecat.services.nvidia.tts instead.",
|
||||||
|
DeprecationWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
|
|
||||||
from loguru import logger
|
RivaTTSService = NvidiaTTSService
|
||||||
from pydantic import BaseModel
|
FastPitchTTSService = NvidiaTTSService
|
||||||
|
RIVA_TTS_TIMEOUT_SECS = NVIDIA_TTS_TIMEOUT_SECS
|
||||||
from pipecat.frames.frames import (
|
|
||||||
ErrorFrame,
|
|
||||||
Frame,
|
|
||||||
TTSAudioRawFrame,
|
|
||||||
TTSStartedFrame,
|
|
||||||
TTSStoppedFrame,
|
|
||||||
)
|
|
||||||
from pipecat.services.tts_service import TTSService
|
|
||||||
from pipecat.transcriptions.language import Language
|
|
||||||
|
|
||||||
try:
|
|
||||||
import riva.client
|
|
||||||
|
|
||||||
except ModuleNotFoundError as e:
|
|
||||||
logger.error(f"Exception: {e}")
|
|
||||||
logger.error("In order to use NVIDIA Riva TTS, you need to `pip install pipecat-ai[riva]`.")
|
|
||||||
raise Exception(f"Missing module: {e}")
|
|
||||||
|
|
||||||
RIVA_TTS_TIMEOUT_SECS = 5
|
|
||||||
|
|
||||||
|
|
||||||
class RivaTTSService(TTSService):
|
|
||||||
"""NVIDIA Riva text-to-speech service.
|
|
||||||
|
|
||||||
Provides high-quality text-to-speech synthesis using NVIDIA Riva's
|
|
||||||
cloud-based TTS models. Supports multiple voices, languages, and
|
|
||||||
configurable quality settings.
|
|
||||||
"""
|
|
||||||
|
|
||||||
class InputParams(BaseModel):
|
|
||||||
"""Input parameters for Riva TTS configuration.
|
|
||||||
|
|
||||||
Parameters:
|
|
||||||
language: Language code for synthesis. Defaults to US English.
|
|
||||||
quality: Audio quality setting (0-100). Defaults to 20.
|
|
||||||
"""
|
|
||||||
|
|
||||||
language: Optional[Language] = Language.EN_US
|
|
||||||
quality: Optional[int] = 20
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
api_key: str,
|
|
||||||
server: str = "grpc.nvcf.nvidia.com:443",
|
|
||||||
voice_id: str = "Magpie-Multilingual.EN-US.Aria",
|
|
||||||
sample_rate: Optional[int] = None,
|
|
||||||
model_function_map: Mapping[str, str] = {
|
|
||||||
"function_id": "877104f7-e885-42b9-8de8-f6e4c6303969",
|
|
||||||
"model_name": "magpie-tts-multilingual",
|
|
||||||
},
|
|
||||||
params: Optional[InputParams] = None,
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
"""Initialize the NVIDIA Riva TTS service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
api_key: NVIDIA API key for authentication.
|
|
||||||
server: gRPC server endpoint. Defaults to NVIDIA's cloud endpoint.
|
|
||||||
voice_id: Voice model identifier. Defaults to multilingual Ray voice.
|
|
||||||
sample_rate: Audio sample rate. If None, uses service default.
|
|
||||||
model_function_map: Dictionary containing function_id and model_name for the TTS model.
|
|
||||||
params: Additional configuration parameters for TTS synthesis.
|
|
||||||
**kwargs: Additional arguments passed to parent TTSService.
|
|
||||||
"""
|
|
||||||
super().__init__(sample_rate=sample_rate, **kwargs)
|
|
||||||
|
|
||||||
params = params or RivaTTSService.InputParams()
|
|
||||||
|
|
||||||
self._api_key = api_key
|
|
||||||
self._voice_id = voice_id
|
|
||||||
self._language_code = params.language
|
|
||||||
self._quality = params.quality
|
|
||||||
self._function_id = model_function_map.get("function_id")
|
|
||||||
|
|
||||||
self.set_model_name(model_function_map.get("model_name"))
|
|
||||||
self.set_voice(voice_id)
|
|
||||||
|
|
||||||
metadata = [
|
|
||||||
["function-id", self._function_id],
|
|
||||||
["authorization", f"Bearer {api_key}"],
|
|
||||||
]
|
|
||||||
auth = riva.client.Auth(None, True, server, metadata)
|
|
||||||
|
|
||||||
self._service = riva.client.SpeechSynthesisService(auth)
|
|
||||||
|
|
||||||
# warm up the service
|
|
||||||
config_response = self._service.stub.GetRivaSynthesisConfig(
|
|
||||||
riva.client.proto.riva_tts_pb2.RivaSynthesisConfigRequest()
|
|
||||||
)
|
|
||||||
|
|
||||||
async def set_model(self, model: str):
|
|
||||||
"""Attempt to set the TTS model.
|
|
||||||
|
|
||||||
Note: Model cannot be changed after initialization for Riva service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
model: The model name to set (operation not supported).
|
|
||||||
"""
|
|
||||||
logger.warning(f"Cannot set model after initialization. Set model and function id like so:")
|
|
||||||
example = {"function_id": "<UUID>", "model_name": "<model_name>"}
|
|
||||||
logger.warning(
|
|
||||||
f"{self.__class__.__name__}(api_key=<api_key>, model_function_map={example})"
|
|
||||||
)
|
|
||||||
|
|
||||||
@traced_tts
|
|
||||||
async def run_tts(self, text: str) -> AsyncGenerator[Frame, None]:
|
|
||||||
"""Generate speech from text using NVIDIA Riva TTS.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
text: The text to synthesize into speech.
|
|
||||||
|
|
||||||
Yields:
|
|
||||||
Frame: Audio frames containing the synthesized speech data.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def read_audio_responses(queue: asyncio.Queue):
|
|
||||||
def add_response(r):
|
|
||||||
asyncio.run_coroutine_threadsafe(queue.put(r), self.get_event_loop())
|
|
||||||
|
|
||||||
try:
|
|
||||||
responses = self._service.synthesize_online(
|
|
||||||
text,
|
|
||||||
self._voice_id,
|
|
||||||
self._language_code,
|
|
||||||
sample_rate_hz=self.sample_rate,
|
|
||||||
zero_shot_audio_prompt_file=None,
|
|
||||||
zero_shot_quality=self._quality,
|
|
||||||
custom_dictionary={},
|
|
||||||
)
|
|
||||||
for r in responses:
|
|
||||||
add_response(r)
|
|
||||||
add_response(None)
|
|
||||||
except Exception as e:
|
|
||||||
logger.error(f"{self} exception: {e}")
|
|
||||||
add_response(None)
|
|
||||||
|
|
||||||
await self.start_ttfb_metrics()
|
|
||||||
yield TTSStartedFrame()
|
|
||||||
|
|
||||||
logger.debug(f"{self}: Generating TTS [{text}]")
|
|
||||||
|
|
||||||
try:
|
|
||||||
queue = asyncio.Queue()
|
|
||||||
await asyncio.to_thread(read_audio_responses, queue)
|
|
||||||
|
|
||||||
# Wait for the thread to start.
|
|
||||||
resp = await asyncio.wait_for(queue.get(), timeout=RIVA_TTS_TIMEOUT_SECS)
|
|
||||||
while resp:
|
|
||||||
await self.stop_ttfb_metrics()
|
|
||||||
frame = TTSAudioRawFrame(
|
|
||||||
audio=resp.audio,
|
|
||||||
sample_rate=self.sample_rate,
|
|
||||||
num_channels=1,
|
|
||||||
)
|
|
||||||
yield frame
|
|
||||||
resp = await asyncio.wait_for(queue.get(), timeout=RIVA_TTS_TIMEOUT_SECS)
|
|
||||||
except asyncio.TimeoutError:
|
|
||||||
yield ErrorFrame(error=f"Unknown error occurred: {e}")
|
|
||||||
|
|
||||||
await self.start_tts_usage_metrics(text)
|
|
||||||
yield TTSStoppedFrame()
|
|
||||||
|
|
||||||
|
|
||||||
class FastPitchTTSService(RivaTTSService):
|
|
||||||
"""Deprecated FastPitch TTS service.
|
|
||||||
|
|
||||||
.. deprecated:: 0.0.66
|
|
||||||
This class is deprecated. Use RivaTTSService instead for new implementations.
|
|
||||||
Provides backward compatibility for existing FastPitch TTS integrations.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
api_key: str,
|
|
||||||
server: str = "grpc.nvcf.nvidia.com:443",
|
|
||||||
voice_id: str = "English-US.Female-1",
|
|
||||||
sample_rate: Optional[int] = None,
|
|
||||||
model_function_map: Mapping[str, str] = {
|
|
||||||
"function_id": "0149dedb-2be8-4195-b9a0-e57e0e14f972",
|
|
||||||
"model_name": "fastpitch-hifigan-tts",
|
|
||||||
},
|
|
||||||
params: Optional[RivaTTSService.InputParams] = None,
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
"""Initialize the deprecated FastPitch TTS service.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
api_key: NVIDIA API key for authentication.
|
|
||||||
server: gRPC server endpoint. Defaults to NVIDIA's cloud endpoint.
|
|
||||||
voice_id: Voice model identifier. Defaults to Female-1 voice.
|
|
||||||
sample_rate: Audio sample rate. If None, uses service default.
|
|
||||||
model_function_map: Dictionary containing function_id and model_name for FastPitch model.
|
|
||||||
params: Additional configuration parameters for TTS synthesis.
|
|
||||||
**kwargs: Additional arguments passed to parent RivaTTSService.
|
|
||||||
"""
|
|
||||||
super().__init__(
|
|
||||||
api_key=api_key,
|
|
||||||
server=server,
|
|
||||||
voice_id=voice_id,
|
|
||||||
sample_rate=sample_rate,
|
|
||||||
model_function_map=model_function_map,
|
|
||||||
params=params,
|
|
||||||
**kwargs,
|
|
||||||
)
|
|
||||||
import warnings
|
|
||||||
|
|
||||||
with warnings.catch_warnings():
|
|
||||||
warnings.simplefilter("always")
|
|
||||||
warnings.warn(
|
|
||||||
"`FastPitchTTSService` is deprecated, use `RivaTTSService` instead.",
|
|
||||||
DeprecationWarning,
|
|
||||||
)
|
|
||||||
|
|||||||
8
uv.lock
generated
8
uv.lock
generated
@@ -1,5 +1,5 @@
|
|||||||
version = 1
|
version = 1
|
||||||
revision = 3
|
revision = 2
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
resolution-markers = [
|
resolution-markers = [
|
||||||
"python_full_version >= '3.13'",
|
"python_full_version >= '3.13'",
|
||||||
@@ -4564,6 +4564,9 @@ neuphonic = [
|
|||||||
noisereduce = [
|
noisereduce = [
|
||||||
{ name = "noisereduce" },
|
{ name = "noisereduce" },
|
||||||
]
|
]
|
||||||
|
nvidia = [
|
||||||
|
{ name = "nvidia-riva-client" },
|
||||||
|
]
|
||||||
openai = [
|
openai = [
|
||||||
{ name = "websockets" },
|
{ name = "websockets" },
|
||||||
]
|
]
|
||||||
@@ -4706,6 +4709,7 @@ requires-dist = [
|
|||||||
{ name = "noisereduce", marker = "extra == 'noisereduce'", specifier = "~=3.0.3" },
|
{ name = "noisereduce", marker = "extra == 'noisereduce'", specifier = "~=3.0.3" },
|
||||||
{ name = "numba", specifier = "==0.61.2" },
|
{ name = "numba", specifier = "==0.61.2" },
|
||||||
{ name = "numpy", specifier = ">=1.26.4,<3" },
|
{ name = "numpy", specifier = ">=1.26.4,<3" },
|
||||||
|
{ name = "nvidia-riva-client", marker = "extra == 'nvidia'", specifier = "~=2.21.1" },
|
||||||
{ name = "nvidia-riva-client", marker = "extra == 'riva'", specifier = "~=2.21.1" },
|
{ name = "nvidia-riva-client", marker = "extra == 'riva'", specifier = "~=2.21.1" },
|
||||||
{ name = "onnxruntime", marker = "extra == 'local-smart-turn-v3'", specifier = ">=1.20.1,<2" },
|
{ name = "onnxruntime", marker = "extra == 'local-smart-turn-v3'", specifier = ">=1.20.1,<2" },
|
||||||
{ name = "onnxruntime", marker = "extra == 'silero'", specifier = ">=1.20.1,<2" },
|
{ name = "onnxruntime", marker = "extra == 'silero'", specifier = ">=1.20.1,<2" },
|
||||||
@@ -4767,7 +4771,7 @@ requires-dist = [
|
|||||||
{ name = "wait-for2", marker = "python_full_version < '3.12'", specifier = ">=0.4.1" },
|
{ name = "wait-for2", marker = "python_full_version < '3.12'", specifier = ">=0.4.1" },
|
||||||
{ name = "websockets", marker = "extra == 'websockets-base'", specifier = ">=13.1,<16.0" },
|
{ name = "websockets", marker = "extra == 'websockets-base'", specifier = ">=13.1,<16.0" },
|
||||||
]
|
]
|
||||||
provides-extras = ["aic", "anthropic", "assemblyai", "asyncai", "aws", "aws-nova-sonic", "azure", "cartesia", "cerebras", "daily", "deepgram", "deepseek", "elevenlabs", "fal", "fireworks", "fish", "gladia", "google", "grok", "groq", "gstreamer", "heygen", "hume", "inworld", "koala", "krisp", "langchain", "livekit", "lmnt", "local", "local-smart-turn", "local-smart-turn-v3", "mcp", "mem0", "mistral", "mlx-whisper", "moondream", "neuphonic", "nim", "noisereduce", "openai", "openpipe", "openrouter", "perplexity", "playht", "qwen", "remote-smart-turn", "rime", "riva", "runner", "sagemaker", "sambanova", "sarvam", "sentry", "silero", "simli", "soniox", "soundfile", "speechmatics", "strands", "tavus", "together", "tracing", "ultravox", "webrtc", "websocket", "websockets-base", "whisper"]
|
provides-extras = ["aic", "anthropic", "assemblyai", "asyncai", "aws", "aws-nova-sonic", "azure", "cartesia", "cerebras", "daily", "deepgram", "deepseek", "elevenlabs", "fal", "fireworks", "fish", "gladia", "google", "grok", "groq", "gstreamer", "heygen", "hume", "inworld", "koala", "krisp", "langchain", "livekit", "lmnt", "local", "local-smart-turn", "local-smart-turn-v3", "mcp", "mem0", "mistral", "mlx-whisper", "moondream", "neuphonic", "nim", "noisereduce", "openai", "openpipe", "openrouter", "perplexity", "playht", "qwen", "remote-smart-turn", "rime", "riva", "nvidia", "runner", "sagemaker", "sambanova", "sarvam", "sentry", "silero", "simli", "soniox", "soundfile", "speechmatics", "strands", "tavus", "together", "tracing", "ultravox", "webrtc", "websocket", "websockets-base", "whisper"]
|
||||||
|
|
||||||
[package.metadata.requires-dev]
|
[package.metadata.requires-dev]
|
||||||
dev = [
|
dev = [
|
||||||
|
|||||||
Reference in New Issue
Block a user