# Detecte informações com entidades

Entidades são pedaços de informação que podem ser extraídos de algo que o usuário diz.

Quando uma entidade é detectada, ela é salva como um [variável](https://docs.chatlayer.ai/chatlayer-documentation-pt-br/navegacao/settings/secure-variables-gdpr), o que significa que você pode reutilizar essa informação mais tarde.

Acesse suas entidades em [**Entidades**](https://docs.chatlayer.ai/chatlayer-documentation-pt-br/navegacao/natural-language-processing-nlp/synonym-entities) aba.

<figure><img src="https://181262846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FmScejyLUyMvIOhXRHC9A%2FScreenshot%202024-08-23%20at%2011.31.51.png?alt=media&#x26;token=9f0d155f-ae79-4dec-8b1c-beb7cefc0393" alt=""><figcaption><p>Detecte informações a partir do que o usuário diz usando entidades.</p></figcaption></figure>

{% hint style="info" %}
Nos campos de texto do Chatlayer, entidades são indicadas com um`@`sinal na frente delas.
{% endhint %}

{% hint style="warning" %}
Todas as entidades só são detectadas depois que você [treinou seu NLP ](https://docs.chatlayer.ai/chatlayer-documentation-pt-br/nlp/natural-language-processing-nlp/train-your-nlp)pelo menos uma vez. Sempre que você alterar, adicionar ou excluir uma entidade, deve treinar o NLP novamente.
{% endhint %}

## Tipos de entidade

O Chatlayer oferece 4 tipos de entidades;

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Entidades de correspondência</strong></td><td><p>Se o usuário disser algo que faça parte de uma lista predefinida ou corresponda a um determinado padrão, isso será detectado como uma entidade de correspondência.</p><p><br>Ex.: <em>Quero saber mais sobre o pacote Premium</em> → <code>@product</code>: Premium<br></p></td><td></td><td><a href="detect-information-with-entities/match-entities">match-entities</a></td></tr><tr><td><strong>Entidades contextuais</strong></td><td><p>Treine seu NLP para que ele possa reconhecer entidades que dependem do contexto de uma expressão.</p><p><br>Ex.: <em>Reservar uma passagem de trem de Bruxelas para Amsterdã</em> → <code>@origin</code>: Bruxelas, <code>@destination</code>: Amsterdã</p></td><td></td><td><a href="detect-information-with-entities/contextual-entities">contextual-entities</a></td></tr><tr><td><strong>Entidades compostas</strong></td><td><p>Uma combinação de entidades diferentes, mas relacionadas.</p><p><br>Ex.: <em>Duas batatas fritas, por favor</em> → <code>@order</code> consiste em <code>@sys.number</code> (2) e <code>@foodItem</code> (batatas fritas)</p></td><td></td><td><a href="detect-information-with-entities/composite-entities">composite-entities</a></td></tr><tr><td><strong>Entidades do sistema</strong></td><td><p>Entidades que são pré-construídas no Chatlayer e que correspondem a um determinado padrão amplamente usado, como e-mail ou número de telefone.</p><p><br><em>Ex.: Meu endereço de e-mail é ilovebots@chatlayer.ai</em> → <code>@sys.email</code>: ilovebots@chatlayer.ai</p></td><td></td><td><a href="detect-information-with-entities/system-entities">system-entities</a></td></tr></tbody></table>

## Como escolher uma entidade

<figure><img src="https://181262846-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FE6H3Hv8YA5UKc7OeWJXO%2FScreenshot%202024-08-23%20at%2011.16.48.png?alt=media&#x26;token=2cce5708-391a-4402-abfb-1dc076912417" alt=""><figcaption><p>Árvore de decisão sobre quando usar quais entidades.</p></figcaption></figure>

{% hint style="warning" %}
**Entidades só devem ser usadas se o seu valor for necessário em conversas do bot**. Por exemplo, se seu bot ajuda usuários a encontrar informações sobre um produto específico, você deve usar entidades para obter o nome do produto para consultas ao banco de dados. No entanto, se seu bot apenas redireciona usuários para uma página da web com todos os produtos, entidades são desnecessárias.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.chatlayer.ai/chatlayer-documentation-pt-br/nlp/natural-language-processing-nlp/detect-information-with-entities.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.