telnyx 3.5.0a0__py3-none-any.whl → 3.6.0__py3-none-any.whl

telnyx/types/ai/assistants_list.py

@@ -1,96 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
-from datetime import datetime
+from typing import List
 
 from ..._models import BaseModel
-from .assistant_tool import AssistantTool
-from .voice_settings import VoiceSettings
-from .import_metadata import ImportMetadata
-from .enabled_features import EnabledFeatures
-from .insight_settings import InsightSettings
-from .privacy_settings import PrivacySettings
-from .messaging_settings import MessagingSettings
-from .telephony_settings import TelephonySettings
-from .transcription_settings import TranscriptionSettings
+from .inference_embedding import InferenceEmbedding
 
-__all__ = ["AssistantsList", "Data"]
-
-
-class Data(BaseModel):
-    id: str
-
-    created_at: datetime
-
-    instructions: str
-    """System instructions for the assistant.
-
-    These may be templated with
-    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    """
-
-    model: str
-    """ID of the model to use.
-
-    You can use the
-    [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
-    to see all of your available models,
-    """
-
-    name: str
-
-    description: Optional[str] = None
-
-    dynamic_variables: Optional[Dict[str, object]] = None
-    """Map of dynamic variables and their values"""
-
-    dynamic_variables_webhook_url: Optional[str] = None
-    """
-    If the dynamic_variables_webhook_url is set for the assistant, we will send a
-    request at the start of the conversation. See our
-    [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    for more information.
-    """
-
-    enabled_features: Optional[List[EnabledFeatures]] = None
-
-    greeting: Optional[str] = None
-    """Text that the assistant will use to start the conversation.
-
-    This may be templated with
-    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    """
-
-    import_metadata: Optional[ImportMetadata] = None
-
-    insight_settings: Optional[InsightSettings] = None
-
-    llm_api_key_ref: Optional[str] = None
-    """This is only needed when using third-party inference providers.
-
-    The `identifier` for an integration secret
-    [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
-    that refers to your LLM provider's API key. Warning: Free plans are unlikely to
-    work with this integration.
-    """
-
-    messaging_settings: Optional[MessagingSettings] = None
-
-    privacy_settings: Optional[PrivacySettings] = None
-
-    telephony_settings: Optional[TelephonySettings] = None
-
-    tools: Optional[List[AssistantTool]] = None
-    """The tools that the assistant can use.
-
-    These may be templated with
-    [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
-    """
-
-    transcription: Optional[TranscriptionSettings] = None
-
-    voice_settings: Optional[VoiceSettings] = None
+__all__ = ["AssistantsList"]
 
 
 class AssistantsList(BaseModel):
-    data: List[Data]
+    data: List[InferenceEmbedding]

telnyx/types/ai/{conversations/message_create_params.py → conversation_add_message_params.py}

@@ -6,13 +6,13 @@ from typing import Dict, Union, Iterable
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
-from ...._types import SequenceNotStr
-from ...._utils import PropertyInfo
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
 
-__all__ = ["MessageCreateParams"]
+__all__ = ["ConversationAddMessageParams"]
 
 
-class MessageCreateParams(TypedDict, total=False):
+class ConversationAddMessageParams(TypedDict, total=False):
     role: Required[str]
 
     content: str

telnyx/types/ai/conversations/__init__.py

@@ -7,7 +7,6 @@ from .insight_list_params import InsightListParams as InsightListParams
 from .insight_create_params import InsightCreateParams as InsightCreateParams
 from .insight_list_response import InsightListResponse as InsightListResponse
 from .insight_update_params import InsightUpdateParams as InsightUpdateParams
-from .message_create_params import MessageCreateParams as MessageCreateParams
 from .message_list_response import MessageListResponse as MessageListResponse
 from .insight_template_group import InsightTemplateGroup as InsightTemplateGroup
 from .insight_template_detail import InsightTemplateDetail as InsightTemplateDetail

telnyx/types/ai/import_metadata.py

@@ -12,5 +12,5 @@ class ImportMetadata(BaseModel):
     import_id: Optional[str] = None
     """ID of the assistant in the provider's system."""
 
-    import_provider: Optional[Literal["elevenlabs", "vapi"]] = None
+    import_provider: Optional[Literal["elevenlabs", "vapi", "retell"]] = None
     """Provider the assistant was imported from."""

telnyx/types/ai/{assistant_clone_response.py → inference_embedding.py}

