dv-pipecat-ai 0.0.74.dev770__py3-none-any.whl → 0.0.82.dev776__py3-none-any.whl

pipecat/transports/services/helpers/daily_rest.py

@@ -20,11 +20,11 @@ from pydantic import BaseModel, Field, ValidationError
 class DailyRoomSipParams(BaseModel):
     """SIP configuration parameters for Daily rooms.
 
-    Attributes:
-        display_name: Name shown for the SIP endpoint
-        video: Whether video is enabled for SIP
-        sip_mode: SIP connection mode, typically 'dial-in'
-        num_endpoints: Number of allowed SIP endpoints
+    Parameters:
+        display_name: Name shown for the SIP endpoint.
+        video: Whether video is enabled for SIP.
+        sip_mode: SIP connection mode, typically 'dial-in'.
+        num_endpoints: Number of allowed SIP endpoints.
     """
 
     display_name: str = "sw-sip-dialin"
@@ -38,6 +38,31 @@ class RecordingsBucketConfig(BaseModel):
 
     Refer to the Daily API documentation for more information:
     https://docs.daily.co/guides/products/live-streaming-recording/storing-recordings-in-a-custom-s3-bucket
+
+    Parameters:
+        bucket_name: Name of the S3 bucket for storing recordings.
+        bucket_region: AWS region where the S3 bucket is located.
+        assume_role_arn: ARN of the IAM role to assume for S3 access.
+        allow_api_access: Whether to allow API access to the recordings.
+    """
+
+    bucket_name: str
+    bucket_region: str
+    assume_role_arn: str
+    allow_api_access: bool = False
+
+
+class TranscriptionBucketConfig(BaseModel):
+    """Configuration for storing Daily transcription in a custom S3 bucket.
+
+    Refer to the Daily API documentation for more information:
+    https://docs.daily.co/guides/products/live-streaming-recording/storing-recordings-in-a-custom-s3-bucket
+
+    Parameters:
+        bucket_name: Name of the S3 bucket for storing transcription.
+        bucket_region: AWS region where the S3 bucket is located.
+        assume_role_arn: ARN of the IAM role to assume for S3 access.
+        allow_api_access: Whether to allow API access to the transcription.
     """
 
     bucket_name: str
@@ -49,21 +74,24 @@ class RecordingsBucketConfig(BaseModel):
 class DailyRoomProperties(BaseModel, extra="allow"):
     """Properties for configuring a Daily room.
 
-    Attributes:
-        exp: Optional Unix epoch timestamp for room expiration (e.g., time.time() + 300 for 5 minutes)
-        enable_chat: Whether chat is enabled in the room
-        enable_prejoin_ui: Whether the pre-join UI is enabled
-        enable_emoji_reactions: Whether emoji reactions are enabled
-        eject_at_room_exp: Whether to remove participants when room expires
-        enable_dialout: Whether SIP dial-out is enabled
-        enable_recording: Recording settings ('cloud', 'local', 'raw-tracks')
-        geo: Geographic region for room
-        max_participants: Maximum number of participants allowed in the room
-        sip: SIP configuration parameters
-        sip_uri: SIP URI information returned by Daily
-        start_video_off: Whether video is off by default
-
     Reference: https://docs.daily.co/reference/rest-api/rooms/create-room#properties
