telnyx 3.2.0__tar.gz → 3.3.0__tar.gz

telnyx-3.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "3.3.0"
+}

{telnyx-3.2.0 → telnyx-3.3.0}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 3.3.0 (2025-10-06)
+
+Full Changelog: [v3.2.0...v3.3.0](https://github.com/team-telnyx/telnyx-python/compare/v3.2.0...v3.3.0)
+
+### Features
+
+* Fix listing deepgram languages for transcription start ([e348b76](https://github.com/team-telnyx/telnyx-python/commit/e348b7666742f3449cf70eef7801f3e68fc31026))
+* TELAPPS-5367: Update transcription start docs ([ce4c62c](https://github.com/team-telnyx/telnyx-python/commit/ce4c62ca1e2c210975be6a6844efaa39244658c4))
+
 ## 3.2.0 (2025-10-01)
 
 Full Changelog: [v3.1.0...v3.2.0](https://github.com/team-telnyx/telnyx-python/compare/v3.1.0...v3.2.0)

{telnyx-3.2.0 → telnyx-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telnyx
-Version: 3.2.0
+Version: 3.3.0
 Summary: The official Python library for the telnyx API
 Project-URL: Homepage, https://github.com/team-telnyx/telnyx-python
 Project-URL: Repository, https://github.com/team-telnyx/telnyx-python

{telnyx-3.2.0 → telnyx-3.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "telnyx"
-version = "3.2.0"
+version = "3.3.0"
 description = "The official Python library for the telnyx API"
 dynamic = ["readme"]
 license = "MIT"

{telnyx-3.2.0 → telnyx-3.3.0}/src/telnyx/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "telnyx"
-__version__ = "3.2.0"  # x-release-please-version
+__version__ = "3.3.0"  # x-release-please-version

{telnyx-3.2.0 → telnyx-3.3.0}/src/telnyx/resources/calls/actions.py

@@ -2506,7 +2506,7 @@ class ActionsResource(SyncAPIResource):
         *,
         client_state: str | Omit = omit,
         command_id: str | Omit = omit,
-        transcription_engine: Literal["A", "B"] | Omit = omit,
+        transcription_engine: Literal["Google", "Telnyx", "Deepgram", "A", "B"] | Omit = omit,
         transcription_engine_config: action_start_transcription_params.TranscriptionEngineConfig | Omit = omit,
         transcription_tracks: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -2532,7 +2532,8 @@ class ActionsResource(SyncAPIResource):
           command_id: Use this field to avoid duplicate commands. Telnyx will ignore any command with
               the same `command_id` for the same `call_control_id`.
 
-          transcription_engine: Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`.
+          transcription_engine: Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+              `Telnyx` are supported for backward compatibility.
 
           transcription_tracks: Indicates which leg of the call will be transcribed. Use `inbound` for the leg
               that requested the transcription, `outbound` for the other leg, and `both` for
@@ -5748,7 +5749,7 @@ class AsyncActionsResource(AsyncAPIResource):
         *,
         client_state: str | Omit = omit,
         command_id: str | Omit = omit,
-        transcription_engine: Literal["A", "B"] | Omit = omit,
+        transcription_engine: Literal["Google", "Telnyx", "Deepgram", "A", "B"] | Omit = omit,
         transcription_engine_config: action_start_transcription_params.TranscriptionEngineConfig | Omit = omit,
         transcription_tracks: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -5774,7 +5775,8 @@ class AsyncActionsResource(AsyncAPIResource):
           command_id: Use this field to avoid duplicate commands. Telnyx will ignore any command with
               the same `command_id` for the same `call_control_id`.
 
-          transcription_engine: Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`.
+          transcription_engine: Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+              `Telnyx` are supported for backward compatibility.
 
           transcription_tracks: Indicates which leg of the call will be transcribed. Use `inbound` for the leg
               that requested the transcription, `outbound` for the other leg, and `both` for

telnyx-3.3.0/src/telnyx/types/calls/action_start_transcription_params.py

@@ -0,0 +1,295 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+from .google_transcription_language import GoogleTranscriptionLanguage
+from .transcription_engine_a_config_param import TranscriptionEngineAConfigParam
+from .transcription_engine_b_config_param import TranscriptionEngineBConfigParam
+
+__all__ = [
+    "ActionStartTranscriptionParams",
+    "TranscriptionEngineConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext",
+    "TranscriptionEngineConfigTranscriptionEngineTelnyxConfig",
+    "TranscriptionEngineConfigTranscriptionEngineDeepgramConfig",
+]
+
+
+class ActionStartTranscriptionParams(TypedDict, total=False):
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    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
+
+    transcription_tracks: str
+    """Indicates which leg of the call will be transcribed.
+
+    Use `inbound` for the leg that requested the transcription, `outbound` for the
+    other leg, and `both` for both legs of the call. Will default to `inbound`.
+    """
+
+
+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: Literal[
+        "en",
+        "zh",
+        "de",
+        "es",
+        "ru",
+        "ko",
+        "fr",
+        "ja",
+        "pt",
+        "tr",
+        "pl",
+        "ca",
+        "nl",
+        "ar",
+        "sv",
+        "it",
+        "id",
+        "hi",
+        "fi",
+        "vi",
+        "he",
+        "uk",
+        "el",
+        "ms",
+        "cs",
+        "ro",
+        "da",
+        "hu",
+        "ta",
+        "no",
+        "th",
+        "ur",
+        "hr",
+        "bg",
+        "lt",
+        "la",
+        "mi",
+        "ml",
+        "cy",
+        "sk",
+        "te",
+        "fa",
+        "lv",
+        "bn",
+        "sr",
+        "az",
+        "sl",
+        "kn",
+        "et",
+        "mk",
+        "br",
+        "eu",
+        "is",
+        "hy",
+        "ne",
+        "mn",
+        "bs",
+        "kk",
+        "sq",
+        "sw",
+        "gl",
+        "mr",
+        "pa",
+        "si",
+        "km",
+        "sn",
+        "yo",
+        "so",
+        "af",
+        "oc",
+        "ka",
+        "be",
+        "tg",
+        "sd",
+        "gu",
+        "am",
+        "yi",
+        "lo",
+        "uz",
+        "fo",
+        "ht",
+        "ps",
+        "tk",
+        "nn",
+        "mt",
+        "sa",
+        "lb",
+        "my",
+        "bo",
+        "tl",
+        "mg",
+        "as",
+        "tt",
+        "haw",
+        "ln",
+        "ha",
+        "ba",
+        "jw",
+        "su",
+        "auto_detect",
+    ]
+    """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,
+]

telnyx-3.3.0/src/telnyx/types/calls/transcription_start_request_param.py

@@ -0,0 +1,295 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+from .google_transcription_language import GoogleTranscriptionLanguage
+from .transcription_engine_a_config_param import TranscriptionEngineAConfigParam
+from .transcription_engine_b_config_param import TranscriptionEngineBConfigParam
+
+__all__ = [
+    "TranscriptionStartRequestParam",
+    "TranscriptionEngineConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext",
+    "TranscriptionEngineConfigTranscriptionEngineTelnyxConfig",
+    "TranscriptionEngineConfigTranscriptionEngineDeepgramConfig",
+]
+
+
+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: Literal[
+        "en",
+        "zh",
+        "de",
+        "es",
+        "ru",
+        "ko",
+        "fr",
+        "ja",
+        "pt",
+        "tr",
+        "pl",
+        "ca",
+        "nl",
+        "ar",
+        "sv",
+        "it",
+        "id",
+        "hi",
+        "fi",
+        "vi",
+        "he",
+        "uk",
+        "el",
+        "ms",
+        "cs",
+        "ro",
+        "da",
+        "hu",
+        "ta",
+        "no",
+        "th",
+        "ur",
+        "hr",
+        "bg",
+        "lt",
+        "la",
+        "mi",
+        "ml",
+        "cy",
+        "sk",
+        "te",
+        "fa",
+        "lv",
+        "bn",
+        "sr",
+        "az",
+        "sl",
+        "kn",
+        "et",
+        "mk",
+        "br",
+        "eu",
+        "is",
+        "hy",
+        "ne",
+        "mn",
+        "bs",
+        "kk",
+        "sq",
+        "sw",
+        "gl",
+        "mr",
+        "pa",
+        "si",
+        "km",
+        "sn",
+        "yo",
+        "so",
+        "af",
+        "oc",
+        "ka",
+        "be",
+        "tg",
+        "sd",
+        "gu",
+        "am",
+        "yi",
+        "lo",
+        "uz",
+        "fo",
+        "ht",
+        "ps",
+        "tk",
+        "nn",
+        "mt",
+        "sa",
+        "lb",
+        "my",
+        "bo",
+        "tl",
+        "mg",
+        "as",
+        "tt",
+        "haw",
+        "ln",
+        "ha",
+        "ba",
+        "jw",
+        "su",
+        "auto_detect",
+    ]
+    """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,
+]
+
+
+class TranscriptionStartRequestParam(TypedDict, total=False):
+    client_state: str
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    command_id: str
+    """Use this field to avoid duplicate commands.
+
+    Telnyx will ignore any command with the same `command_id` for the same
+    `call_control_id`.
+    """
+
+    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
+
+    transcription_tracks: str
+    """Indicates which leg of the call will be transcribed.
+
+    Use `inbound` for the leg that requested the transcription, `outbound` for the
+    other leg, and `both` for both legs of the call. Will default to `inbound`.
+    """