Rilevamento delle entità

Panoramica

Il rilevamento delle entità è una funzionalità che consente di rilevare parole e frasi specifiche nella trascrizione, fornendone i timestamp esatti. È utile per rilevare numeri di carte di credito, nomi, condizioni mediche o numeri di previdenza sociale, che possono poi essere oscurati.

Quando è abilitata, il modello rileva tipi di entità specifici nella trascrizione e ne fornisce i timestamp esatti.

Ad esempio, il seguente audio:

Genera la seguente trascrizione quando specifichiamo "pii" (informazioni personali identificabili) come tipo di 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
    }
  ]
}

Il risultato mostra le entità PII rilevate nella trascrizione, con i relativi timestamp esatti.

Integrare il rilevamento delle entità

Il rilevamento delle entità viene integrato nell’API Speech to Text passando il parametro entity_detection al metodo 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)

Tipi di entità

Sono supportati i seguenti tipi di entità per il rilevamento. Puoi rilevare interi gruppi usando le parole chiave di categoria pii, phi, pci, other o offensive_language, oppure specificare singoli tipi di entità tramite la relativa etichetta. Per rilevare tutti i tipi di entità, usa la categoria all.

Oscuramento delle entità

Oltre a rilevare le entità, puoi oscurarle nel testo della trascrizione con il parametro entity_redaction. Accetta lo stesso formato di entity_detection: all, una parola chiave di categoria o un elenco di tipi di entità specifici. I tipi da oscurare devono essere un sottoinsieme di quelli rilevati.

Quando l’oscuramento è abilitato, il testo dell’entità corrispondente viene sostituito con un marcatore sia nel testo della trascrizione sia nell’output a livello di parola, e il campo entities non viene restituito nella risposta.

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."

Il parametro entity_redaction_mode controlla il formato del marcatore:

Passaggi successivi