aethexDocs

Référence API

Dictionnaires de prononciation

Indiquez à vos agents comment dire les mots qu'ils prononcent mal : marques, lieux, noms. Un dictionnaire liste des mots (grapheme) avec une réécriture que la voix lit à leur place (phoneme), par exemple Cocody lu Ko-ko-di. La transcription et l'historique de la conversation gardent le mot tel qu'il est écrit.Espace de travail ou agent. Un dictionnaire appartient à tout l'espace de travail (sans agent_id) ou à un seul agent. Pour un même mot, l'entrée de l'agent l'emporte sur celle de l'espace de travail. Un dictionnaire s'applique aux agents dont la langue est de la même famille que sa language ; le dictionnaire propre à un agent doit être dans la langue de cet agent.Un dictionnaire par langue. L'espace de travail, et chaque agent, ont un dictionnaire par famille de langues, de 1 000 entrées au maximum. Pour le modifier, remplacez ses entrées.Correspondance. Mots entiers uniquement, sans tenir compte de la casse, accents compris. Une entrée tout en majuscules comme MTN ne correspond qu'en majuscules (ainsi UN laisse « un » tranquille) et correspond aussi à ses lettres espacées, M T N. Les apostrophes droite et courbe sont équivalentes. Les mots d'une entrée de plusieurs mots peuvent être séparés par n'importe quel espace. Quand deux entrées se chevauchent, la plus longue l'emporte.Réécritures uniquement. L'alphabet phonétique international (IPA) n'est pas pris en charge : la voix lit du texte brut. Une réécriture doit être faite de mots simples que la voix lit tels quels : pas de chiffres, pas de balises, rien que le nettoyage de la parole modifierait. Une réécriture sonne différemment d'une voix à l'autre : écoutez-la sur la voix de l'agent.Quand elle s'applique. Dès le prochain appel de l'agent, et pour ses notes vocales WhatsApp. Un appel déjà en cours garde les entrées avec lesquelles il a commencé.

URL de base
https://api.aethexai.com/api/v1
Endpoints
5
Portées
pronunciation:readpronunciation:write
POST/pronunciation-dictionaries

Créer un dictionnaire pour l'espace de travail ou pour un agent, avec ses entrées.

Créer un dictionnaire

Crée un dictionnaire et ses entrées en une requête, et le renvoie avec ses entrées. Omettez agent_id pour un dictionnaire de l'espace de travail. Rien n'est créé si une entrée est refusée.

Corps de la requête

7
  • namestringrequis

    Nom du dictionnaire, 255 caractères au maximum.

  • descriptionstringoptionnel

    Description libre facultative.

  • languagestringrequis

    Langue du dictionnaire, l'une des valeurs acceptées par le champ language d'un agent (par exemple english ou french). Le dictionnaire s'applique aux agents dont la langue est de la même famille.

  • agent_idstringoptionnel

    ID de l'agent auquel appartient le dictionnaire. Omettez-le pour un dictionnaire qui s'applique à tous les agents de l'espace de travail. La langue de l'agent doit être de la même famille que language.

  • entriesobject[]optionnel

    Les mots et leurs réécritures, 1 000 au maximum. Aucun par défaut.

  • entries[].graphemestringrequis

    Le mot tel qu'il est écrit, 100 caractères au maximum, par exemple Cocody. Plusieurs mots sont possibles (Côte d'Ivoire). Chaque mot ne peut figurer qu'une fois, sans tenir compte de la casse ni du style d'apostrophe.

  • entries[].phonemestringrequis

    Comment la voix doit le lire, 200 caractères au maximum, par exemple Ko-ko-di. Des mots simples uniquement : pas de chiffres, pas de balises, rien que le nettoyage de la parole modifierait.

Erreurs

4
403Langue non disponible

Le language du dictionnaire est une langue locale africaine ou l'arabe : elles font partie de la plateforme entreprise d'Aethex.

Utilisez english ou french dans sa forme standard, ou passez à la plateforme entreprise d'Aethex.

404Introuvable

Aucun agent de votre espace de travail n'a cet agent_id.

Vérifiez l'ID avec GET /agents, ou omettez agent_id pour un dictionnaire de l'espace de travail.

409Dictionnaire déjà existant

L'espace de travail (sans agent_id), ou cet agent, a déjà un dictionnaire dans cette famille de langues.

Remplacez plutôt les entrées du dictionnaire existant (PUT sur son /entries) ; l'erreur donne son id.

422Entité non traitable

