Détection d’entités

Présentation

La détection d’entités est une fonctionnalité qui vous permet de détecter des mots et expressions spécifiques dans la transcription, en fournissant leurs horodatages exacts. Elle est utile pour détecter des numéros de carte bancaire, des noms, des pathologies ou des numéros de sécurité sociale, qui peuvent ensuite être masqués.

Lorsqu’elle est activée, le modèle détecte des types d’entités spécifiques dans la transcription et fournit leurs horodatages exacts.

Par exemple, l’audio suivant :

Produit la transcription suivante lorsque nous spécifions "pii" (informations personnelles identifiables) comme type d’entité :

{
  "language_code": "eng",
  "language_probability": 0.9869821071624756,
  "text": "My name is Jill. My date of birth is the 12th of July 1987, and my credit card number is 4242-4242-4242-4242.",
  "words": [
    { "text": "My", "start": 0.099, "end": 0.259, "type": "word", "logprob": 0.0 },
    { "text": " ", "start": 0.259, "end": 0.299, "type": "spacing", "logprob": 0.0 },
    { "text": "name", "start": 0.299, "end": 0.42, "type": "word", "logprob": 0.0 },
    ...
  ],
  "transcription_id": "Y2ZX8AxHUzTPCIualYiE",
  "entities": [
    {
      "text": "Jill",
      "entity_type": "name",
      "start_char": 11,
      "end_char": 15
    },
    {
      "text": "12th of July 1987",
      "entity_type": "dob",
      "start_char": 41,
      "end_char": 58
    },
    {
      "text": "4242-4242-4242-4242",
      "entity_type": "credit_card",
      "start_char": 89,
      "end_char": 108
    }
  ]
}

Le résultat affiche les entités PII détectées dans la transcription, avec leurs horodatages exacts.

Intégrer la détection d’entités

La détection d’entités s’intègre à l’API Speech to Text en transmettant le paramètre entity_detection à la méthode convert.

import os
from dotenv import load_dotenv
from io import BytesIO
import requests
from elevenlabs.client import ElevenLabs
load_dotenv()
elevenlabs = ElevenLabs(
    api_key=os.getenv("ELEVENLABS_API_KEY"),
)
audio_url = (
    "https://storage.googleapis.com/eleven-public-cdn/documentation_assets/audio/stt-entity-detection-pii.mp3"
)
response = requests.get(audio_url)
audio_data = BytesIO(response.content)
transcription = elevenlabs.speech_to_text.convert(
    file=audio_data,
    model_id="scribe_v2", # Model to use
    # Entity types to detect, accepts a list of specific entity types or categories.
    # To detect all entity types, use the "all" category.
    entity_detection=["pii"],
)
print("Entities detected:", transcription.entities)

Types d’entités

Les types d’entités suivants sont pris en charge pour la détection. Vous pouvez détecter des groupes entiers à l’aide des mots-clés de catégorie pii, phi, pci, other ou offensive_language, ou spécifier des types d’entités individuels à l’aide de leur libellé. Pour détecter tous les types d’entités, utilisez la catégorie all.

Masquage des entités

En plus de détecter les entités, vous pouvez les masquer dans le texte de la transcription avec le paramètre entity_redaction. Il accepte le même format que entity_detection : all, un mot-clé de catégorie ou une liste de types d’entités spécifiques. Les types masqués doivent constituer un sous-ensemble des types détectés.

Lorsque le masquage est activé, le texte des entités correspondantes est remplacé par un marqueur dans le texte de la transcription comme dans la sortie au niveau des mots, et le champ entities n’est pas renvoyé dans la réponse.

transcription = elevenlabs.speech_to_text.convert(
    file=audio_file,
    model_id="scribe_v2",
    entity_detection=["pii"],
    entity_redaction=["pii"],
    entity_redaction_mode="enumerated_entity_type",
)
print(transcription.text)
# "Hi {NAME_0}, your card ending in {CREDIT_CARD_0} was declined."

Le paramètre entity_redaction_mode contrôle le format du marqueur :

Étapes suivantes