Skip to content

Commit 9889ead

Browse files
docs(api): clarify prompt parameter support in audio transcriptions/translations
1 parent 9c1211a commit 9889ead

5 files changed

Lines changed: 30 additions & 8 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 75
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai/togetherai-13728ec693ca29a36a3cfbe05df62ca69a8e404eab7f6db16759fc5304717eac.yml
3-
openapi_spec_hash: 5334a20f914487feace9c88045b89354
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai/togetherai-c120da21adf22dd3902475f6ba7410dd57d9d2995a232e676d59af4806d57d09.yml
3+
openapi_spec_hash: eff04023d0ad22f11bbf107e44fe699e
44
config_hash: 6c214c91fad5ead4849be777fd9e8108

src/together/resources/audio/transcriptions.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,10 @@ def create(
9494
9595
model: Model to use for transcription
9696
97-
prompt: Optional text to bias decoding.
97+
prompt: Optional text to bias decoding. Supported only on Whisper-family models (e.g.
98+
`openai/whisper-large-v3`). Other STT models (e.g.
99+
`nvidia/parakeet-tdt-0.6b-v3`) accept the field for API compatibility but ignore
100+
it.
98101
99102
response_format: The format of the response
100103
@@ -217,7 +220,10 @@ async def create(
217220
218221
model: Model to use for transcription
219222
220-
prompt: Optional text to bias decoding.
223+
prompt: Optional text to bias decoding. Supported only on Whisper-family models (e.g.
224+
`openai/whisper-large-v3`). Other STT models (e.g.
225+
`nvidia/parakeet-tdt-0.6b-v3`) accept the field for API compatibility but ignore
226+
it.
221227
222228
response_format: The format of the response
223229

src/together/resources/audio/translations.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ def create(
7474
7575
model: Model to use for translation
7676
77-
prompt: Optional text to bias decoding.
77+
prompt: Optional text to bias decoding. Supported only on Whisper-family models (e.g.
78+
`openai/whisper-large-v3`). Other STT models (e.g.
79+
`nvidia/parakeet-tdt-0.6b-v3`) accept the field for API compatibility but ignore
80+
it.
7881
7982
response_format: The format of the response
8083
@@ -174,7 +177,10 @@ async def create(
174177
175178
model: Model to use for translation
176179
177-
prompt: Optional text to bias decoding.
180+
prompt: Optional text to bias decoding. Supported only on Whisper-family models (e.g.
181+
`openai/whisper-large-v3`). Other STT models (e.g.
182+
`nvidia/parakeet-tdt-0.6b-v3`) accept the field for API compatibility but ignore
183+
it.
178184
179185
response_format: The format of the response
180186

src/together/types/audio/transcription_create_params.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,12 @@ class TranscriptionCreateParams(TypedDict, total=False):
5555
"""Model to use for transcription"""
5656

5757
prompt: str
58-
"""Optional text to bias decoding."""
58+
"""Optional text to bias decoding.
59+
60+
Supported only on Whisper-family models (e.g. `openai/whisper-large-v3`). Other
61+
STT models (e.g. `nvidia/parakeet-tdt-0.6b-v3`) accept the field for API
62+
compatibility but ignore it.
63+
"""
5964

6065
response_format: Literal["json", "verbose_json"]
6166
"""The format of the response"""

src/together/types/audio/translation_create_params.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@ class TranslationCreateParams(TypedDict, total=False):
2727
"""Model to use for translation"""
2828

2929
prompt: str
30-
"""Optional text to bias decoding."""
30+
"""Optional text to bias decoding.
31+
32+
Supported only on Whisper-family models (e.g. `openai/whisper-large-v3`). Other
33+
STT models (e.g. `nvidia/parakeet-tdt-0.6b-v3`) accept the field for API
34+
compatibility but ignore it.
35+
"""
3136

3237
response_format: Literal["json", "verbose_json"]
3338
"""The format of the response"""

0 commit comments

Comments
 (0)