Hoppa till navigering

Entitetsidentifiering

Den här guiden visar hur du använder entitetsidentifiering med Speech to Text API.

Guide · Förutsätter att du har slutfört snabbstartsguiden för Speech to Text .

Översikt

Entitetsidentifiering är en funktion som låter dig identifiera specifika ord och fraser i transkriptionen och ange deras exakta tidsstämplar. Den är användbar för att identifiera kreditkortsnummer, namn, medicinska tillstånd eller personnummer som sedan kan maskeras.

När funktionen är aktiverad identifierar modellen specifika entitetstyper i transkriptionen och anger deras exakta tidsstämplar.

Till exempel ger följande ljud:

Följande transkription när vi anger "pii" (personligt identifierbar information) som entitetstyp:

{
"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
}
]
}

Resultatet visar de PII-entiteter som identifierats i transkriptionen, med deras exakta tidsstämplar.

Integrera entitetsidentifiering

Entitetsidentifiering integreras i Speech to Text API genom att skicka parametern entity_detection till metoden 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)

Entitetstyper

Följande entitetstyper stöds för identifiering. Du kan identifiera hela grupper med kategorinyckelorden pii, phi, pci, other eller offensive_language, eller ange enskilda entitetstyper med deras etikett. Använd kategorin all för att identifiera alla entitetstyper.

