Commit @dc3d3e76ef4db5495957edbb850b6187478283b8 - yjyoon/whisper_server

Y
List All
Feedback
- This Project
- All Projects

Fedir Zadniprovskyi 2024-12-17

chore: document `sample_rate` param

@dc3d3e76ef4db5495957edbb850b6187478283b8

dc7bb9d

dc3d3e7

src/faster_whisper_server/routers/speech.py

--- src/faster_whisper_server/routers/speech.py

+++ src/faster_whisper_server/routers/speech.py


     # https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice
     speed: float = Field(1.0, ge=0.25, le=4.0)
     """The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default."""
-    sample_rate: int | None = Field(None, ge=MIN_SAMPLE_RATE, le=MAX_SAMPLE_RATE)  # TODO: document
+    sample_rate: int | None = Field(None, ge=MIN_SAMPLE_RATE, le=MAX_SAMPLE_RATE)
+    """Desired sample rate to convert the generated audio to. If not provided, the model's default sample rate will be used."""  # noqa: E501
 
     # TODO: move into `Voice`
     @model_validator(mode="after")

Add a comment

Open 0
Closed 0

List

...	...	@@ -134,7 +134,8 @@
134	134	# https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice
135	135	speed: float = Field(1.0, ge=0.25, le=4.0)
136	136	"""The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default."""
137		- sample_rate: int \| None = Field(None, ge=MIN_SAMPLE_RATE, le=MAX_SAMPLE_RATE) # TODO: document
	137	+ sample_rate: int \| None = Field(None, ge=MIN_SAMPLE_RATE, le=MAX_SAMPLE_RATE)
	138	+ """Desired sample rate to convert the generated audio to. If not provided, the model's default sample rate will be used.""" # noqa: E501
138	139
139	140	# TODO: move into `Voice`
140	141	@model_validator(mode="after")

Delete comment