Vai alla navigazione

Rilevamento delle entità

Questa guida mostra come usare il rilevamento delle entità con l’API Speech to Text.

Guida pratica · Presuppone che tu abbia completato il quickstart di Speech to Text .

Panoramica

Il rilevamento delle entità è una funzionalità che ti consente di identificare parole e frasi specifiche nella trascrizione, fornendo i relativi 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 specifici tipi di entità nella trascrizione e ne fornisce i timestamp esatti.

Ad esempio, il seguente audio:

Produce la seguente trascrizione quando specifichiamo "pii" (informazioni di identificazione personale) 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à si integra 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_v3", # 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.

EtichettaDescrizioneConformità normativa
account_numberNumero di identificazione dell’account o dell’iscrizione del clienteCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
ageNumeri associati all’età di una personaGDPR, HIPAA, Quebec Privacy Act, APPI
bank_accountNumeri di conto bancario ed equivalenti internazionali, come l’IBANCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
cardinalEspressioni numeriche in forma cardinale
credit_cardNumeri di carte di creditoCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
credit_card_expirationData di scadenza di una carta di creditoCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
cvvCodici di verifica della carta di 3 o 4 cifre ed equivalentiCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
dateDate di calendario specifiche, che possono includere giorni della settimana, date, mesi o anniHIPAA, Quebec Privacy Act
date_intervalPeriodi di tempo più ampi, inclusi intervalli di date, mesi, stagioni, anni e decenniHIPAA
dobDate di nascitaCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
driver_licenseNumeri di patente di guidaCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
email_addressIndirizzi emailCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
eventNomi di eventi o festività
filenameNomi di file informatici, inclusi estensione o filepath
genderTermini che indicano l’identità di genere, compresi termini gergaliCPRA, GDPR, GDPR Sensitive, APPI Sensitive
gender_sexualityAlias legacy che comprende sia gender sia sexual_orientationCPRA, GDPR, GDPR Sensitive, APPI Sensitive
sexual_orientationTermini che indicano l’orientamento sessuale, compresi termini gergaliCPRA, GDPR, GDPR Sensitive, APPI Sensitive
healthcare_numberNumeri sanitari e numeri dei beneficiari di piani sanitariCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
ip_addressIndirizzo IP Internet, inclusi i formati IPv4 e IPv6CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
locationMetaclasse per qualsiasi riferimento a una località denominataGDPR, HIPAA, APPI
location_addressIndirizzi postali fisici completi o parzialiCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
location_cityNomi di comuni, inclusi villaggi, paesi e cittàCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
location_coordinatePosizioni geografiche indicate tramite coordinate di latitudine, longitudine e/o altitudineCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
location_countryNomi di PaesiGDPR, APPI
location_stateNomi di Stati, province, territori o prefettureGDPR, APPI
location_zipCodici ZIP (incluso ZIP+4), codici postali o CAPCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
moneyNomi e/o importi di valute
nameNomi di persone, esclusi titoli personali come “Signora” o “Signor”CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
name_givenNomi assegnati a una persona, solitamente alla nascita; spesso nome e secondo nome nelle culture occidentaliCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
name_familyNomi che indicano la famiglia o la comunità di una persona; spesso il cognome nelle culture occidentaliCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
name_medical_professionalNomi che includono il titolo di un professionista sanitario, come “Dottore”CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
numerical_piiPII numeriche non comprese in altre categorieCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
occupationTitoli professionali o professioniQuebec Privacy Act, APPI
ordinalEspressioni numeriche in forma ordinale
originTermini che indicano nazionalità, etnia o provenienzaCPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive
passport_numberNumeri di passaporto emessi da qualsiasi PaeseCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
passwordPassword dell’account, PIN, chiavi di accesso o risposte di verificaCPRA, APPI
percentEspressioni numeriche in percentuale
phone_numberNumeri di telefono o faxCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
physical_attributeAttributi fisici distintivi, inclusi termini che indicano la razzaCPRA, GDPR, GDPR Sensitive, APPI Sensitive
ssnNumeri di previdenza sociale o numeri identificativi governativi equivalenti internazionaliCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
timeEspressioni che indicano orari
urlIndirizzi InternetCPRA, GDPR, HIPAA, Quebec Privacy Act
usernameNomi utente, nomi di login o handleCPRA, GDPR, APPI
vehicle_idNumeri di identificazione del veicolo (VIN), numeri di serie del veicolo e numeri di targaCPRA, GDPR, HIPAA, APPI
EtichettaDescrizioneConformità normativa
conditionNomi di condizioni mediche, malattie, sindromi, deficit e disturbiCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
drugFarmaci, vitamine e integratoriCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
injuryLesioni fisiche, incluse mutazioni, aborti spontanei e lussazioniCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
blood_typeGruppi sanguigniCPRA, GDPR, HIPAA, Quebec Privacy Act
medical_processProcessi medici, inclusi trattamenti, procedure ed esamiCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
clinical_measurementMisurazioni cliniche, parametri vitali e risultati di laboratorioCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
statisticsAlias legacy per clinical_measurementHIPAA, Quebec Privacy Act
EtichettaDescrizioneConformità normativa
credit_cardNumeri di carte di creditoCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
credit_card_expirationData di scadenza di una carta di creditoCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
cvvCodici di verifica della carta di 3 o 4 cifre ed equivalentiCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
EtichettaDescrizioneConformità normativa
languageNomi di lingue naturaliGDPR, GDPR Sensitive, APPI Sensitive
marital_statusTermini che indicano lo stato civileAPPI Sensitive
organizationNomi di organizzazioni o reparti all’interno di un’organizzazioneQuebec Privacy Act, APPI
political_affiliationTermini che si riferiscono a un partito, movimento o ideologia politicaCPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive
religionTermini che indicano l’affiliazione religiosaCPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive
routing_numberNumero di routing associato a una banca o a un istituto finanziario
zodiac_signNomi dei segni zodiacali
product_or_serviceNomi di prodotti o servizi commerciali
food_or_beverageNomi di alimenti, bevande e piatti
document_referenceRiferimenti a documenti, numeri di pratica o identificatori di file
generic_idIdentificatori generici non compresi in altre categorie di ID
measurementMisure fisiche e quantità con unità
time_durationEspressioni che indicano una durata o un intervallo di tempo
EtichettaDescrizioneConformità normativa
very_offensive_languageLinguaggio fortemente offensivo, inclusi insulti
less_offensive_languageLinguaggio lievemente offensivo o inappropriato

Redazione delle entità

Oltre a rilevare le entità, puoi rimuoverle dal 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 rimossi devono essere un sottoinsieme dei tipi rilevati.

Quando la redazione è attivata, 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_v3",
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:

ModalitàMarcatoreEsempio
redacted{REDACTED} per ogni entitàHi {REDACTED}
entity_typeIl tipo di entità tra parentesi graffeHi {NAME}
enumerated_entity_typeIl tipo di entità più un contatore di occorrenzeHi {NAME_0} (predefinito)

Il rilevamento e la redazione delle entità non sono supportati con lo stile di output multicanale combined.

La redazione delle entità funziona anche con Scribe v2 Realtime: passa entity_redaction e entity_redaction_mode come parametri di query, nello stesso formato indicato sopra. A ogni trascrizione confermata segue quindi un evento redacted_transcript che contiene il text originale e il redacted_text. Consulta il riferimento degli eventi in tempo reale.

Passaggi successivi