EtikettBeskrivningRegelefterlevnad
account_numberKundkontonummer eller medlemsidentifieringsnummerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
ageSiffror kopplade till en persons ålderGDPR, HIPAA, Quebec Privacy Act, APPI
bank_accountBankkontonummer och internationella motsvarigheter, till exempel IBANCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
cardinalNumeriska uttryck i grundtal
credit_cardKreditkortsnummerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
credit_card_expirationUtgångsdatum för ett kreditkortCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
cvvTresiffriga eller fyrsiffriga kortverifieringskoder och motsvarigheterCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
dateSpecifika kalenderdatum, som kan inkludera veckodagar, datum, månader eller årHIPAA, Quebec Privacy Act
date_intervalBredare tidsperioder, inklusive datumintervall, månader, årstider, år och decennierHIPAA
dobFödelsedatumCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
driver_licenseKörkortsnummerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
email_addressE-postadresserCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
eventNamn på evenemang eller högtider
filenameNamn på datorfiler, inklusive filändelse eller filsökväg
genderTermer som anger könsidentitet, inklusive slanguttryckCPRA, GDPR, GDPR Sensitive, APPI Sensitive
gender_sexualityÄldre alias som omfattar både gender och sexual_orientationCPRA, GDPR, GDPR Sensitive, APPI Sensitive
sexual_orientationTermer som anger sexuell läggning, inklusive slanguttryckCPRA, GDPR, GDPR Sensitive, APPI Sensitive
healthcare_numberSjukvårdsnummer och nummer för mottagare av sjukförsäkringCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
ip_addressIP-adresser på internet, inklusive IPv4- och IPv6-formatCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
locationMetaklass för alla namngivna platsreferenserGDPR, HIPAA, APPI
location_addressFullständiga eller partiella fysiska postadresserCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
location_cityNamn på kommuner, inklusive byar, orter och städerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
location_coordinateGeografiska positioner angivna med latitud-, longitud- och/eller höjdkoordinaterCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
location_countryLandsnamnGDPR, APPI
location_stateNamn på delstater, provinser, territorier eller prefekturerGDPR, APPI
location_zipPostnummer, inklusive ZIP+4CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
moneyNamn på och/eller belopp i valutor
nameNamn på personer, utan personliga titlar som ”fru” eller ”herr”CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
name_givenNamn som ges till en person, vanligtvis vid födseln; ofta för- eller mellannamn i västerländska kulturerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
name_familyNamn som anger en persons familj eller gemenskap; ofta efternamn i västerländska kulturerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
name_medical_professionalNamn inklusive titeln på en medicinsk yrkesperson, till exempel “läkare”CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
numerical_piiNumerisk PII som inte hör till andra kategorierCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
occupationJobbtitlar eller yrkenQuebec Privacy Act, APPI
ordinalNumeriska uttryck i ordningstal
originTermer som anger nationalitet, etnicitet eller ursprungCPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive
passport_numberPassnummer utfärdade av valfritt landCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
passwordKontolösenord, PIN-koder, åtkomstnycklar eller verifieringssvarCPRA, APPI
percentNumeriska uttryck som procenttal
phone_numberTelefon- eller faxnummerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
physical_attributeUtmärkande kroppsliga egenskaper, inklusive termer som anger rasCPRA, GDPR, GDPR Sensitive, APPI Sensitive
ssnPersonnummer eller internationella motsvarande myndighetsutfärdade identifieringsnummerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
timeUttryck som anger klockslag
urlInternetadresserCPRA, GDPR, HIPAA, Quebec Privacy Act
usernameAnvändarnamn, inloggningsnamn eller kontonamnCPRA, GDPR, APPI
vehicle_idFordonsidentifieringsnummer (VIN), fordonsserienummer och registreringsnummerCPRA, GDPR, HIPAA, APPI
EtikettBeskrivningRegelefterlevnad
conditionNamn på medicinska tillstånd, sjukdomar, syndrom, funktionsnedsättningar och störningarCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
drugLäkemedel, vitaminer och kosttillskottCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
injuryKroppsskador, inklusive mutationer, missfall och urledvridningarCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
blood_typeBlodgrupperCPRA, GDPR, HIPAA, Quebec Privacy Act
medical_processMedicinska processer, inklusive behandlingar, procedurer och testerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
clinical_measurementKliniska mätvärden, vitalparametrar och laboratoriesvarCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive
statisticsÄldre alias för clinical_measurementHIPAA, Quebec Privacy Act
EtikettBeskrivningRegelefterlevnad
credit_cardKreditkortsnummerCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
credit_card_expirationUtgångsdatum för ett kreditkortCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
cvvTresiffriga eller fyrsiffriga kortverifieringskoder och motsvarigheterCPRA, GDPR, HIPAA, Quebec Privacy Act, APPI
EtikettBeskrivningRegelefterlevnad
languageNamn på naturliga språkGDPR, GDPR Sensitive, APPI Sensitive
marital_statusTermer som anger civilståndAPPI Sensitive
organizationNamn på organisationer eller avdelningar inom en organisationQuebec Privacy Act, APPI
political_affiliationTermer som syftar på ett politiskt parti, en rörelse eller ideologiCPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive
religionTermer som anger religiös tillhörighetCPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive
routing_numberClearingnummer kopplat till en bank eller finansinstitution
zodiac_signNamn på stjärntecken
product_or_serviceNamn på kommersiella produkter eller tjänster
food_or_beverageNamn på mat, drycker och rätter
document_referenceReferenser till dokument, ärendenummer eller filidentifierare
generic_idGeneriska identifierare som inte hör till andra ID-kategorier
measurementFysiska mått och kvantiteter med enheter
time_durationUttryck som anger en tidslängd eller tidsperiod
EtikettBeskrivningRegelefterlevnad
very_offensive_languageMycket stötande språk, inklusive nedsättande uttryck
less_offensive_languageLätt stötande eller olämpligt språk

Maskering av entiteter

Utöver att identifiera entiteter kan du maskera dem i transkriptionstexten med parametern entity_redaction. Den använder samma format som entity_detection: all, ett kategorinyckelord eller en lista med specifika entitetstyper. De maskerade typerna måste vara en delmängd av de identifierade typerna.

När maskering är aktiverad ersätts matchande entitetstext med en markör både i transkriptionstexten och i utdata på ordnivå, och fältet entities returneras inte i svaret.

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

Parametern entity_redaction_mode styr markörformatet:

LägeMarkörExempel
redacted{REDACTED} för varje entitetHi {REDACTED}
entity_typeEntitetstypen inom klammerparenteserHi {NAME}
enumerated_entity_typeEntitetstypen plus en förekomsträknareHi {NAME_0} (standard)

Identifiering och maskering av entiteter stöds inte med utdatastilen combined för flera kanaler.

Nästa steg