> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Detecção de entidades

> **Note**
>
> **Guia prático** · Pressupõe que você concluiu o [guia de início rápido do Speech to Text ](/docs/pt/eleven-api/guides/cookbooks/speech-to-text).

## Visão geral

A detecção de entidades é um recurso que permite detectar palavras e frases específicas na transcrição, fornecendo seus timestamps exatos. Isso é útil para detectar números de cartão de crédito, nomes, condições médicas ou números de seguridade social, que podem então ser ocultados.

Quando ativado, o modelo detecta tipos específicos de entidade na transcrição e fornece seus timestamps exatos.

Por exemplo, o áudio a seguir:

<elevenlabs-audio-player audio-title="Exemplo de detecção de entidades" audio-src="https://storage.googleapis.com/eleven-public-cdn/documentation_assets/audio/stt-entity-detection-pii.mp3" />

Gera a seguinte transcrição quando especificamos `"pii"` (informações de identificação pessoal) como o tipo de entidade:

```json maxLines=0
{
  "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
    }
  ]
}
```

O resultado mostra as entidades de informações de identificação pessoal detectadas na transcrição, com seus timestamps exatos.

## Como integrar a detecção de entidades

A detecção de entidades é integrada à API de Speech to Text ao passar o parâmetro `entity_detection` para o método `convert`.

```python maxLines=0
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)
```

```typescript maxLines=0
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
import "dotenv/config";

const elevenlabs = new ElevenLabsClient({
  apiKey: process.env.ELEVENLABS_API_KEY,
});

const response = await fetch(
  "https://storage.googleapis.com/eleven-public-cdn/documentation_assets/audio/stt-entity-detection-pii.mp3"
);
const audioBlob = new Blob([await response.arrayBuffer()], { type: "audio/mp3" });

const transcription = await elevenlabs.speechToText.convert({
  file: audioBlob,
  modelId: "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.
  entityDetection: ["pii"],
});

console.log("Entities detected:", transcription.entities);
```

## Tipos de entidade

Os seguintes tipos de entidade são compatíveis com a detecção. Você pode detectar grupos inteiros usando as palavras-chave de categoria `pii`, `phi`, `pci`, `other` ou `offensive_language`, ou especificar tipos de entidade individuais pelo rótulo. Para detectar todos os tipos de entidade, use a categoria `all`.

#### PII (Informações de Identificação Pessoal)

