> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Neuron AI

> Faça buscas na web e leia páginas em Markdown com agentes Neuron AI em PHP

<Note>
  **Documentação oficial do Neuron AI:** [docs.neuron-ai.dev/agent/tools](https://docs.neuron-ai.dev/agent/tools)

  Dê aos agentes PHP recursos de busca na web e leitura de páginas com o Firecrawl
</Note>

<h2 id="overview">
  Visão geral
</h2>

[Neuron AI](https://neuron-ai.dev) é um framework agêntico para PHP. Ele já vem com um toolkit do Firecrawl, permitindo que um agente Neuron faça uma busca na web e leia qualquer página como Markdown limpo durante uma execução.

<h2 id="quick-start">
  Início rápido
</h2>

1. Instale o Neuron AI 4.1.3 ou superior:

```bash theme={null}
composer require neuron-core/neuron-ai:^4.1.3
```

2. Obtenha uma API key no seu [painel do Firecrawl](https://www.firecrawl.dev/app/api-keys) e configure-a como `FIRECRAWL_API_KEY`
3. Adicione o toolkit ao seu agente:

```php theme={null}
namespace App\Neuron;

use NeuronAI\Agent\Agent;
use NeuronAI\Tools\Toolkits\Firecrawl\FirecrawlToolkit;

class ResearchAgent extends Agent
{
    ...

    protected function tools(): array
    {
        return [
            FirecrawlToolkit::make(
                key: getenv('FIRECRAWL_API_KEY')
            ),
        ];
    }
}
```

<h2 id="tools">
  Ferramentas
</h2>

| Ferramenta | Nome visto pelo agente | O que faz |
| - | - | - |
| `FirecrawlSearchTool` | `web_search` | Faz buscas na web, ou em notícias quando o agente solicitar, com um intervalo de tempo opcional |
| `FirecrawlScrapeTool` | `url_reader` | Retorna o conteúdo principal de uma página em Markdown |

Você também pode adicionar cada ferramenta separadamente, por exemplo: `FirecrawlSearchTool::make(key: getenv('FIRECRAWL_API_KEY'))`.

<h2 id="get-page-content-with-each-search-result">
  Obtenha o conteúdo da página com cada resultado de busca
</h2>

Por padrão, uma busca retorna o título, a URL e a descrição de cada resultado. Ao passar `scrapeOptions`, cada resultado também inclui a página completa em Markdown, assim o agente não precisa fazer uma segunda chamada para lê-la:

```php theme={null}
use NeuronAI\Tools\Toolkits\Firecrawl\FirecrawlSearchTool;

FirecrawlSearchTool::make(key: getenv('FIRECRAWL_API_KEY'))->withOptions([
    'limit' => 5,
    'scrapeOptions' => [
        'formats' => ['markdown'],
        'onlyMainContent' => true,
    ],
]);
```

`withOptions()` substitui os valores padrão e aceita qualquer [parâmetro de busca](/pt-BR/api-reference/endpoint/search). O termo de busca é sempre fornecido pelo agente.

<h2 id="resources">
  Recursos
</h2>

* [Ferramentas e toolkits do Neuron AI](https://docs.neuron-ai.dev/agent/tools)
* [Documentação de busca do Firecrawl](/pt-BR/features/search)
* [Documentação de scraping do Firecrawl](/pt-BR/features/scrape)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.