Skip to content

Add --prompt & --verbose in python -m speech_recognition.recognizers.whisper_api.openai #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 6, 2025
Merged

Add --prompt & --verbose in python -m speech_recognition.recognizers.whisper_api.openai #837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b590ef
[feat] Add -p/--prompt
ftnext May 5, 2025
380465c
[feat] Support --model short version (-m) for option's consistency
ftnext May 5, 2025
72da569
[feat] Users enable logging of transcription API call
ftnext May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion speech_recognition/recognizers/whisper_api/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import logging
from io import BytesIO

from speech_recognition.audio import AudioData

logger = logging.getLogger(__name__)


class OpenAICompatibleRecognizer:
def __init__(self, client) -> None:
Expand All @@ -16,7 +19,10 @@ def recognize(self, audio_data: "AudioData", model: str, **kwargs) -> str:
wav_data = BytesIO(audio_data.get_wav_data())
wav_data.name = "SpeechRecognition_audio.wav"

parameters = {"model": model, **kwargs}
logger.debug(parameters)

transcript = self.client.audio.transcriptions.create(
file=wav_data, model=model, **kwargs
file=wav_data, **parameters
)
return transcript.text
28 changes: 22 additions & 6 deletions speech_recognition/recognizers/whisper_api/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import logging
from typing import Literal

from typing_extensions import Unpack
Expand Down Expand Up @@ -65,16 +66,31 @@ def recognize(
parser = argparse.ArgumentParser()
parser.add_argument("audio_file")
parser.add_argument(
"--model", choices=get_args(WhisperModel), default="whisper-1"
"-m", "--model", choices=get_args(WhisperModel), default="whisper-1"
)
parser.add_argument("-l", "--language")
parser.add_argument("-p", "--prompt")
parser.add_argument("-v", "--verbose", action="store_true")
args = parser.parse_args()

if args.verbose:
Copy link

Copilot AI May 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding a check to avoid attaching multiple console handlers to the 'speech_recognition' logger if the verbose block is executed more than once, which may result in duplicate log entries.

Copilot uses AI. Check for mistakes.
speech_recognition_logger = logging.getLogger("speech_recognition")
speech_recognition_logger.setLevel(logging.DEBUG)

console_handler = logging.StreamHandler()
console_formatter = logging.Formatter(
"%(asctime)s | %(levelname)s | %(name)s:%(funcName)s:%(lineno)d - %(message)s"
)
console_handler.setFormatter(console_formatter)
speech_recognition_logger.addHandler(console_handler)

audio_data = sr.AudioData.from_file(args.audio_file)

recognize_args = {"model": args.model}
if args.language:
transcription = recognize(
None, audio_data, model=args.model, language=args.language
)
else:
transcription = recognize(None, audio_data, model=args.model)
recognize_args["language"] = args.language
if args.prompt:
recognize_args["prompt"] = args.prompt

transcription = recognize(None, audio_data, **recognize_args)
print(transcription)