| Rótulo                      | Descrição                                                                                                   | Conformidade regulatória                                       |
| --------------------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `account_number`            | Número de identificação da conta ou associação do cliente                                                   | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `age`                       | Números associados à idade de uma pessoa                                                                    | GDPR, HIPAA, Quebec Privacy Act, APPI                          |
| `bank_account`              | Números de contas bancárias e equivalentes internacionais, como IBAN                                        | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `cardinal`                  | Expressões numéricas na forma cardinal                                                                      |                                                                |
| `credit_card`               | Números de cartões de crédito                                                                               | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `credit_card_expiration`    | Data de vencimento de um cartão de crédito                                                                  | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `cvv`                       | Códigos de verificação de cartão de 3 ou 4 dígitos e equivalentes                                           | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `date`                      | Datas específicas do calendário, que podem incluir dias da semana, datas, meses ou anos                     | HIPAA, Quebec Privacy Act                                      |
| `date_interval`             | Períodos mais amplos, incluindo intervalos de datas, meses, estações, anos e décadas                        | HIPAA                                                          |
| `dob`                       | Datas de nascimento                                                                                         | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `driver_license`            | Números de carteira de motorista                                                                            | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `email_address`             | Endereços de e-mail                                                                                         | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `event`                     | Nomes de eventos ou feriados                                                                                |                                                                |
| `filename`                  | Nomes de arquivos de computador, incluindo a extensão ou o caminho do arquivo                               |                                                                |
| `gender`                    | Termos que indicam identidade de gênero, incluindo gírias                                                   | CPRA, GDPR, GDPR Sensitive, APPI Sensitive                     |
| `gender_sexuality`          | Alias legado que abrange `gender` e `sexual_orientation`                                                    | CPRA, GDPR, GDPR Sensitive, APPI Sensitive                     |
| `sexual_orientation`        | Termos que indicam orientação sexual, incluindo gírias                                                      | CPRA, GDPR, GDPR Sensitive, APPI Sensitive                     |
| `healthcare_number`         | Números de saúde e números de beneficiários de planos de saúde                                              | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `ip_address`                | Endereço IP da internet, incluindo formatos IPv4 e IPv6                                                     | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `location`                  | Metaclasse para qualquer referência de local nomeado                                                        | GDPR, HIPAA, APPI                                              |
| `location_address`          | Endereços físicos de correspondência completos ou parciais                                                  | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `location_city`             | Nomes de municípios, incluindo vilas, cidades pequenas e cidades                                            | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `location_coordinate`       | Posições geográficas referidas por coordenadas de latitude, longitude e/ou elevação                         | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `location_country`          | Nomes de países                                                                                             | GDPR, APPI                                                     |
| `location_state`            | Nomes de estados, províncias, territórios ou prefeituras                                                    | GDPR, APPI                                                     |
| `location_zip`              | CEPs (incluindo ZIP+4), códigos postais ou códigos de endereçamento                                         | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `money`                     | Nomes e/ou valores de moedas                                                                                |                                                                |
| `name`                      | Nomes de pessoas, sem incluir títulos pessoais como 'Sra.' ou 'Sr.'                                         | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `name_given`                | Nomes dados a uma pessoa, geralmente ao nascer; frequentemente nomes e nomes do meio em culturas ocidentais | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `name_family`               | Nomes que indicam a família ou comunidade de uma pessoa; frequentemente sobrenomes em culturas ocidentais   | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `name_medical_professional` | Nomes que incluem o título de um profissional de saúde, como "Doutor"                                       | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `numerical_pii`             | PII numérica que não se enquadra em outras categorias                                                       | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `occupation`                | Cargos ou profissões                                                                                        | Quebec Privacy Act, APPI                                       |
| `ordinal`                   | Expressões numéricas na forma ordinal                                                                       |                                                                |
| `origin`                    | Termos que indicam nacionalidade, etnia ou origem                                                           | CPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive |
| `passport_number`           | Números de passaporte emitidos por qualquer país                                                            | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `password`                  | Senhas de conta, PINs, chaves de acesso ou respostas de verificação                                         | CPRA, APPI                                                     |
| `percent`                   | Expressões numéricas em porcentagens                                                                        |                                                                |
| `phone_number`              | Números de telefone ou fax                                                                                  | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `physical_attribute`        | Atributos corporais distintivos, incluindo termos que indicam raça                                          | CPRA, GDPR, GDPR Sensitive, APPI Sensitive                     |
| `ssn`                       | Números da Previdência Social ou números equivalentes de identificação governamental internacionais         | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI                    |
| `time`                      | Expressões que indicam horários                                                                             |                                                                |
| `url`                       | Endereços da internet                                                                                       | CPRA, GDPR, HIPAA, Quebec Privacy Act                          |
| `username`                  | Nomes de usuário, nomes de login ou identificadores                                                         | CPRA, GDPR, APPI                                               |
| `vehicle_id`                | Números de identificação de veículos (VINs), números de série de veículos e números de placas               | CPRA, GDPR, HIPAA, APPI                                        |

#### PHI (Informações de Saúde Protegidas)

| Rótulo                 | Descrição                                                                  | Conformidade regulatória                              |
| ---------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------- |
| `condition`            | Nomes de condições médicas, doenças, síndromes, deficiências e transtornos | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive |
| `drug`                 | Medicamentos, vitaminas e suplementos                                      | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive |
| `injury`               | Lesões corporais, incluindo mutações, abortos espontâneos e luxações       | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive |
| `blood_type`           | Tipos sanguíneos                                                           | CPRA, GDPR, HIPAA, Quebec Privacy Act                 |
| `medical_process`      | Processos médicos, incluindo tratamentos, procedimentos e exames           | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive |
| `clinical_measurement` | Medições clínicas, sinais vitais e resultados de laboratório               | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI Sensitive |
| `statistics`           | Alias legado de `clinical_measurement`                                     | HIPAA, Quebec Privacy Act                             |

#### PCI (Setor de Cartões de Pagamento)

