跳转至

OpenAIVoiceModelProvider

OpenAIVoiceModelProvider

Bases: VoiceModelProvider

A voice model provider that uses OpenAI models.

Source code in src/agents/voice/models/openai_model_provider.py 
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class OpenAIVoiceModelProvider(VoiceModelProvider):
    """A voice model provider that uses OpenAI models."""

    def __init__(
        self,
        *,
        api_key: str | None = None,
        base_url: str | None = None,
        openai_client: AsyncOpenAI | None = None,
        organization: str | None = None,
        project: str | None = None,
        agent_registration: OpenAIAgentRegistrationConfig | dict[str, Any] | None = None,
    ) -> None:
        """Create a new OpenAI voice model provider.

        Args:
            api_key: The API key to use for the OpenAI client. If not provided, we will use the
                default API key.
            base_url: The base URL to use for the OpenAI client. If not provided, we will use the
                default base URL.
            openai_client: An optional OpenAI client to use. If not provided, we will create a new
                OpenAI client using the api_key and base_url.
            organization: The organization to use for the OpenAI client.
            project: The project to use for the OpenAI client.
            agent_registration: Optional agent registration configuration.
        """
        if openai_client is not None:
            if any(value is not None for value in (api_key, base_url, organization, project)):
                raise UserError(
                    "Don't provide api_key, base_url, organization, or project if you provide "
                    "openai_client"
                )
            self._client: AsyncOpenAI | None = openai_client
        else:
            self._client = None
            self._stored_api_key = api_key
            self._stored_base_url = base_url
            self._stored_organization = organization
            self._stored_project = project
        self._agent_registration = resolve_openai_agent_registration_config(agent_registration)

    @property
    def agent_registration(self) -> ResolvedOpenAIAgentRegistrationConfig | None:
        return self._agent_registration

    # We lazy load the client in case you never actually use OpenAIProvider(). Otherwise
    # AsyncOpenAI() raises an error if you don't have an API key set.
    def _get_client(self) -> AsyncOpenAI:
        if self._client is None:
            has_explicit_client_options = any(
                value is not None
                for value in (
                    self._stored_api_key,
                    self._stored_base_url,
                    self._stored_organization,
                    self._stored_project,
                )
            )
            default_client = (
                None if has_explicit_client_options else _openai_shared.get_default_openai_client()
            )
            self._client = (
                default_client
                if default_client is not None
                else AsyncOpenAI(
                    api_key=(
                        self._stored_api_key
                        if self._stored_api_key is not None
                        else _openai_shared.get_default_openai_key()
                    ),
                    base_url=self._stored_base_url,
                    organization=self._stored_organization,
                    project=self._stored_project,
                    http_client=shared_http_client(),
                )
            )

        return self._client

    def get_stt_model(self, model_name: str | None) -> STTModel:
        """Get a speech-to-text model by name.

        Args:
            model_name: The name of the model to get.

        Returns:
            The speech-to-text model.
        """
        return OpenAISTTModel(model_name or DEFAULT_STT_MODEL, self._get_client())

    def get_tts_model(self, model_name: str | None) -> TTSModel:
        """Get a text-to-speech model by name.

        Args:
            model_name: The name of the model to get.

        Returns:
            The text-to-speech model.
        """
        return OpenAITTSModel(model_name or DEFAULT_TTS_MODEL, self._get_client())

__init__ 

__init__(
    *,
    api_key: str | None = None,
    base_url: str | None = None,
    openai_client: AsyncOpenAI | None = None,
    organization: str | None = None,
    project: str | None = None,
    agent_registration: OpenAIAgentRegistrationConfig
    | dict[str, Any]
    | None = None,
) -> None

Create a new OpenAI voice model provider.

Parameters:

Name Type Description Default
api_key str | None

The API key to use for the OpenAI client. If not provided, we will use the default API key.

 None
base_url str | None

The base URL to use for the OpenAI client. If not provided, we will use the default base URL.

 None
openai_client AsyncOpenAI | None

An optional OpenAI client to use. If not provided, we will create a new OpenAI client using the api_key and base_url.

 None
organization str | None

The organization to use for the OpenAI client.

 None
project str | None

The project to use for the OpenAI client.

 None
agent_registration OpenAIAgentRegistrationConfig | dict[str, Any] | None

Optional agent registration configuration.

 None
Source code in src/agents/voice/models/openai_model_provider.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def __init__(
    self,
    *,
    api_key: str | None = None,
    base_url: str | None = None,
    openai_client: AsyncOpenAI | None = None,
    organization: str | None = None,
    project: str | None = None,
    agent_registration: OpenAIAgentRegistrationConfig | dict[str, Any] | None = None,
) -> None:
    """Create a new OpenAI voice model provider.

    Args:
        api_key: The API key to use for the OpenAI client. If not provided, we will use the
            default API key.
        base_url: The base URL to use for the OpenAI client. If not provided, we will use the
            default base URL.
        openai_client: An optional OpenAI client to use. If not provided, we will create a new
            OpenAI client using the api_key and base_url.
        organization: The organization to use for the OpenAI client.
        project: The project to use for the OpenAI client.
        agent_registration: Optional agent registration configuration.
    """
    if openai_client is not None:
        if any(value is not None for value in (api_key, base_url, organization, project)):
            raise UserError(
                "Don't provide api_key, base_url, organization, or project if you provide "
                "openai_client"
            )
        self._client: AsyncOpenAI | None = openai_client
    else:
        self._client = None
        self._stored_api_key = api_key
        self._stored_base_url = base_url
        self._stored_organization = organization
        self._stored_project = project
    self._agent_registration = resolve_openai_agent_registration_config(agent_registration)

get_stt_model 

get_stt_model(model_name: str | None) -> STTModel

Get a speech-to-text model by name.

Parameters:

Name Type Description Default
model_name str | None

The name of the model to get.

 required

Returns:

Type Description
STTModel

The speech-to-text model.
Source code in src/agents/voice/models/openai_model_provider.py 
114
115
116
117
118
119
120
121
122
123
def get_stt_model(self, model_name: str | None) -> STTModel:
    """Get a speech-to-text model by name.

    Args:
        model_name: The name of the model to get.

    Returns:
        The speech-to-text model.
    """
    return OpenAISTTModel(model_name or DEFAULT_STT_MODEL, self._get_client())

get_tts_model 

get_tts_model(model_name: str | None) -> TTSModel

Get a text-to-speech model by name.

Parameters:

Name Type Description Default
model_name str | None

The name of the model to get.

 required

Returns:

Type Description
TTSModel

The text-to-speech model.
Source code in src/agents/voice/models/openai_model_provider.py 
125
126
127
128
129
130
131
132
133
134
def get_tts_model(self, model_name: str | None) -> TTSModel:
    """Get a text-to-speech model by name.

    Args:
        model_name: The name of the model to get.

    Returns:
        The text-to-speech model.
    """
    return OpenAITTSModel(model_name or DEFAULT_TTS_MODEL, self._get_client())