@@ -14,10 +14,10 @@ from .messaging_settings import MessagingSettings
 from .telephony_settings import TelephonySettings
 from .transcription_settings import TranscriptionSettings
 
-__all__ = ["AssistantCloneResponse"]
+__all__ = ["InferenceEmbedding"]
 
 
-class AssistantCloneResponse(BaseModel):
+class InferenceEmbedding(BaseModel):
     id: str
 
     created_at: datetime

telnyx/types/ai/inference_embedding_transfer_tool_params.py

@@ -41,3 +41,9 @@ class InferenceEmbeddingTransferToolParams(BaseModel):
 
     custom_headers: Optional[List[CustomHeader]] = None
     """Custom headers to be added to the SIP INVITE for the transfer command."""
+
+    warm_transfer_instructions: Optional[str] = None
+    """
+    Natural language instructions for your agent for how to provide context for the
+    transfer recipient.
+    """

telnyx/types/ai/inference_embedding_transfer_tool_params_param.py

@@ -48,3 +48,9 @@ class InferenceEmbeddingTransferToolParamsParam(
 
     custom_headers: Iterable[CustomHeader]
     """Custom headers to be added to the SIP INVITE for the transfer command."""
+
+    warm_transfer_instructions: str
+    """
+    Natural language instructions for your agent for how to provide context for the
+    transfer recipient.
+    """

telnyx/types/ai/inference_embedding_webhook_tool_params.py

@@ -27,6 +27,8 @@ class Header(BaseModel):
     Note that we support mustache templating for the value. For example you can use
     `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the
     value of the integration secret as the bearer token.
+    [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks)
+    will be automatically added to the request.
     """
 
 

telnyx/types/ai/inference_embedding_webhook_tool_params_param.py

@@ -29,6 +29,8 @@ class Header(TypedDict, total=False):
     Note that we support mustache templating for the value. For example you can use
     `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the
     value of the integration secret as the bearer token.
+    [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks)
+    will be automatically added to the request.
     """
 
 

telnyx/types/ai/voice_settings.py

@@ -1,10 +1,50 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+from typing import Union, Optional
+from typing_extensions import Literal, TypeAlias
 
 from ..._models import BaseModel
 
-__all__ = ["VoiceSettings"]
+__all__ = [
+    "VoiceSettings",
+    "BackgroundAudio",
+    "BackgroundAudioUnionMember0",
+    "BackgroundAudioUnionMember1",
+    "BackgroundAudioUnionMember2",
+]
+
+
+class BackgroundAudioUnionMember0(BaseModel):
+    type: Literal["predefined_media"]
+    """Select from predefined media options."""
+
+    value: Literal["silence", "office"]
+    """The predefined media to use. `silence` disables background audio."""
+
+
+class BackgroundAudioUnionMember1(BaseModel):
+    type: Literal["media_url"]
+    """Provide a direct URL to an MP3 file. The audio will loop during the call."""
+
+    value: str
+    """HTTPS URL to an MP3 file."""
+
+
+class BackgroundAudioUnionMember2(BaseModel):
+    type: Literal["media_name"]
+    """Reference a previously uploaded media by its name from Telnyx Media Storage."""
+
+    value: str
+    """
+    The `name` of a media asset created via
+    [Media Storage API](https://developers.telnyx.com/api/media-storage/create-media-storage).
+    The audio will loop during the call.
+    """
+
+
+BackgroundAudio: TypeAlias = Union[
+    BackgroundAudioUnionMember0, BackgroundAudioUnionMember1, BackgroundAudioUnionMember2
+]
 
 
 class VoiceSettings(BaseModel):
@@ -28,6 +68,13 @@ class VoiceSettings(BaseModel):
     with this integration.
     """
 
+    background_audio: Optional[BackgroundAudio] = None
+    """Optional background audio to play on the call.
+
+    Use a predefined media bed, or supply a looped MP3 URL. If a media URL is chosen
+    in the portal, customers can preview it before saving.
+    """
+
     voice_speed: Optional[float] = None
     """The speed of the voice in the range [0.25, 2.0].
 

telnyx/types/ai/voice_settings_param.py

@@ -2,9 +2,49 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
-__all__ = ["VoiceSettingsParam"]
+__all__ = [
+    "VoiceSettingsParam",
+    "BackgroundAudio",
+    "BackgroundAudioUnionMember0",
+    "BackgroundAudioUnionMember1",
+    "BackgroundAudioUnionMember2",
+]
+
+
+class BackgroundAudioUnionMember0(TypedDict, total=False):
+    type: Required[Literal["predefined_media"]]
+    """Select from predefined media options."""
+
+    value: Required[Literal["silence", "office"]]
+    """The predefined media to use. `silence` disables background audio."""
+
+
+class BackgroundAudioUnionMember1(TypedDict, total=False):
+    type: Required[Literal["media_url"]]
+    """Provide a direct URL to an MP3 file. The audio will loop during the call."""
+
+    value: Required[str]
+    """HTTPS URL to an MP3 file."""
+
+
+class BackgroundAudioUnionMember2(TypedDict, total=False):
+    type: Required[Literal["media_name"]]
+    """Reference a previously uploaded media by its name from Telnyx Media Storage."""
+
+    value: Required[str]
+    """
+    The `name` of a media asset created via
+    [Media Storage API](https://developers.telnyx.com/api/media-storage/create-media-storage).
+    The audio will loop during the call.
+    """
+
+
+BackgroundAudio: TypeAlias = Union[
+    BackgroundAudioUnionMember0, BackgroundAudioUnionMember1, BackgroundAudioUnionMember2
+]
 
 
 class VoiceSettingsParam(TypedDict, total=False):
@@ -28,6 +68,13 @@ class VoiceSettingsParam(TypedDict, total=False):
     with this integration.
     """
 
+    background_audio: BackgroundAudio
+    """Optional background audio to play on the call.
+
+    Use a predefined media bed, or supply a looped MP3 URL. If a media URL is chosen
+    in the portal, customers can preview it before saving.
+    """
+
     voice_speed: float
     """The speed of the voice in the range [0.25, 2.0].
 

telnyx/types/brand_create_params.py

@@ -31,7 +31,8 @@ class BrandCreateParams(TypedDict, total=False):
     business_contact_email: Annotated[str, PropertyInfo(alias="businessContactEmail")]
     """Business contact email.
 
-    Required if `entityType` is `PUBLIC_PROFIT`.
+    Required if `entityType` is `PUBLIC_PROFIT`. Otherwise, it is recommended to
+    either omit this field or set it to `null`.
     """
 
     city: str

telnyx/types/brand_update_params.py

@@ -39,7 +39,8 @@ class BrandUpdateParams(TypedDict, total=False):
     business_contact_email: Annotated[str, PropertyInfo(alias="businessContactEmail")]
     """Business contact email.
 
-    Required if `entityType` will be changed to `PUBLIC_PROFIT`.
+    Required if `entityType` will be changed to `PUBLIC_PROFIT`. Otherwise, it is
+    recommended to either omit this field or set it to `null`.
     """
 
     city: str

telnyx/types/call_dial_params.py

@@ -15,6 +15,7 @@ from .sound_modifications_param import SoundModificationsParam
 from .stream_bidirectional_mode import StreamBidirectionalMode
 from .stream_bidirectional_codec import StreamBidirectionalCodec
 from .stream_bidirectional_target_legs import StreamBidirectionalTargetLegs
+from .stream_bidirectional_sampling_rate import StreamBidirectionalSamplingRate
 from .calls.transcription_start_request_param import TranscriptionStartRequestParam
 
 __all__ = ["CallDialParams", "AnsweringMachineDetectionConfig", "ConferenceConfig"]
@@ -139,6 +140,14 @@ class CallDialParams(TypedDict, total=False):
     WAV or MP3 file.
     """
 
+    park_after_unbridge: str
+    """If supplied with the value `self`, the current leg will be parked after
+    unbridge.
+
+    If not set, the default behavior is to hang up the leg. When park_after_unbridge
+    is set, link_to becomes required.
+    """
+
     preferred_codecs: str
     """
     The list of comma-separated codecs in a preferred order for the forked media to
@@ -225,7 +234,7 @@ class CallDialParams(TypedDict, total=False):
     stream_bidirectional_mode: StreamBidirectionalMode
     """Configures method of bidirectional streaming (mp3, rtp)."""
 
-    stream_bidirectional_sampling_rate: Literal[8000, 16000, 48000]
+    stream_bidirectional_sampling_rate: StreamBidirectionalSamplingRate
     """Audio sampling rate."""
 
     stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
@@ -235,8 +244,7 @@ class CallDialParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_establish_before_call_originate: bool

telnyx/types/calls/__init__.py

@@ -52,6 +52,7 @@ from .action_start_recording_params import ActionStartRecordingParams as ActionS
 from .action_start_streaming_params import ActionStartStreamingParams as ActionStartStreamingParams
 from .action_stop_playback_response import ActionStopPlaybackResponse as ActionStopPlaybackResponse
 from .google_transcription_language import GoogleTranscriptionLanguage as GoogleTranscriptionLanguage
+from .telnyx_transcription_language import TelnyxTranscriptionLanguage as TelnyxTranscriptionLanguage
 from .action_resume_recording_params import ActionResumeRecordingParams as ActionResumeRecordingParams
 from .action_start_playback_response import ActionStartPlaybackResponse as ActionStartPlaybackResponse
 from .action_stop_recording_response import ActionStopRecordingResponse as ActionStopRecordingResponse

telnyx/types/calls/action_answer_params.py

@@ -124,8 +124,7 @@ class ActionAnswerParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]

telnyx/types/calls/action_gather_using_ai_params.py

@@ -67,20 +67,17 @@ class ActionGatherUsingAIParams(TypedDict, total=False):
     """Default is `false`.
 
     If set to `true`, the voice assistant will send updates to the message history
-    via the `call.ai_gather.message_history_updated`
-    [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)
-    in real time as the message history is updated.
+    via the `call.ai_gather.message_history_updated` callback in real time as the
+    message history is updated.
     """
 
     send_partial_results: bool
     """Default is `false`.
 
     If set to `true`, the voice assistant will send partial results via the
-    `call.ai_gather.partial_results`
-    [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)
-    in real time as individual fields are gathered. If set to `false`, the voice
-    assistant will only send the final result via the `call.ai_gather.ended`
-    callback.
+    `call.ai_gather.partial_results` callback in real time as individual fields are
+    gathered. If set to `false`, the voice assistant will only send the final result
+    via the `call.ai_gather.ended` callback.
     """
 
     transcription: TranscriptionConfigParam

telnyx/types/calls/action_start_streaming_params.py

@@ -9,6 +9,7 @@ from ..dialogflow_config_param import DialogflowConfigParam
 from ..stream_bidirectional_mode import StreamBidirectionalMode
 from ..stream_bidirectional_codec import StreamBidirectionalCodec
 from ..stream_bidirectional_target_legs import StreamBidirectionalTargetLegs
+from ..stream_bidirectional_sampling_rate import StreamBidirectionalSamplingRate
 
 __all__ = ["ActionStartStreamingParams"]
 
@@ -41,6 +42,9 @@ class ActionStartStreamingParams(TypedDict, total=False):
     stream_bidirectional_mode: StreamBidirectionalMode
     """Configures method of bidirectional streaming (mp3, rtp)."""
 
+    stream_bidirectional_sampling_rate: StreamBidirectionalSamplingRate
+    """Audio sampling rate."""
+
     stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
     """Specifies which call legs should receive the bidirectional stream audio."""
 
@@ -48,8 +52,7 @@ class ActionStartStreamingParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]

telnyx/types/calls/action_start_transcription_params.py

@@ -2,13 +2,23 @@
 
 from __future__ import annotations
 
-from typing import Union
-from typing_extensions import Literal, TypeAlias, TypedDict
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
+from .google_transcription_language import GoogleTranscriptionLanguage
+from .telnyx_transcription_language import TelnyxTranscriptionLanguage
 from .transcription_engine_a_config_param import TranscriptionEngineAConfigParam
 from .transcription_engine_b_config_param import TranscriptionEngineBConfigParam
 
-__all__ = ["ActionStartTranscriptionParams", "TranscriptionEngineConfig"]
+__all__ = [
+    "ActionStartTranscriptionParams",
+    "TranscriptionEngineConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext",
+    "TranscriptionEngineConfigTranscriptionEngineTelnyxConfig",
+    "TranscriptionEngineConfigTranscriptionEngineDeepgramConfig",
+]
 
 
 class ActionStartTranscriptionParams(TypedDict, total=False):
@@ -25,8 +35,12 @@ class ActionStartTranscriptionParams(TypedDict, total=False):
     `call_control_id`.
     """
 
-    transcription_engine: Literal["A", "B"]
-    """Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`."""
+    transcription_engine: Literal["Google", "Telnyx", "Deepgram", "A", "B"]
+    """Engine to use for speech recognition.
+
+    Legacy values `A` - `Google`, `B` - `Telnyx` are supported for backward
+    compatibility.
+    """
 
     transcription_engine_config: TranscriptionEngineConfig
 
@@ -38,4 +52,144 @@ class ActionStartTranscriptionParams(TypedDict, total=False):
     """
 
 
-TranscriptionEngineConfig: TypeAlias = Union[TranscriptionEngineAConfigParam, TranscriptionEngineBConfigParam]
+class TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext(TypedDict, total=False):
+    boost: float
+    """Boost factor for the speech context."""
+
+    phrases: SequenceNotStr[str]
+
+
+class TranscriptionEngineConfigTranscriptionEngineGoogleConfig(TypedDict, total=False):
+    enable_speaker_diarization: bool
+    """Enables speaker diarization."""
+
+    hints: SequenceNotStr[str]
+    """Hints to improve transcription accuracy."""
+
+    interim_results: bool
+    """Whether to send also interim results.
+
+    If set to false, only final results will be sent.
+    """
+
+    language: GoogleTranscriptionLanguage
+    """Language to use for speech recognition"""
+
+    max_speaker_count: int
+    """Defines maximum number of speakers in the conversation."""
+
+    min_speaker_count: int
+    """Defines minimum number of speakers in the conversation."""
+
+    model: Literal[
+        "latest_long",
+        "latest_short",
+        "command_and_search",
+        "phone_call",
+        "video",
+        "default",
+        "medical_conversation",
+        "medical_dictation",
+    ]
+    """The model to use for transcription."""
+
+    profanity_filter: bool
+    """Enables profanity_filter."""
+
+    speech_context: Iterable[TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext]
+    """Speech context to improve transcription accuracy."""
+
+    transcription_engine: Literal["Google"]
+    """Engine identifier for Google transcription service"""
+
+    use_enhanced: bool
+    """Enables enhanced transcription, this works for models `phone_call` and `video`."""
+
+
+class TranscriptionEngineConfigTranscriptionEngineTelnyxConfig(TypedDict, total=False):
+    language: TelnyxTranscriptionLanguage
+    """Language to use for speech recognition"""
+
+    transcription_engine: Literal["Telnyx"]
+    """Engine identifier for Telnyx transcription service"""
+
+    transcription_model: Literal["openai/whisper-tiny", "openai/whisper-large-v3-turbo"]
+    """The model to use for transcription."""
+
+
+class TranscriptionEngineConfigTranscriptionEngineDeepgramConfig(TypedDict, total=False):
+    transcription_engine: Required[Literal["Deepgram"]]
+    """Engine identifier for Deepgram transcription service"""
+
+    transcription_model: Required[Literal["deepgram/nova-2", "deepgram/nova-3"]]
+    """The model to use for transcription."""
+
+    language: Literal[
+        "bg",
+        "ca",
+        "zh",
+        "zh-CN",
+        "zh-Hans",
+        "zh-TW",
+        "zh-Hant",
+        "zh-HK",
+        "cs",
+        "da",
+        "da-DK",
+        "nl",
+        "en",
+        "en-US",
+        "en-AU",
+        "en-GB",
+        "en-NZ",
+        "en-IN",
+        "et",
+        "fi",
+        "nl-BE",
+        "fr",
+        "fr-CA",
+        "de",
+        "de-CH",
+        "el",
+        "hi",
+        "hu",
+        "id",
+        "it",
+        "ja",
+        "ko",
+        "ko-KR",
+        "lv",
+        "lt",
+        "ms",
+        "no",
+        "pl",
+        "pt",
+        "pt-BR",
+        "pt-PT",
+        "ro",
+        "ru",
+        "sk",
+        "es",
+        "es-419",
+        "sv",
+        "sv-SE",
+        "th",
+        "th-TH",
+        "tr",
+        "uk",
+        "vi",
+        "auto_detect",
+    ]
+    """Language to use for speech recognition.
+
+    Available languages depend on the selected model.
+    """
+
+
+TranscriptionEngineConfig: TypeAlias = Union[
+    TranscriptionEngineConfigTranscriptionEngineGoogleConfig,
+    TranscriptionEngineConfigTranscriptionEngineTelnyxConfig,
+    TranscriptionEngineConfigTranscriptionEngineDeepgramConfig,
+    TranscriptionEngineAConfigParam,
+    TranscriptionEngineBConfigParam,
+]