| Rótulo                   | Descrição                                                         | Conformidade regulatória                    |
| ------------------------ | ----------------------------------------------------------------- | ------------------------------------------- |
| `credit_card`            | Números de cartões de crédito                                     | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI |
| `credit_card_expiration` | Data de vencimento de um cartão de crédito                        | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI |
| `cvv`                    | Códigos de verificação de cartão de 3 ou 4 dígitos e equivalentes | CPRA, GDPR, HIPAA, Quebec Privacy Act, APPI |

#### Outras entidades

| Rótulo                  | Descrição                                                                 | Conformidade regulatória                                       |
| ----------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `language`              | Nomes de idiomas naturais                                                 | GDPR, GDPR Sensitive, APPI Sensitive                           |
| `marital_status`        | Termos que indicam estado civil                                           | APPI Sensitive                                                 |
| `organization`          | Nomes de organizações ou departamentos dentro de uma organização          | Quebec Privacy Act, APPI                                       |
| `political_affiliation` | Termos referentes a um partido político, movimento ou ideologia           | CPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive |
| `religion`              | Termos que indicam afiliação religiosa                                    | CPRA, GDPR, GDPR Sensitive, Quebec Privacy Act, APPI Sensitive |
| `routing_number`        | Número de roteamento associado a um banco ou instituição financeira       |                                                                |
| `zodiac_sign`           | Nomes de signos do zodíaco                                                |                                                                |
| `product_or_service`    | Nomes de produtos ou serviços comerciais                                  |                                                                |
| `food_or_beverage`      | Nomes de alimentos, bebidas e pratos                                      |                                                                |
| `document_reference`    | Referências a documentos, números de caso ou identificadores de arquivo   |                                                                |
| `generic_id`            | Identificadores genéricos que não se enquadram em outras categorias de ID |                                                                |
| `measurement`           | Medidas físicas e quantidades com unidades                                |                                                                |
| `time_duration`         | Expressões que indicam uma duração ou intervalo de tempo                  |                                                                |

#### Linguagem ofensiva

| Rótulo                    | Descrição                                        | Conformidade regulatória |
| ------------------------- | ------------------------------------------------ | ------------------------ |
| `very_offensive_language` | Linguagem altamente ofensiva, incluindo insultos |                          |
| `less_offensive_language` | Linguagem levemente ofensiva ou inadequada       |                          |

## Redação de entidades

Além de detectar entidades, você pode ocultá-las do texto da transcrição com o
parâmetro `entity_redaction`. Ele aceita o mesmo formato que `entity_detection`: `all`, uma
palavra-chave de categoria ou uma lista de tipos específicos de entidade. Os tipos ocultados devem ser um subconjunto dos
tipos detectados.

Quando a redação está ativada, o texto da entidade correspondente é substituído por um marcador tanto no
texto da transcrição quanto na saída por palavra, e o campo `entities` não é retornado na
resposta.

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

```typescript
const transcription = await elevenlabs.speechToText.convert({
  file: audioBlob,
  modelId: "scribe_v2",
  entityDetection: ["pii"],
  entityRedaction: ["pii"],
  entityRedactionMode: "enumerated_entity_type",
});

console.log(transcription.text);
// "Hi {NAME_0}, your card ending in {CREDIT_CARD_0} was declined."
```

O parâmetro `entity_redaction_mode` controla o formato do marcador:

| Modo                     | Marcador                                           | Exemplo                 |
| ------------------------ | -------------------------------------------------- | ----------------------- |
| `redacted`               | `{REDACTED}` para cada entidade                    | `Olá {REDACTED}`        |
| `entity_type`            | O tipo de entidade entre chaves                    | `Olá {NAME}`            |
| `enumerated_entity_type` | O tipo de entidade mais um contador de ocorrências | `Olá {NAME_0}` (padrão) |

> **Warning**
>
> A detecção e a redação de entidades não são compatíveis com o estilo de saída multicanal `combined`.

## Próximas etapas

#### [Referência da API](/docs/pt/api-reference/speech-to-text)

Referência completa e parâmetros da API de Speech to Text.

#### [Transcrição multicanal](/docs/pt/eleven-api/guides/how-to/speech-to-text/batch/multichannel-transcription)

Transcreva áudio multicanal com atribuição de locutor por canal.