Implementation:Elevenlabs Elevenlabs python GetPronunciationDictionaryMetadataResponse

Attribute	Value
Page Type	Implementation
Package	elevenlabs
Module	elevenlabs.types.get_pronunciation_dictionary_metadata_response
Class	GetPronunciationDictionaryMetadataResponse
Base Class	UncheckedBaseModel
Source File	src/elevenlabs/types/get_pronunciation_dictionary_metadata_response.py
Auto-Generated	Yes (Fern API Definition)

Overview

Description

GetPronunciationDictionaryMetadataResponse is a Pydantic-based data model representing the metadata of a pronunciation dictionary in the ElevenLabs platform. It contains identification information, versioning details, rule counts, ownership data, timestamps, and optional description and permission fields. Pronunciation dictionaries define custom pronunciation rules used during text-to-speech synthesis.

Usage

This model is returned by API endpoints that retrieve metadata about a pronunciation dictionary. It provides all the administrative and versioning information needed to manage dictionaries, including the latest version ID and the number of rules it contains. The model supports optional fields for archival timestamps, descriptions, and permission information.

Code Reference

Source Location

src/elevenlabs/types/get_pronunciation_dictionary_metadata_response.py

Class Signature

class GetPronunciationDictionaryMetadataResponse(UncheckedBaseModel):
    ...

Import Statement

from elevenlabs.types.get_pronunciation_dictionary_metadata_response import GetPronunciationDictionaryMetadataResponse

I/O Contract

Field Name	Type	Required	Default	Description
id	str	Yes	N/A	The ID of the pronunciation dictionary
latest_version_id	str	Yes	N/A	The ID of the latest version of the pronunciation dictionary
latest_version_rules_num	int	Yes	N/A	The number of rules in the latest version of the pronunciation dictionary
name	str	Yes	N/A	The name of the pronunciation dictionary
permission_on_resource	Optional[GetPronunciationDictionaryMetadataResponseModelPermissionOnResource]	No	None	The permission on the resource of the pronunciation dictionary
created_by	str	Yes	N/A	The user ID of the creator of the pronunciation dictionary
creation_time_unix	int	Yes	N/A	The creation time of the pronunciation dictionary in Unix timestamp
archived_time_unix	Optional[int]	No	None	The archive time of the pronunciation dictionary in Unix timestamp
description	Optional[str]	No	None	The description of the pronunciation dictionary

Usage Examples

Accessing Dictionary Metadata

from elevenlabs.types.get_pronunciation_dictionary_metadata_response import (
    GetPronunciationDictionaryMetadataResponse,
)

# Assuming `response` is a GetPronunciationDictionaryMetadataResponse from the API
print(f"Dictionary: {response.name} (ID: {response.id})")
print(f"Latest version: {response.latest_version_id}")
print(f"Number of rules: {response.latest_version_rules_num}")
print(f"Created by: {response.created_by}")

Checking Archival Status and Permissions

import datetime

# Check if the dictionary has been archived
if response.archived_time_unix:
    archived_dt = datetime.datetime.fromtimestamp(response.archived_time_unix)
    print(f"Archived on: {archived_dt}")
else:
    print("Dictionary is active")

# Check creation time
created_dt = datetime.datetime.fromtimestamp(response.creation_time_unix)
print(f"Created on: {created_dt}")

# Check permissions
if response.permission_on_resource:
    print(f"Permission: {response.permission_on_resource}")

# Access optional description
if response.description:
    print(f"Description: {response.description}")

Related Pages

• Elevenlabs_Elevenlabs_python_KnowledgeBaseLocator