Skip to main content

Référence du SDK Python pour les mots chauds personnalisés

Le SDK Python permet de créer, lister, interroger, mettre à jour et supprimer des vocabulaires personnalisés pour la reconnaissance vocale.

Alibaba Cloud Model Studio a publié des domaines spécifiques aux espaces de travail pour les régions Chine (Pékin) et Singapour. Ces nouveaux domaines dédiés offrent des performances supérieures et une stabilité accrue pour les requêtes d'inférence. Nous vous recommandons de migrer vers ces nouveaux domaines :
  • Chine (Pékin) : de dashscope.aliyuncs.com vers {WorkspaceId}.cn-beijing.maas.aliyuncs.com
  • Singapour : de dashscope-intl.aliyuncs.com vers {WorkspaceId}.ap-southeast-1.maas.aliyuncs.com
Remplacez {WorkspaceId} par votre ID d'espace de travail. Les domaines existants restent pleinement fonctionnels.
Guide utilisateur : Améliorer la précision de la reconnaissance.
Les vocabulaires personnalisés sont uniquement pris en charge dans l'espace de travail principal. Les sous-espaces de travail ne les prennent pas en charge.

Endpoint

Par défaut, le SDK se connecte à l'endpoint de la région Chine (Pékin). Pour utiliser une autre région, spécifiez le paramètre region lors de la construction de dashscope.Client (par exemple, ap-southeast-1 pour la région Singapour).
  • Singapore
  • China (Beijing)
https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1Remplacez {WorkspaceId} par votre ID d'espace de travail.
Pour utiliser la région Singapour, construisez le client avec le paramètre region :
import os
import dashscope

# Spécifiez la région lors de la construction du Client
client = dashscope.Client(
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    workspace="{WorkspaceId}",
    region="ap-southeast-1",
)
Remarque :
  • Les clés API varient selon les régions. Utilisez la clé API correspondant à votre région.
  • La configuration de région s'applique au niveau de l'instance dashscope.Client et n'affecte que les appels API effectués avec ce client.

client.audio.vocabularies

Entrée de ressource : la ressource client.audio.vocabularies d'une instance dashscope.Client Fonction : gérer le cycle de vie des vocabulaires personnalisés (création, consultation, mise à jour et suppression).

Constructeur

import os
import dashscope

client = dashscope.Client(
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    workspace='{WorkspaceId}',
    region='ap-southeast-1',
)
Si api_key n'est pas transmis, le SDK lit automatiquement la valeur de la variable d'environnement DASHSCOPE_API_KEY.

create() - Créer un vocabulaire personnalisé

Signature de la méthode :
def create(
    self,
    *,
    target_model: str,
    prefix: str,
    vocabulary: List[dict]) -> Vocabulary
Paramètres :

Paramètre

Type

Obligatoire

Description

target_model

str

Oui

Modèle de reconnaissance vocale utilisant ce vocabulaire. Cette valeur doit correspondre au modèle spécifié lors de l'appel à l'API de reconnaissance vocale.

prefix

str

Oui

Préfixe personnalisé pour le vocabulaire. Seules les lettres minuscules et les chiffres sont autorisés, avec une longueur maximale de 10 caractères.

vocabulary

List[dict]

Oui

Liste de mots chauds. Chaque entrée est un dictionnaire contenant les champs text, weight et lang.

Pour plus d'informations, consultez Structure du dictionnaire de mots chauds.

Valeur de retour :

Type

Description

Vocabulary

Objet vocabulaire ; obtenez l'ID du vocabulaire via le champ vocabulary_id.

list() - Lister les vocabulaires personnalisés

Correspond à l'action de l'API HTTP action: list_vocabulary. Signature de la méthode :
def list(
    self,
    *,
    prefix: str = None,
    page_index: int = 0,
    page_size: int = 10) -> VocabularyList
Paramètres :

Paramètre

Type

Obligatoire

Description

prefix

str

Non

Préfixe personnalisé du vocabulaire. Si spécifié, seuls les vocabulaires portant ce préfixe sont retournés.

page_index

int

Non

Numéro de page, commençant à 0.

Valeur par défaut : 0.

page_size

int

Non

Nombre d'entrées par page.

Valeur par défaut : 10.

Valeur de retour :

Type

Description

VocabularyList

