Hello World

Congratulations on installing S.T.A.R.K.! This guide walks through your first voice-driven application: a command that responds to "hello" by saying "Hello, Stark!" back. (jump to async commands →)

Hello, Stark!

S.T.A.R.K. doesn't lock you into one speech engine, it's built around protocols, so any recognizer or synthesizer that implements them works. This tutorial uses Vosk for speech recognition and Silero for speech synthesis, both fully offline. Both download and cache their models automatically on first use:

• Vosk models, pick one for your language
• Silero models, pick a voice

import anyio
from stark import run, CommandsManager, Response
from stark.interfaces.vosk import VoskSpeechRecognizer
from stark.interfaces.silero import SileroSpeechSynthesizer


VOSK_MODEL_URL = "YOUR_CHOSEN_VOSK_MODEL_URL"
SILERO_MODEL_URL = "YOUR_CHOSEN_SILERO_MODEL_URL"

manager = CommandsManager()                                         # 1

@manager.new('hello')                                                # 2
def hello_command() -> Response:
    return Response('Hello, Stark!', voice='Hello, Stark!')     # 3

async def main():
    recognizer = VoskSpeechRecognizer(model_url=VOSK_MODEL_URL)      # 4
    synthesizer = SileroSpeechSynthesizer(model_url=SILERO_MODEL_URL)
    await run(manager, recognizer, synthesizer)                      # 5

if __name__ == '__main__':
    anyio.run(main)

1. CommandsManager is where every command your assistant understands gets registered.
2. @manager.new('hello') registers a command matched against the pattern 'hello'. Patterns can get much more dynamic than a literal word, see Patterns.
3. A Response carries both the spoken (voice) and displayed (text) reply, they don't have to match, but here they do. Plenty of other fields exist (status, follow-up commands, parameters), see Command Response in Core Concepts.
4. Pick a recognizer and synthesizer. These two are offline; S.T.A.R.K. doesn't require any cloud service or API key to work.
5. run() wires the manager, recognizer, and synthesizer together and starts listening. Say "hello," hear "Hello, Stark!" back.

This command is declared plain def, simplest option, and S.T.A.R.K. handles the rest. Once you start awaiting things inside a command, you'll want async def instead, see Async Commands and Sync vs Async Commands for when to reach for which.

Prefer to skip the microphone for now and type input in a terminal instead? See How to Run for the no-audio variant of this same example.