language n'est pas une langue d'agent ; l'agent parle une langue d'une autre famille ; une entrée est vide, trop longue, contient une balise ou un caractère de contrôle, ou sa réécriture contient un chiffre ou serait modifiée par le nettoyage de la parole ; un mot figure deux fois.

La réponse indique le mot et la raison. Corrigez-le et renvoyez la requête.

GET/pronunciation-dictionaries

Lister les dictionnaires de l'espace de travail, avec leur nombre d'entrées.

Lister les dictionnaires

Renvoie tous les dictionnaires de l'espace de travail, communs et propres à un agent, du plus ancien au plus récent, chacun avec entry_count. Les entrées elles-mêmes ne sont pas incluses : lisez-les avec GET /pronunciation-dictionaries/:id.

GET/pronunciation-dictionaries/:id

Obtenir un dictionnaire avec ses entrées.

Obtenir un dictionnaire

Renvoie le dictionnaire avec toutes ses entrées, triées par mot (sans tenir compte de la casse).

Chemin & Requête

1
  • idstringrequis

    ID du dictionnaire.

Erreurs

1
404Introuvable

Aucun dictionnaire de votre espace de travail n'a cet ID.

Vérifiez l'ID avec GET /pronunciation-dictionaries.

PUT/pronunciation-dictionaries/:id/entries

Remplacer toutes les entrées d'un dictionnaire, depuis du JSON ou un fichier CSV.

Remplacer les entrées

Remplace toutes les entrées du dictionnaire par celles envoyées, et renvoie le dictionnaire avec ses nouvelles entrées. Envoyez une liste vide pour le vider. Rien ne change si une entrée est refusée.JSON. Content-Type: application/json, avec les entrées dans entries.CSV. Content-Type: text/csv, en UTF-8, une première ligne grapheme,phoneme, puis une entrée par ligne ; les lignes vides sont ignorées. Par exemple grapheme,phoneme puis Cocody,Ko-ko-di.Le corps peut faire jusqu'à 1 Mo (1 000 000 octets).

Chemin & Requête

1
  • idstringrequis

    ID du dictionnaire.

Corps de la requête

3
  • entriesobject[]requis

    Les nouvelles entrées (corps JSON), 1 000 au maximum. Elles remplacent toutes les entrées du dictionnaire.

  • entries[].graphemestringrequis

    Le mot tel qu'il est écrit, 100 caractères au maximum, par exemple Cocody. Plusieurs mots sont possibles (Côte d'Ivoire). Chaque mot ne peut figurer qu'une fois, sans tenir compte de la casse ni du style d'apostrophe.

  • entries[].phonemestringrequis

    Comment la voix doit le lire, 200 caractères au maximum, par exemple Ko-ko-di. Des mots simples uniquement : pas de chiffres, pas de balises, rien que le nettoyage de la parole modifierait.

Erreurs

3
403Langue non disponible

Le language du dictionnaire est une langue locale africaine ou l'arabe : elles font partie de la plateforme entreprise d'Aethex.

Utilisez english ou french dans sa forme standard, ou passez à la plateforme entreprise d'Aethex.

404Introuvable

Aucun dictionnaire de votre espace de travail n'a cet ID.

Vérifiez l'ID avec GET /pronunciation-dictionaries.

422Entité non traitable

Une entrée est refusée (vide, trop longue, balise ou caractère de contrôle, chiffre dans la réécriture, réécriture que le nettoyage de la parole modifierait, mot donné deux fois), le Content-Type n'est ni application/json ni text/csv, le corps dépasse 1 Mo, ou le CSV n'est pas en UTF-8, n'a pas l'en-tête grapheme,phoneme ou a une ligne qui n'a pas exactement deux colonnes. Un dictionnaire dont la langue n'est plus une langue d'agent ne peut pas être modifié.

La réponse indique le mot, ou la ligne du CSV, et la raison. Corrigez-le et renvoyez la requête. Pour un dictionnaire dans une langue qui n'est plus une langue d'agent, créez un nouveau dictionnaire et supprimez l'ancien.

DELETE/pronunciation-dictionaries/:id

Supprimer un dictionnaire et ses entrées.

Supprimer un dictionnaire

Supprime le dictionnaire et toutes ses entrées. Les appels qui commencent ensuite ne les utilisent plus.

Chemin & Requête

1
  • idstringrequis

    ID du dictionnaire.

Erreurs

1
404Introuvable

Aucun dictionnaire de votre espace de travail n'a cet ID.

Vérifiez l'ID avec GET /pronunciation-dictionaries.