Objet de pagination des vocabulaires ; le champ vocabularies est un tableau contenant les informations de chaque vocabulaire (vocabulary_id, gmt_create, gmt_modified, status).

Champs retournés par list() :
ChampTypeDescription
vocabulary_idstrID du vocabulaire.
gmt_createstrDate de création.
gmt_modifiedstrDate de dernière modification.
statusstrÉtat du vocabulaire :
  • OK : Prêt.
  • UNDEPLOYED : Non disponible.

get() - Interroger un vocabulaire personnalisé

Correspond à la méthode query_vocabulary() du SDK 1.x. Signature de la méthode :
def get(
    self,
    vocabulary_id: str) -> Vocabulary
Paramètres :

Paramètre

Type

Obligatoire

Description

vocabulary_id

str

Oui

ID du vocabulaire personnalisé à interroger.

Valeur de retour :

Type

Description

Vocabulary

Objet contenant les informations détaillées du vocabulaire, incluant vocabulary, target_model, gmt_create, gmt_modified et status.

Champs retournés par get() :
ChampTypeDescription
vocabularyList[dict]Contenu de la liste des mots chauds.
target_modelstrModèle de reconnaissance vocale utilisant ce vocabulaire. Cette valeur doit correspondre au modèle spécifié lors de l'appel à l'API de reconnaissance vocale.
gmt_createstrDate de création.
gmt_modifiedstrDate de dernière modification.
statusstrÉtat du vocabulaire :
  • OK : Prêt.
  • UNDEPLOYED : Non disponible.

update() - Mettre à jour un vocabulaire personnalisé

Signature de la méthode :
def update(
    self,
    vocabulary_id: str,
    *,
    vocabulary: List[dict]) -> JobStatus
Paramètres :

Paramètre

Type

Obligatoire

Description

vocabulary_id

str

Oui

ID du vocabulaire à mettre à jour.

vocabulary

List[dict]

Oui

Nouveau vocabulaire. Ce contenu remplace intégralement les entrées existantes.

Valeur de retour : objet JobStatus ; le champ status indique l'état de l'opération.

delete() - Supprimer un vocabulaire personnalisé

Signature de la méthode :
def delete(
    self,
    vocabulary_id: str) -> JobStatus
Paramètres :

Paramètre

Type

Obligatoire

Description

vocabulary_id

str

Oui

ID du vocabulaire à supprimer.

Valeur de retour : objet JobStatus ; le champ status indique l'état de l'opération.

Structure du dictionnaire de mots chauds

Champs de chaque dictionnaire de vocabulaire :
ChampTypeObligatoireDescription
textstrOuiTexte de l'entrée du vocabulaire.La langue du texte doit être prise en charge par le modèle sélectionné. Les langues compatibles varient selon le modèle.Utilisez des mots réels plutôt que des combinaisons de caractères arbitraires afin d'améliorer la précision de la reconnaissance.Longueur maximale : 15 caractères pour un texte incluant des caractères non ASCII, ou 7 mots séparés par des espaces pour un texte exclusivement ASCII.
weightintOuiPoids de l'entrée du vocabulaire. Valeur recommandée : 4.Valeurs valides : 1 à 5.Si la précision de la reconnaissance ne s'améliore pas, augmentez le poids. Un poids excessivement élevé risque toutefois de réduire la précision de reconnaissance des autres mots.
langstrNonCode de langue de l'audio à reconnaître. Lorsque ce paramètre est défini, le système améliore la reconnaissance des entrées de vocabulaire dans la langue spécifiée. Si vous ne pouvez pas déterminer la langue à l'avance, laissez ce paramètre vide. Le modèle détectera automatiquement la langue.Valeurs valides (variables selon le modèle) :
  • Paraformer :
    • zh : Chinois
    • en : Anglais
    • ja : Japonais
    • yue : Cantonais
    • ko : Coréen
    • de : Allemand
    • fr : Français
    • ru : Russe
  • Fun-ASR :
    • zh : Chinois
    • en : Anglais
    • ja : Japonais

Exemples de code

Tous les exemples lisent la clé API depuis une variable d'environnement.

Créer un vocabulaire personnalisé

import os
import dashscope