+
+    Parameters:
+        exp: Optional Unix epoch timestamp for room expiration (e.g., time.time() + 300 for 5 minutes).
+        enable_chat: Whether chat is enabled in the room.
+        enable_prejoin_ui: Whether the pre-join UI is enabled.
+        enable_emoji_reactions: Whether emoji reactions are enabled.
+        eject_at_room_exp: Whether to remove participants when room expires.
+        enable_dialout: Whether SIP dial-out is enabled.
+        enable_recording: Recording settings ('cloud', 'local', 'raw-tracks').
+        enable_transcription_storage: Whether transcription storage is enabled.
+        geo: Geographic region for room.
+        max_participants: Maximum number of participants allowed in the room.
+        recordings_bucket: Configuration for custom S3 bucket recordings.
+        transcription_bucket: Configuration for custom S3 bucket transcription.
+        sip: SIP configuration parameters.
+        sip_uri: SIP URI information returned by Daily.
+        start_video_off: Whether video is off by default.
     """
 
     exp: Optional[float] = None
@@ -73,9 +101,11 @@ class DailyRoomProperties(BaseModel, extra="allow"):
     eject_at_room_exp: bool = False
     enable_dialout: Optional[bool] = None
     enable_recording: Optional[Literal["cloud", "local", "raw-tracks"]] = None
+    enable_transcription_storage: Optional[bool] = None
     geo: Optional[str] = None
     max_participants: Optional[int] = None
     recordings_bucket: Optional[RecordingsBucketConfig] = None
+    transcription_bucket: Optional[TranscriptionBucketConfig] = None
     sip: Optional[DailyRoomSipParams] = None
     sip_uri: Optional[dict] = None
     start_video_off: bool = False
@@ -85,7 +115,7 @@ class DailyRoomProperties(BaseModel, extra="allow"):
         """Get the SIP endpoint URI if available.
 
         Returns:
-            str: SIP endpoint URI or empty string if not available
+            SIP endpoint URI or empty string if not available.
         """
         if not self.sip_uri:
             return ""
@@ -96,10 +126,10 @@ class DailyRoomProperties(BaseModel, extra="allow"):
 class DailyRoomParams(BaseModel):
     """Parameters for creating a Daily room.
 
-    Attributes:
-        name: Optional custom name for the room
-        privacy: Room privacy setting ('private' or 'public')
-        properties: Room configuration properties
+    Parameters:
+        name: Optional custom name for the room.
+        privacy: Room privacy setting ('private' or 'public').
+        properties: Room configuration properties.
     """
 
     name: Optional[str] = None
@@ -110,14 +140,14 @@ class DailyRoomParams(BaseModel):
 class DailyRoomObject(BaseModel):
     """Represents a Daily room returned by the API.
 
-    Attributes:
-        id: Unique room identifier
-        name: Room name
-        api_created: Whether room was created via API
-        privacy: Room privacy setting ('private' or 'public')
-        url: Full URL for joining the room
+    Parameters:
+        id: Unique room identifier.
+        name: Room name.
+        api_created: Whether room was created via API.
+        privacy: Room privacy setting ('private' or 'public').
+        url: Full URL for joining the room.
         created_at: Timestamp of room creation in ISO 8601 format (e.g., "2019-01-26T09:01:22.000Z").
-        config: Room configuration properties
+        config: Room configuration properties.
     """
 
     id: str
@@ -134,71 +164,40 @@ class DailyMeetingTokenProperties(BaseModel):
 
     Refer to the Daily API documentation for more information:
     https://docs.daily.co/reference/rest-api/meeting-tokens/create-meeting-token#properties
+
+    Parameters:
+        room_name: The room for which this token is valid. If not set, the token is valid for all rooms in your domain.
+        eject_at_token_exp: If True, the user will be ejected from the room when the token expires.
+        eject_after_elapsed: The number of seconds after which the user will be ejected from the room.
+        nbf: Not before timestamp - users cannot join with this token before this time.
+        exp: Expiration time (unix timestamp in seconds). Strongly recommended for security.
+        is_owner: If True, the token will grant owner privileges in the room.
+        user_name: The name of the user. This will be added to the token payload.
+        user_id: A unique identifier for the user. This will be added to the token payload.
+        enable_screenshare: If True, the user will be able to share their screen.
+        start_video_off: If True, the user's video will be turned off when they join the room.
+        start_audio_off: If True, the user's audio will be turned off when they join the room.
+        enable_recording: Recording settings for the token. Must be one of 'cloud', 'local' or 'raw-tracks'.
+        enable_prejoin_ui: If True, the user will see the prejoin UI before joining the room.
+        start_cloud_recording: Start cloud recording when the user joins the room.
+        permissions: Specifies the initial default permissions for a non-meeting-owner participant.
     """
 
