# Features

> Estas são as funções mais importantes que você deve aprender ao criar fluxos ou interações dinâmicas com o bot
>
> - **Canonical URL:** https://www.builderbot.app/pt/add-functions
> - **Documentation Index:** https://www.builderbot.app/llms.txt
> - **Full Corpus:** https://www.builderbot.app/llms-full.txt

Estas são as funções mais importantes que você deve aprender ao criar fluxos ou interações dinâmicas com o bot

## Add keyword

__`addKeyword`__  é o ponto de partida de um fluxo de conversa, só precisa passar um __array of keywords__,
quando alguém escreve essas palavras-chave no chatbot, a função aciona a caixa de diálogo predefinida que você configurou.

No exemplo a seguir é estabelecido um fluxo de conversação que recebeu as palavras-chave 'hello ' e'hi',
em seguida, o chatbot enviará uma mensagem usando `addAnswer` com o texto 'oi, bem-vindo à minha loja incrível, como posso ajudá-lo?'
e 'a Loja oferece: sapatos, camisas, calças e chapéus'.

> **NOTE:**
> A função adicionar palavras-chave também possui várias propriedades que o ajudarão a resolver diferentes casos de uso.
> Algumas destas funções são: [regex](add-functions#regex), [sensitive](add-functions#sensitive)

```ts (app.ts)
  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword(['hello', 'hi'])
      .addAnswer(['Hi, welcome to my amazing shop', 'how can I help you?'])
      .addAnswer(['The shop has: ', 'shoes, shirts, pants, and hats'])
```
```js (app.js)
  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword(['hello', 'hi'])
      .addAnswer(['Hi, welcome to my amazing shop', 'how can I help you?'])
      .addAnswer(['The shop has: ', 'shoes, shirts, pants, and hats'])
```

```mermaid
flowchart TB
   id1(("user")) -- say (hello/hi) -->  id2(("Bot")) -- Hi, welcome to my amazing shop, how can I help you? --> id3(("Bot"))  -- The shop has:, shoes, shirts, pants, and hats  --> id4(("user"))
   style id1 fill:#ffa69e,stroke:#f79256,stroke-width:0px
   style id2 fill:#1dd3b0,stroke:#248277,stroke-width:0px
   style id3 fill:#1dd3b0,stroke:#248277,stroke-width:0px
   style id4 fill:#ffa69e,stroke:#f79256,stroke-width:0px
```

O fluxo de conversação pode ser limitado a uma __keyword__ específica, por exemplo, a palavra 'compra' para acionar a próxima caixa de diálogo

```ts (app.ts)
  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword('buy')
      .addAnswer(['Great! ', 'What do you want to buy?'])
```
```js (app.js)
  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword('purchase')
      .addAnswer(['Great! ', 'What do you want to buy?'])
```

---

## Regex 

  
O chatbot suporta validação de regex, no exemplo a seguir um objeto é passado como o segundo parâmetro para a função addKeyword, o objeto tem uma propriedade regex definida como true e a propriedade keywords é um padrão regex.

  
  

```ts (app.ts)
  import { addKeyword } from '@builderbot/bot';

  const REGEX_GMAIL_EMAIL = /(\w+)@gmail\.com/g;

  const mainFlow = addKeyword(REGEX_GMAIL_EMAIL, 
      { regex: true })
      .addAnswer(`Thanks for the gmail address`)
```
```js (app.js)
  import { addKeyword } from '@builderbot/bot';

  const REGEX_GMAIL_EMAIL = /(\w+)@gmail\.com/g;

  const mainFlow = addKeyword(REGEX_GMAIL_EMAIL, 
      { regex: true })
      .addAnswer(`Thanks for the gmail address`)
```

  

## Sensitive 

  
O chatbot detecta uma palavra-chave específica em qualquer parte de uma mensagem, mas `sensitive` propriedade como `true` o chatbot acionará a caixa de diálogo se o usuário anotar exatamente o mesmo __keyword__.

  
  

```ts (app.ts)
  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword('buy', { sensitive: true })
      .addAnswer(['Great! ', 'What do you want to buy?'])
```
```js (app.js)
  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword('buy', { sensitive: true })
      .addAnswer(['Great! ', 'What do you want to buy?'])
```

  

---

## Add answer

__`addAnswer`__ é usado para enviar uma mensagem ao usuário, pode ser um texto simples ou um arquivo anexado.
No exemplo a seguir é estabelecido um fluxo de conversa que recebeu a palavra-chave 'hello',
em seguida, o chatbot enviará uma mensagem usando `addAnswer` com o texto __' oi, bem-vindo à minha loja incrível, como posso ajudá-lo?'__

```ts (app.ts)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi, welcome to my amazing shop, how can I help you?')
```
```js (app.js)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi, welcome to my amazing shop, how can I help you?')
``` 

> **NOTE:**
> Existem diferentes configurações para o envio de mensagens, algumas funções como envio de arquivos, imagens, vídeo, atrasos, quebras de linha:
> [line breaks](/add-functions#send-consecutive-messages), [consecutive](/add-functions#send-consecutive-messages), [delay](/add-functions#message-with-delay)
> , [callback](/add-functions#message-with-callback)

---

## Consecutive Messages 

  
O chatbot pode enviar várias mensagens apenas adicionando a função addAnswer uma após a outra. No exemplo a seguir, o chatbot enviará (3) mensagens:
`Hi`, `Welcome to my amazing shop`, `how can I help you?` nessa ordem.

  
  

```ts (app.ts)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi')
      .addAnswer('Welcome to my amazing shop')
      .addAnswer('how can I help you?')
```
```js (app.js)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi')
      .addAnswer('Welcome to my amazing shop')
      .addAnswer('how can I help you?')
```

  

## Message with line breaks 

  
Sempre que precisar enviar uma mensagem com quebras de linha, você pode usar uma matriz de string, como pode ver no exemplo a seguir.
  
  

```ts (app.ts)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer([
        'Hi', 'Welcome to my amazing shop', 
        'how can I help you?'
      ])
```
```js (app.js)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer([
        'Hi', 'Welcome to my amazing shop', 
        'how can I help you?'
      ])
``` 

  

## Message with delay 

  
O chatbot pode enviar uma mensagem com um `delay`, basta adicionar a função addAnswer com a propriedade delay definida para a quantidade de milissegundos que deseja aguardar antes de enviar a mensagem.
  
  

```ts (app.ts)
import { addKeyword, addAnswer } from '@builderbot/bot';

const mainFlow = addKeyword('hello')
  .addAnswer('This message will after 2 seconds',
    { delay: 2000 }
  )
```
```js (app.js)
import { addKeyword, addAnswer } from '@builderbot/bot';

const mainFlow = addKeyword('hello')
  .addAnswer('This message will after 2 seconds',
    { delay: 2000 }
  )
``` 

  

---

## Message with callback  

Ao usar funções de retorno de chamada em um addAnswers, a operação prioriza o envio da mensagem e, em seguida, a execução da função.

```ts (app.ts)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi!, Do you know 4+4?', null, async (_, {flowDynamic}) => {
          const sum = 4 + 4
          await flowDynamic(`Total: ${sum}`)
      })
      .addAction(async (_, {flowDynamic}) => {
          await flowDynamic(`Other message`)
      })
```
```js (app.js)
  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi!, Do you know 4+4?', null, async (_, {flowDynamic}) => {
          const sum = 4 + 4
          await flowDynamic(`Total: ${sum}`)
      })
      .addAction(async (_, {flowDynamic}) => {
          await flowDynamic(`Other message`)
      })
``` 

```mermaid
flowchart TB
   id1(("user")) -- say (hello) -->  
   id2(("Bot")) -- Hi!, Do you know 4+4? --> 
   id3(("Bot"))  -- Total: 8 --> 
   id4(("user"))
   
   style id1 fill:#ffa69e,stroke:#f79256,stroke-width:0px
   style id2 fill:#1dd3b0,stroke:#248277,stroke-width:0px
   style id3 fill:#1dd3b0,stroke:#248277,stroke-width:0px
   style id4 fill:#ffa69e,stroke:#f79256,stroke-width:0px
```

---

## Add Action

__`addAction`__ é usado para definir ações específicas como uma resposta quando uma mensagem do whatsapp foi recebida,
esta função permite acionar fluxos de conversação com base na entrada do Usuário e definir como o chatbot deve agir.

No exemplo a seguir, você pode ver como pode acionar uma função quando o usuário envia uma mensagem com a palavra-chave 'buy'.

```ts (app.ts)
  import { addKeyword, addAction } from '@builderbot/bot';

  const mainFlow = addKeyword('buy')
      .addAnswer('Great! What do you want to buy?')
      .addAction(async (_, { flowDynamic }): void => {
          return console.log('The user wants to buy something');
      })
```
```js (app.js)
  import { addKeyword, addAction } from '@builderbot/bot';

  const mainFlow = addKeyword('buy')
      .addAnswer('Great! What do you want to buy?')
      .addAction(async (_, { flowDynamic }) => {
          return console.log('The user wants to buy something');
      })
```

Você pode usar a função `addAction` com `capture` como você pode ver no exemplo abaixo

```ts (app.ts)
  import { addKeyword, addAction } from '@builderbot/bot';

  const mainFlow = addKeyword(['Hello', 'Hi'])
      .addAction(async (_, { flowDynamic }): void => {
          return flowDynamic('Hi! how can I help you?');
      })
      .addAction({ capture: true }, async (ctx, { flowDynamic, state }): void => {
          await state.udpate({ name: ctx.body})
          return console.flowDynamic(`The user said: ${ctx.body}`);
      })
```
```js (app.js)
  import { addKeyword, addAction } from '@builderbot/bot';

  const mainFlow = addKeyword(['Hello', 'Hi'])
      .addAction(async (_, { flowDynamic }) => {
          return flowDynamic('The user wants to buy something');
      })
```

---