# L'API Key diffère entre les régions de Singapour et de Pékin. Obtenez une API Key : https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Si la variable d'environnement n'est pas configurée, remplacez la ligne suivante par votre API Key de Model Studio : api_key="sk-xxx"
client = dashscope.Client(
    api_key=os.environ.get('DASHSCOPE_API_KEY'),
    # Voici la configuration de la région de Singapour (ap-southeast-1). Lors de l'appel, remplacez "{WorkspaceId}" par l'ID réel de votre workspace. La configuration varie selon la région.
    workspace='{WorkspaceId}',
    region='ap-southeast-1',
)

prefix = 'testpfx'
target_model = "fun-asr"

my_vocabulary = [
    {"text": "Seediq Bale", "weight": 4}
]

# Créer le vocabulaire
vocabulary = client.audio.vocabularies.create(
    prefix=prefix,
    target_model=target_model,
    vocabulary=my_vocabulary)

print(f"ID du vocabulaire: {vocabulary.vocabulary_id}")

Lister les vocabulaires personnalisés

import json
import os
import dashscope

# L'API Key diffère entre les régions de Singapour et de Pékin. Obtenez une API Key : https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Si la variable d'environnement n'est pas configurée, remplacez la ligne suivante par votre API Key de Model Studio : api_key="sk-xxx"
client = dashscope.Client(
    api_key=os.environ.get('DASHSCOPE_API_KEY'),
    # Voici la configuration de la région de Singapour (ap-southeast-1). Lors de l'appel, remplacez "{WorkspaceId}" par l'ID réel de votre workspace. La configuration varie selon la région.
    workspace='{WorkspaceId}',
    region='ap-southeast-1',
)

result = client.audio.vocabularies.list()
print(f"Vocabulaires: {json.dumps(result.vocabularies)}")

Interroger un vocabulaire personnalisé

import json
import os
import dashscope

# L'API Key diffère entre les régions de Singapour et de Pékin. Obtenez une API Key : https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Si la variable d'environnement n'est pas configurée, remplacez la ligne suivante par votre API Key de Model Studio : api_key="sk-xxx"
client = dashscope.Client(
    api_key=os.environ.get('DASHSCOPE_API_KEY'),
    # Voici la configuration de la région de Singapour (ap-southeast-1). Lors de l'appel, remplacez "{WorkspaceId}" par l'ID réel de votre workspace. La configuration varie selon la région.
    workspace='{WorkspaceId}',
    region='ap-southeast-1',
)

# Remplacez par l'ID de vocabulaire réel lors de la consultation
vocabulary = client.audio.vocabularies.get("vocab-testpfx-xxx")
print(f"Vocabulaire: {json.dumps(vocabulary.vocabulary, ensure_ascii=False)}")

Mettre à jour un vocabulaire personnalisé

import os
import dashscope

# L'API Key diffère entre les régions de Singapour et de Pékin. Obtenez une API Key : https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Si la variable d'environnement n'est pas configurée, remplacez la ligne suivante par votre API Key de Model Studio : api_key="sk-xxx"
client = dashscope.Client(
    api_key=os.environ.get('DASHSCOPE_API_KEY'),
    # Voici la configuration de la région de Singapour (ap-southeast-1). Lors de l'appel, remplacez "{WorkspaceId}" par l'ID réel de votre workspace. La configuration varie selon la région.
    workspace='{WorkspaceId}',
    region='ap-southeast-1',
)

my_vocabulary = [
    {"text": "Seediq Bale", "weight": 4, "lang": "en"}
]
# Remplacez par l'ID de vocabulaire réel
result = client.audio.vocabularies.update("vocab-testpfx-xxx", vocabulary=my_vocabulary)
print(f"État de la mise à jour: {result.status}")

Supprimer un vocabulaire personnalisé

import os
import dashscope

# L'API Key diffère entre les régions de Singapour et de Pékin. Obtenez une API Key : https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Si la variable d'environnement n'est pas configurée, remplacez la ligne suivante par votre API Key de Model Studio : api_key="sk-xxx"
client = dashscope.Client(
    api_key=os.environ.get('DASHSCOPE_API_KEY'),
    # Voici la configuration de la région de Singapour (ap-southeast-1). Lors de l'appel, remplacez "{WorkspaceId}" par l'ID réel de votre workspace. La configuration varie selon la région.
    workspace='{WorkspaceId}',
    region='ap-southeast-1',
)

# Remplacez par l'ID réel de la table de vocabulaire
result = client.audio.vocabularies.delete("vocab-testpfx-xxxx")
print(f"État de la suppression: {result.status}")