-    room_name: Optional[str] = Field(
-        default=None,
-        description="The room for which this token is valid. If not set, the token is valid for all rooms in your domain. You should always set room_name if using this token to control meeting access.",
-    )
-
-    eject_at_token_exp: Optional[bool] = Field(
-        default=None,
-        description="If `true`, the user will be ejected from the room when the token expires. Defaults to `false`.",
-    )
-    eject_after_elapsed: Optional[int] = Field(
-        default=None,
-        description="The number of seconds after which the user will be ejected from the room. If not provided, the user will not be ejected based on elapsed time.",
-    )
-
-    nbf: Optional[int] = Field(
-        default=None,
-        description="Not before. This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in with this token before this time.",
-    )
-
-    exp: Optional[int] = Field(
-        default=None,
-        description="Expiration time (unix timestamp in seconds). We strongly recommend setting this value for security. If not set, the token will not expire. Refer docs for more info.",
-    )
-    is_owner: Optional[bool] = Field(
-        default=None,
-        description="If `true`, the token will grant owner privileges in the room. Defaults to `false`.",
-    )
-    user_name: Optional[str] = Field(
-        default=None,
-        description="The name of the user. This will be added to the token payload.",
-    )
-    user_id: Optional[str] = Field(
-        default=None,
-        description="A unique identifier for the user. This will be added to the token payload.",
-    )
-    enable_screenshare: Optional[bool] = Field(
-        default=None,
-        description="If `true`, the user will be able to share their screen. Defaults to `true`.",
-    )
-    start_video_off: Optional[bool] = Field(
-        default=None,
-        description="If `true`, the user's video will be turned off when they join the room. Defaults to `false`.",
-    )
-    start_audio_off: Optional[bool] = Field(
-        default=None,
-        description="If `true`, the user's audio will be turned off when they join the room. Defaults to `false`.",
-    )
-    enable_recording: Optional[Literal["cloud", "local", "raw-tracks"]] = Field(
-        default=None,
-        description="Recording settings for the token. Must be one of `cloud`, `local` or `raw-tracks`.",
-    )
-    enable_prejoin_ui: Optional[bool] = Field(
-        default=None,
-        description="If `true`, the user will see the prejoin UI before joining the room.",
-    )
-    start_cloud_recording: Optional[bool] = Field(
-        default=None,
-        description="Start cloud recording when the user joins the room. This can be used to always record and archive meetings, for example in a customer support context.",
-    )
-    permissions: Optional[dict] = Field(
-        default=None,
-        description="Specifies the initial default permissions for a non-meeting-owner participant joining a call.",
-    )
+    room_name: Optional[str] = None
+    eject_at_token_exp: Optional[bool] = None
+    eject_after_elapsed: Optional[int] = None
+    nbf: Optional[int] = None
+    exp: Optional[int] = None
+    is_owner: Optional[bool] = None
+    user_name: Optional[str] = None
+    user_id: Optional[str] = None
+    enable_screenshare: Optional[bool] = None
+    start_video_off: Optional[bool] = None
+    start_audio_off: Optional[bool] = None
+    enable_recording: Optional[Literal["cloud", "local", "raw-tracks"]] = None
+    enable_prejoin_ui: Optional[bool] = None
+    start_cloud_recording: Optional[bool] = None
+    permissions: Optional[dict] = None
 
 
 class DailyMeetingTokenParams(BaseModel):
@@ -206,6 +205,9 @@ class DailyMeetingTokenParams(BaseModel):
 
     Refer to the Daily API documentation for more information:
     https://docs.daily.co/reference/rest-api/meeting-tokens/create-meeting-token#body-params
+
+    Parameters:
+        properties: Meeting token configuration properties.
     """
 
     properties: DailyMeetingTokenProperties = Field(default_factory=DailyMeetingTokenProperties)
@@ -215,11 +217,6 @@ class DailyRESTHelper:
     """Helper class for interacting with Daily's REST API.
 
     Provides methods for creating, managing, and accessing Daily rooms.
-
-    Args:
-        daily_api_key: Your Daily API key
-        daily_api_url: Daily API base URL (e.g. "https://api.daily.co/v1")
-        aiohttp_session: Async HTTP session for making requests
     """
 
     def __init__(
@@ -229,7 +226,13 @@ class DailyRESTHelper:
         daily_api_url: str = "https://api.daily.co/v1",
         aiohttp_session: aiohttp.ClientSession,
     ):
-        """Initialize the Daily REST helper."""
+        """Initialize the Daily REST helper.
+
+        Args:
+            daily_api_key: Your Daily API key.
+            daily_api_url: Daily API base URL (e.g. "https://api.daily.co/v1").
+            aiohttp_session: Async HTTP session for making requests.
+        """
         self.daily_api_key = daily_api_key
         self.daily_api_url = daily_api_url
         self.aiohttp_session = aiohttp_session
@@ -238,10 +241,10 @@ class DailyRESTHelper:
         """Extract room name from a Daily room URL.
 
         Args:
