Wykrywanie encji

Omówienie

Wykrywanie encji to funkcja, która pozwala wykrywać określone słowa i frazy w transkrypcji oraz podaje ich dokładne znaczniki czasu. Przydaje się do wykrywania numerów kart kredytowych, imion i nazwisk, schorzeń czy numerów SSN, które można następnie zredagować.

Po włączeniu model wykryje określone typy encji w transkrypcji i poda ich dokładne znaczniki czasu.

Na przykład poniższe audio:

Zwraca następującą transkrypcję, gdy jako typ encji podamy "pii" (dane umożliwiające identyfikację osoby):

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

Wynik pokazuje encje PII wykryte w transkrypcji wraz z ich dokładnymi znacznikami czasu.

Integracja wykrywania encji

Wykrywanie encji integruje się z API Speech to Text przez przekazanie parametru entity_detection do metody 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)

Typy encji

Do wykrywania obsługiwane są następujące typy encji. Możesz wykrywać całe grupy za pomocą słów kluczowych kategorii pii, phi, pci, other lub offensive_language albo wskazać konkretne typy encji za pomocą ich etykiet. Aby wykryć wszystkie typy encji, użyj kategorii all.

Redagowanie encji

Oprócz wykrywania encji możesz usuwać je z tekstu transkrypcji za pomocą parametru entity_redaction. Przyjmuje on ten sam format co entity_detection: all, słowo kluczowe kategorii lub listę konkretnych typów encji. Redagowane typy muszą być podzbiorem wykrywanych typów.

Gdy redagowanie jest włączone, dopasowany tekst encji zostaje zastąpiony znacznikiem zarówno w tekście transkrypcji, jak i w danych wyjściowych na poziomie słów, a pole entities nie jest zwracane w odpowiedzi.

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

Parametr entity_redaction_mode określa format znacznika:

Redagowanie encji działa też z Scribe v2 Realtime: przekaż entity_redaction i entity_redaction_mode jako parametry zapytania, w tym samym formacie co powyżej. Po każdej zatwierdzonej transkrypcji następuje wtedy zdarzenie redacted_transcript zawierające oryginalny text oraz redacted_text. Zobacz dokumentację zdarzeń w czasie rzeczywistym.

Kolejne kroki