Fedir Zadniprovskyi commited on
Commit
d2c39a2
·
1 Parent(s): 7f77e4b

chore: document `sample_rate` param

Browse files
src/faster_whisper_server/routers/speech.py CHANGED
@@ -134,7 +134,8 @@ class CreateSpeechRequestBody(BaseModel):
134
  # https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice
135
  speed: float = Field(1.0, ge=0.25, le=4.0)
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
 
138
 
139
  # TODO: move into `Voice`
140
  @model_validator(mode="after")
 
134
  # https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice
135
  speed: float = Field(1.0, ge=0.25, le=4.0)
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)
138
+ """Desired sample rate to convert the generated audio to. If not provided, the model's default sample rate will be used.""" # noqa: E501
139
 
140
  # TODO: move into `Voice`
141
  @model_validator(mode="after")