-            room_url: Full Daily room URL
+            room_url: Full Daily room URL.
 
         Returns:
-            str: Room name portion of the URL
+            Room name portion of the URL.
         """
         return urlparse(room_url).path[1:]
 
@@ -249,10 +252,10 @@ class DailyRESTHelper:
         """Get room details from a Daily room URL.
 
         Args:
-            room_url: Full Daily room URL
+            room_url: Full Daily room URL.
 
         Returns:
-            DailyRoomObject: DailyRoomObject instance for the room
+            DailyRoomObject instance for the room.
         """
         room_name = self.get_name_from_url(room_url)
         return await self._get_room_from_name(room_name)
@@ -261,13 +264,13 @@ class DailyRESTHelper:
         """Create a new Daily room.
 
         Args:
-            params: Room configuration parameters
+            params: Room configuration parameters.
 
         Returns:
-            DailyRoomObject: DailyRoomObject instance for the created room
+            DailyRoomObject instance for the created room.
 
         Raises:
-            Exception: If room creation fails or response is invalid
+            Exception: If room creation fails or response is invalid.
         """
         headers = {"Authorization": f"Bearer {self.daily_api_key}"}
         json = params.model_dump(exclude_none=True)
@@ -298,19 +301,19 @@ class DailyRESTHelper:
         """Generate a meeting token for user to join a Daily room.
 
         Args:
-            room_url: Daily room URL
-            expiry_time: Token validity duration in seconds (default: 1 hour)
-            eject_at_token_exp: Whether to eject user when token expires
-            owner: Whether token has owner privileges
+            room_url: Daily room URL.
+            expiry_time: Token validity duration in seconds (default: 1 hour).
+            eject_at_token_exp: Whether to eject user when token expires.
+            owner: Whether token has owner privileges.
             params: Optional additional token properties. Note that room_name,
                 exp, and is_owner will be set based on the other function
                 parameters regardless of values in params.
 
         Returns:
-            str: Meeting token
+            Meeting token.
 
         Raises:
-            Exception: If token generation fails or room URL is missing
+            Exception: If token generation fails or room URL is missing.
         """
         if not room_url:
             raise Exception(
@@ -355,10 +358,10 @@ class DailyRESTHelper:
         """Delete a room using its URL.
 
         Args:
-            room_url: Daily room URL
+            room_url: Daily room URL.
 
         Returns:
-            bool: True if deletion was successful
+            True if deletion was successful.
         """
         room_name = self.get_name_from_url(room_url)
         return await self.delete_room_by_name(room_name)
@@ -367,13 +370,13 @@ class DailyRESTHelper:
         """Delete a room using its name.
 
         Args:
-            room_name: Name of the room to delete
+            room_name: Name of the room to delete.
 
         Returns:
-            bool: True if deletion was successful
+            True if deletion was successful.
 
         Raises:
-            Exception: If deletion fails (excluding 404 Not Found)
+            Exception: If deletion fails (excluding 404 Not Found).
         """
         headers = {"Authorization": f"Bearer {self.daily_api_key}"}
         async with self.aiohttp_session.delete(
@@ -386,17 +389,7 @@ class DailyRESTHelper:
         return True
 
     async def _get_room_from_name(self, room_name: str) -> DailyRoomObject:
-        """Internal method to get room details by name.
-
-        Args:
-            room_name: Name of the room
-
-        Returns:
-            DailyRoomObject: DailyRoomObject instance for the room
-
-        Raises:
-            Exception: If room is not found or response is invalid
-        """
+        """Internal method to get room details by name."""
         headers = {"Authorization": f"Bearer {self.daily_api_key}"}
         async with self.aiohttp_session.get(
             f"{self.daily_api_url}/rooms/{room_name}", headers=headers