169 lines
6.1 KiB
Python
169 lines
6.1 KiB
Python
# File generated from our OpenAPI spec by Stainless.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Union
|
|
from typing_extensions import Literal
|
|
|
|
import httpx
|
|
|
|
from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
|
|
from ..._utils import maybe_transform
|
|
from ..._resource import SyncAPIResource, AsyncAPIResource
|
|
from ..._response import to_raw_response_wrapper, async_to_raw_response_wrapper
|
|
from ...types.audio import speech_create_params
|
|
from ..._base_client import HttpxBinaryResponseContent, make_request_options
|
|
|
|
if TYPE_CHECKING:
|
|
from ..._client import OpenAI, AsyncOpenAI
|
|
|
|
__all__ = ["Speech", "AsyncSpeech"]
|
|
|
|
|
|
class Speech(SyncAPIResource):
|
|
with_raw_response: SpeechWithRawResponse
|
|
|
|
def __init__(self, client: OpenAI) -> None:
|
|
super().__init__(client)
|
|
self.with_raw_response = SpeechWithRawResponse(self)
|
|
|
|
def create(
|
|
self,
|
|
*,
|
|
input: str,
|
|
model: Union[str, Literal["tts-1", "tts-1-hd"]],
|
|
voice: Literal["alloy", "echo", "fable", "onyx", "nova", "shimmer"],
|
|
response_format: Literal["mp3", "opus", "aac", "flac"] | NotGiven = NOT_GIVEN,
|
|
speed: float | NotGiven = NOT_GIVEN,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
|
) -> HttpxBinaryResponseContent:
|
|
"""
|
|
Generates audio from the input text.
|
|
|
|
Args:
|
|
input: The text to generate audio for. The maximum length is 4096 characters.
|
|
|
|
model:
|
|
One of the available [TTS models](https://platform.openai.com/docs/models/tts):
|
|
`tts-1` or `tts-1-hd`
|
|
|
|
voice: The voice to use when generating the audio. Supported voices are `alloy`,
|
|
`echo`, `fable`, `onyx`, `nova`, and `shimmer`.
|
|
|
|
response_format: The format to audio in. Supported formats are `mp3`, `opus`, `aac`, and `flac`.
|
|
|
|
speed: The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
|
|
the default.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
return self._post(
|
|
"/audio/speech",
|
|
body=maybe_transform(
|
|
{
|
|
"input": input,
|
|
"model": model,
|
|
"voice": voice,
|
|
"response_format": response_format,
|
|
"speed": speed,
|
|
},
|
|
speech_create_params.SpeechCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=HttpxBinaryResponseContent,
|
|
)
|
|
|
|
|
|
class AsyncSpeech(AsyncAPIResource):
|
|
with_raw_response: AsyncSpeechWithRawResponse
|
|
|
|
def __init__(self, client: AsyncOpenAI) -> None:
|
|
super().__init__(client)
|
|
self.with_raw_response = AsyncSpeechWithRawResponse(self)
|
|
|
|
async def create(
|
|
self,
|
|
*,
|
|
input: str,
|
|
model: Union[str, Literal["tts-1", "tts-1-hd"]],
|
|
voice: Literal["alloy", "echo", "fable", "onyx", "nova", "shimmer"],
|
|
response_format: Literal["mp3", "opus", "aac", "flac"] | NotGiven = NOT_GIVEN,
|
|
speed: float | NotGiven = NOT_GIVEN,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
|
) -> HttpxBinaryResponseContent:
|
|
"""
|
|
Generates audio from the input text.
|
|
|
|
Args:
|
|
input: The text to generate audio for. The maximum length is 4096 characters.
|
|
|
|
model:
|
|
One of the available [TTS models](https://platform.openai.com/docs/models/tts):
|
|
`tts-1` or `tts-1-hd`
|
|
|
|
voice: The voice to use when generating the audio. Supported voices are `alloy`,
|
|
`echo`, `fable`, `onyx`, `nova`, and `shimmer`.
|
|
|
|
response_format: The format to audio in. Supported formats are `mp3`, `opus`, `aac`, and `flac`.
|
|
|
|
speed: The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
|
|
the default.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
return await self._post(
|
|
"/audio/speech",
|
|
body=maybe_transform(
|
|
{
|
|
"input": input,
|
|
"model": model,
|
|
"voice": voice,
|
|
"response_format": response_format,
|
|
"speed": speed,
|
|
},
|
|
speech_create_params.SpeechCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=HttpxBinaryResponseContent,
|
|
)
|
|
|
|
|
|
class SpeechWithRawResponse:
|
|
def __init__(self, speech: Speech) -> None:
|
|
self.create = to_raw_response_wrapper(
|
|
speech.create,
|
|
)
|
|
|
|
|
|
class AsyncSpeechWithRawResponse:
|
|
def __init__(self, speech: AsyncSpeech) -> None:
|
|
self.create = async_to_raw_response_wrapper(
|
|
speech.create,
|
|
)
|