référence de l'API HTTP des vocabulaires personnalisés - Alibaba Cloud Model Studio

Gérez les vocabulaires personnalisés via les API HTTP : création, liste, consultation, mise à jour et suppression.

Guide utilisateur : Améliorer la précision de la reconnaissance.

ImportantLes 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

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

China (Beijing)

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

ImportantAlibaba Cloud Model Studio a publié des domaines spécifiques aux espaces de travail pour les régions China (Beijing) et Singapore. 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 :

China (Beijing) : de dashscope.aliyuncs.com vers {WorkspaceId}.cn-beijing.maas.aliyuncs.com
Singapore : de dashscope-intl.aliyuncs.com vers {WorkspaceId}.ap-southeast-1.maas.aliyuncs.com

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail. Les domaines existants restent pleinement fonctionnels.

En-têtes de requête

Paramètre	Type	Obligatoire	Description
Authorization	string	Oui	Jeton Bearer. Utilisez le format `Bearer <api_key>`, où `<api_key>` correspond à votre clé API.
Content-Type	string	Oui	Type de média du corps de la requête. Définissez-le sur `application/json`.

Créer un vocabulaire

Corps de la requête

L'URL suivante concerne la région Singapore. Remplacez WorkspaceId par votre véritable ID d'espace de travail. Les URL varient selon la région.

Les clés API diffèrent entre les régions Singapore et Beijing. Pour plus d'informations, consultez Obtenir une clé API.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "create_vocabulary",
        "target_model": "fun-asr",
        "prefix": "testpfx",
        "vocabulary": [
          {"text": "Seediq Bale", "weight": 4}
        ]
    }
}'

modelstring(Obligatoire)

Modèle de vocabulaire personnalisé. Définissez cette valeur sur speech-biasing.

inputobject(Obligatoire)

Paramètres d'entrée.

Propriétés

action string(Obligatoire)

Type d'opération. Définissez cette valeur sur create_vocabulary.

target_model string(Obligatoire)

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 string(Obligatoire)

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 array[object](Obligatoire)

Tableau des entrées de vocabulaire.

Propriétés

text string(Obligatoire)

Texte de l'entrée de vocabulaire.

La langue du texte doit être prise en charge par le modèle sélectionné. Les langues prises en charge 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 contenant des caractères non ASCII, ou 7 mots séparés par des espaces pour un texte exclusivement ASCII.

weight integer(Obligatoire)

Poids de l'entrée de vocabulaire. Valeur recommandée : 4.

Valeurs valides : de 1 à 5.

Si la précision de la reconnaissance ne s'améliore pas, augmentez le poids. Un poids excessivement élevé risque de réduire la précision de reconnaissance des autres mots.

lang string(Facultatif)

Code de langue de l'audio à reconnaître. Lorsque cette valeur est définie, 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étecte alors la langue automatiquement.

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

Corps de la réponse

{
    "output": {
        "vocabulary_id": "vocab-testpfx-5112c3de3705486baxxxxxxx"
    },
    "usage": {
        "count": 1
    },
    "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

request_idstring

Identifiant unique de cette requête.

outputobject

Données de la réponse.

Propriétés

vocabulary_idstring

ID du vocabulaire créé.

usageobject

Informations d'utilisation de cette requête.

Propriétés

count integer

Nombre de vocabulaires créés. Toujours égal à 1.

Lister les vocabulaires

Corps de la requête

L'URL suivante concerne la région Singapore. Remplacez WorkspaceId par votre véritable ID d'espace de travail. Les URL varient selon la région.

Les clés API diffèrent entre les régions Singapore et Beijing. Pour plus d'informations, consultez Obtenir une clé API.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "list_vocabulary",
        "prefix": "testpfx",
        "page_index": 0,
        "page_size": 10
    }
}'

modelstring(Obligatoire)

Modèle de vocabulaire personnalisé. Définissez cette valeur sur speech-biasing.

inputobject(Obligatoire)

Paramètres d'entrée.

Propriétés

action string(Obligatoire)

Type d'opération. Définissez cette valeur sur list_vocabulary.

prefix string(Facultatif)

Préfixe personnalisé du vocabulaire. Lorsqu'il est spécifié, seuls les vocabulaires portant ce préfixe sont retournés.

page_index integer

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

Valeur par défaut : 0.

page_size integer

Nombre d'entrées par page.

Valeur par défaut : 10.

Corps de la réponse

{
    "output": {
        "vocabulary_list": [
            {
                "gmt_create": "2026-03-02 18:07:38",
                "gmt_modified": "2026-03-02 18:07:38",
                "status": "OK",
                "vocabulary_id": "vocab-ciotest-8e74bef2accf4xxxxxxxx"
            },
            {
                "gmt_create": "2026-02-27 19:04:48",
                "gmt_modified": "2026-02-28 13:40:40",
                "status": "OK",
                "vocabulary_id": "vocab-sifasr-f483ad46e1844fxxxxxxxx"
            }
        ]
    },
    "usage": {
        "count": 1
    },
    "request_id": "81d51a05-8cdd-45c0-973f-xxxxxxxx"
}

request_idstring

Identifiant unique de cette requête.

outputobject

Données de la réponse.

Propriétés

vocabulary_listarray[object]

Vocabulaires interrogés.

Propriétés

vocabulary_idstring

ID du vocabulaire.

gmt_createstring

Date de création.

gmt_modifiedstring

Date de dernière modification.

statusstring

Statut :

OK : prêt.
UNDEPLOYED : non disponible.

usageobject

Informations d'utilisation de cette requête.

Propriétés

count integer

Toujours égal à 1.

Consulter un vocabulaire

Corps de la requête

L'URL suivante concerne la région Singapore. Remplacez WorkspaceId par votre véritable ID d'espace de travail. Les URL varient selon la région.

Les clés API diffèrent entre les régions Singapore et Beijing. Pour plus d'informations, consultez Obtenir une clé API.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "query_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxxx"
    }
}'

modelstring(Obligatoire)

Modèle de vocabulaire personnalisé. Définissez cette valeur sur speech-biasing.

inputobject(Obligatoire)

Paramètres d'entrée.

Propriétés

action string(Obligatoire)

Type d'opération. Définissez cette valeur sur query_vocabulary.

vocabulary_id string(Obligatoire)

ID du vocabulaire à consulter.

Corps de la réponse

{
  "output": {
    "gmt_create": "2025-12-19 11:47:11",
    "gmt_modified": "2025-12-19 11:47:11",
    "status": "OK",
    "target_model": "fun-asr",
    "vocabulary": [
      {
        "lang": "en",
        "text": "Seediq Bale",
        "weight": 4
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "request_id": "3d461d3f-b2c4-4de5-xxxx"
}

request_idstring

Identifiant unique de cette requête.

outputobject

Données de la réponse.

Propriétés

gmt_createstring

Date de création.

gmt_modifiedstring

Date de dernière modification.

statusstring

Statut :

OK : prêt.
UNDEPLOYED : non disponible.

target_model string

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.

vocabularyarray[object]

Vocabulaire interrogé.

Propriétés

text string

Texte de l'entrée de vocabulaire.

weight integer

Poids de l'entrée de vocabulaire.

lang string

Langue de l'audio à reconnaître.

usageobject

Informations d'utilisation de cette requête.

Propriétés

count integer

Toujours égal à 1.

Mettre à jour un vocabulaire

Corps de la requête

L'URL suivante concerne la région Singapore. Remplacez WorkspaceId par votre véritable ID d'espace de travail. Les URL varient selon la région.

Les clés API diffèrent entre les régions Singapore et Beijing. Pour plus d'informations, consultez Obtenir une clé API.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "update_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx",
        "vocabulary": [
          {"text": "Seediq Bale", "weight": 4, "lang": "en"}
        ]
    }
}'

modelstring(Obligatoire)

Modèle de vocabulaire personnalisé. Définissez cette valeur sur speech-biasing.

inputobject(Obligatoire)

Paramètres d'entrée.

Propriétés

action string(Obligatoire)

Type d'opération. Définissez cette valeur sur update_vocabulary.

vocabulary_id string(Obligatoire)

ID du vocabulaire à mettre à jour.

vocabulary array[object](Obligatoire)

Nouveau vocabulaire. Celui-ci remplace intégralement les entrées existantes.

Propriétés

text string(Obligatoire)

Texte de l'entrée de vocabulaire.

La langue du texte doit être prise en charge par le modèle sélectionné. Les langues prises en charge 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 contenant des caractères non ASCII, ou 7 mots séparés par des espaces pour un texte exclusivement ASCII.

weight integer(Obligatoire)

Poids de l'entrée de vocabulaire. Valeur recommandée : 4.

Valeurs valides : de 1 à 5.

Si la précision de la reconnaissance ne s'améliore pas, augmentez le poids. Un poids excessivement élevé risque de réduire la précision de reconnaissance des autres mots.

lang string(Facultatif)

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

Corps de la réponse

{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

request_idstring

Identifiant unique de cette requête.

outputobject

Données de la réponse. Toujours vide.

usageobject

Informations d'utilisation de cette requête.

Propriétés

count integer

Nombre de vocabulaires mis à jour. Toujours égal à 1.

Supprimer un vocabulaire

Corps de la requête

L'URL suivante concerne la région Singapore. Remplacez WorkspaceId par votre véritable ID d'espace de travail. Les URL varient selon la région.

Les clés API diffèrent entre les régions Singapore et Beijing. Pour plus d'informations, consultez Obtenir une clé API.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "delete_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx"
    }
}'

modelstring(Obligatoire)

Modèle de vocabulaire personnalisé. Définissez cette valeur sur speech-biasing.

inputobject(Obligatoire)

Paramètres d'entrée.

Propriétés

action string(Obligatoire)

Type d'opération. Définissez cette valeur sur delete_vocabulary.

vocabulary_id string(Obligatoire)

ID du vocabulaire à supprimer.

Corps de la réponse

{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

request_idstring

Identifiant unique de cette requête.

outputobject

Données de la réponse. Toujours vide.

usageobject

Informations d'utilisation de cette requête.

Propriétés

count integer

Nombre de vocabulaires supprimés. Toujours égal à 1.